Class ApiManagementServiceResource

A single API Management service resource in List or Get response.

Inheritance
Object
ApimResource
ApiManagementServiceResource
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Assembly: Microsoft.Azure.Management.ApiManagement.dll
Syntax
[Microsoft.Rest.Serialization.JsonTransformation]
public class ApiManagementServiceResource : Microsoft.Azure.Management.ApiManagement.Models.ApimResource

Constructors

ApiManagementServiceResource()

Initializes a new instance of the ApiManagementServiceResource class.

Declaration
public ApiManagementServiceResource ();

ApiManagementServiceResource(String, String, ApiManagementServiceSkuProperties, String, String, String, String, IDictionary<String,String>, String, String, String, Nullable<DateTime>, String, String, String, String, String, IList<HostnameConfiguration>, IList<String>, IList<String>, VirtualNetworkConfiguration, IList<AdditionalLocation>, IDictionary<String,String>, IList<CertificateConfiguration>, Nullable<Boolean>, String, ApiManagementServiceIdentity, String)

Initializes a new instance of the ApiManagementServiceResource class.

Declaration
public ApiManagementServiceResource (string publisherEmail, string publisherName, Microsoft.Azure.Management.ApiManagement.Models.ApiManagementServiceSkuProperties sku, string location, string id = null, string name = null, string type = null, System.Collections.Generic.IDictionary<string,string> tags = null, string notificationSenderEmail = null, string provisioningState = null, string targetProvisioningState = null, Nullable<DateTime> createdAtUtc = null, string gatewayUrl = null, string gatewayRegionalUrl = null, string portalUrl = null, string managementApiUrl = null, string scmUrl = null, System.Collections.Generic.IList<Microsoft.Azure.Management.ApiManagement.Models.HostnameConfiguration> hostnameConfigurations = null, System.Collections.Generic.IList<string> publicIPAddresses = null, System.Collections.Generic.IList<string> privateIPAddresses = null, Microsoft.Azure.Management.ApiManagement.Models.VirtualNetworkConfiguration virtualNetworkConfiguration = null, System.Collections.Generic.IList<Microsoft.Azure.Management.ApiManagement.Models.AdditionalLocation> additionalLocations = null, System.Collections.Generic.IDictionary<string,string> customProperties = null, System.Collections.Generic.IList<Microsoft.Azure.Management.ApiManagement.Models.CertificateConfiguration> certificates = null, Nullable<bool> enableClientCertificate = null, string virtualNetworkType = null, Microsoft.Azure.Management.ApiManagement.Models.ApiManagementServiceIdentity identity = null, string etag = null);
Parameters
String publisherEmail

Publisher email.
String publisherName

Publisher name.
ApiManagementServiceSkuProperties sku

SKU properties of the API Management service.
String location

Resource location.
String id

Resource ID.
String name

Resource name.
String type

Resource type for API Management resource is set to Microsoft.ApiManagement.
IDictionary<String,String> tags

Resource tags.
String notificationSenderEmail

Email address from which the notification will be sent.
String provisioningState

The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
String targetProvisioningState

The provisioning state of the API Management service, which is targeted by the long running operation started on the service.
Nullable<DateTime> createdAtUtc

Creation UTC date of the API Management service.The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
String gatewayUrl

Gateway URL of the API Management service.
String gatewayRegionalUrl

Gateway URL of the API Management service in the Default Region.
String portalUrl

Publisher portal endpoint Url of the API Management service.
String managementApiUrl

Management API endpoint URL of the API Management service.
String scmUrl

SCM endpoint URL of the API Management service.
IList<HostnameConfiguration> hostnameConfigurations

Custom hostname configuration of the API Management service.
IList<String> publicIPAddresses

Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard and Premium SKU.
IList<String> privateIPAddresses

Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard and Premium SKU.
VirtualNetworkConfiguration virtualNetworkConfiguration

Virtual network configuration of the API Management service.
IList<AdditionalLocation> additionalLocations

Additional datacenter locations of the API Management service.
IDictionary<String,String> customProperties

Custom properties of the API Management service.</br>Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2).</br>Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 can be used to disable just TLS 1.1.</br>Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 can be used to disable TLS 1.0 on an API Management service.</br>Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 can be used to disable just TLS 1.1 for communications with backends.</br>Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 can be used to disable TLS 1.0 for communications with backends.</br>Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 can be used to enable HTTP2 protocol on an API Management service.</br>Not specifying any of these properties on PATCH operation will reset omitted properties' values to their defaults. For all the settings except Http2 the default value is True if the service was created on or before April 1st 2018 and False otherwise. Http2 setting's default value is False.</br></br>You can disable any of next ciphers by using settings Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. For example, Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. The default value is true for them.
IList<CertificateConfiguration> certificates

List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.
Nullable<Boolean> enableClientCertificate

Property only meant to be used for Consumption SKU Service. This enforces a client certificate to be presented on each request to the gateway. This also enables the ability to authenticate the certificate in the policy on the gateway.
String virtualNetworkType

The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only. Possible values include: 'None', 'External', 'Internal'
ApiManagementServiceIdentity identity

Managed service identity of the Api Management service.
String etag

ETag of the resource.

Properties

AdditionalLocations

Gets or sets additional datacenter locations of the API Management service.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.additionalLocations")]
public System.Collections.Generic.IList<Microsoft.Azure.Management.ApiManagement.Models.AdditionalLocation> AdditionalLocations { get; set; }
Property Value
IList<AdditionalLocation>

Certificates

Gets or sets list of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.certificates")]
public System.Collections.Generic.IList<Microsoft.Azure.Management.ApiManagement.Models.CertificateConfiguration> Certificates { get; set; }
Property Value
IList<CertificateConfiguration>

CreatedAtUtc

Gets creation UTC date of the API Management service.The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.createdAtUtc")]
public Nullable<DateTime> CreatedAtUtc { get; }
Property Value
Nullable<DateTime>

CustomProperties

Gets or sets custom properties of the API Management service.&lt;/br&gt;Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2).&lt;/br&gt;Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 can be used to disable just TLS 1.1.&lt;/br&gt;Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 can be used to disable TLS 1.0 on an API Management service.&lt;/br&gt;Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 can be used to disable just TLS 1.1 for communications with backends.&lt;/br&gt;Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 can be used to disable TLS 1.0 for communications with backends.&lt;/br&gt;Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 can be used to enable HTTP2 protocol on an API Management service.&lt;/br&gt;Not specifying any of these properties on PATCH operation will reset omitted properties' values to their defaults. For all the settings except Http2 the default value is True if the service was created on or before April 1st 2018 and False otherwise. Http2 setting's default value is False.&lt;/br&gt;&lt;/br&gt;You can disable any of next ciphers by using settings Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. For example, Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. The default value is true for them.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.customProperties")]
public System.Collections.Generic.IDictionary<string,string> CustomProperties { get; set; }
Property Value
IDictionary<String,String>

EnableClientCertificate

Gets or sets property only meant to be used for Consumption SKU Service. This enforces a client certificate to be presented on each request to the gateway. This also enables the ability to authenticate the certificate in the policy on the gateway.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.enableClientCertificate")]
public Nullable<bool> EnableClientCertificate { get; set; }
Property Value
Nullable<Boolean>

Etag

Gets eTag of the resource.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="etag")]
public string Etag { get; }
Property Value
String

GatewayRegionalUrl

Gets gateway URL of the API Management service in the Default Region.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.gatewayRegionalUrl")]
public string GatewayRegionalUrl { get; }
Property Value
String

GatewayUrl

Gets gateway URL of the API Management service.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.gatewayUrl")]
public string GatewayUrl { get; }
Property Value
String

HostnameConfigurations

Gets or sets custom hostname configuration of the API Management service.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.hostnameConfigurations")]
public System.Collections.Generic.IList<Microsoft.Azure.Management.ApiManagement.Models.HostnameConfiguration> HostnameConfigurations { get; set; }
Property Value
IList<HostnameConfiguration>

Identity

Gets or sets managed service identity of the Api Management service.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="identity")]
public Microsoft.Azure.Management.ApiManagement.Models.ApiManagementServiceIdentity Identity { get; set; }
Property Value
ApiManagementServiceIdentity

Location

Gets or sets resource location.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="location")]
public string Location { get; set; }
Property Value
String

ManagementApiUrl

Gets management API endpoint URL of the API Management service.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.managementApiUrl")]
public string ManagementApiUrl { get; }
Property Value
String

NotificationSenderEmail

Gets or sets email address from which the notification will be sent.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.notificationSenderEmail")]
public string NotificationSenderEmail { get; set; }
Property Value
String

PortalUrl

Gets publisher portal endpoint Url of the API Management service.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.portalUrl")]
public string PortalUrl { get; }
Property Value
String

PrivateIPAddresses

Gets private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard and Premium SKU.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.privateIPAddresses")]
public System.Collections.Generic.IList<string> PrivateIPAddresses { get; }
Property Value
IList<String>

ProvisioningState

Gets the current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.provisioningState")]
public string ProvisioningState { get; }
Property Value
String

PublicIPAddresses

Gets public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard and Premium SKU.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.publicIPAddresses")]
public System.Collections.Generic.IList<string> PublicIPAddresses { get; }
Property Value
IList<String>

PublisherEmail

Gets or sets publisher email.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.publisherEmail")]
public string PublisherEmail { get; set; }
Property Value
String

PublisherName

Gets or sets publisher name.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.publisherName")]
public string PublisherName { get; set; }
Property Value
String

ScmUrl

Gets SCM endpoint URL of the API Management service.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.scmUrl")]
public string ScmUrl { get; }
Property Value
String

Sku

Gets or sets SKU properties of the API Management service.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="sku")]
public Microsoft.Azure.Management.ApiManagement.Models.ApiManagementServiceSkuProperties Sku { get; set; }
Property Value
ApiManagementServiceSkuProperties

TargetProvisioningState

Gets the provisioning state of the API Management service, which is targeted by the long running operation started on the service.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.targetProvisioningState")]
public string TargetProvisioningState { get; }
Property Value
String

VirtualNetworkConfiguration

Gets or sets virtual network configuration of the API Management service.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.virtualNetworkConfiguration")]
public Microsoft.Azure.Management.ApiManagement.Models.VirtualNetworkConfiguration VirtualNetworkConfiguration { get; set; }
Property Value
VirtualNetworkConfiguration

VirtualNetworkType

Gets or sets the type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only. Possible values include: 'None', 'External', 'Internal'

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.virtualNetworkType")]
public string VirtualNetworkType { get; set; }
Property Value
String

Methods

Validate()

Validate the object.

Declaration
public virtual void Validate ();
Exceptions
ValidationException

Thrown if validation fails