GetApiManagementServiceResult

data class GetApiManagementServiceResult(val additionalLocations: List<AdditionalLocationResponse>? = null, val apiVersionConstraint: ApiVersionConstraintResponse? = null, val certificates: List<CertificateConfigurationResponse>? = null, val createdAtUtc: String, val customProperties: Map<String, String>? = null, val developerPortalUrl: String, val disableGateway: Boolean? = null, val enableClientCertificate: Boolean? = null, val etag: String, val gatewayRegionalUrl: String, val gatewayUrl: String, val hostnameConfigurations: List<HostnameConfigurationResponse>? = null, val id: String, val identity: ApiManagementServiceIdentityResponse? = null, val location: String, val managementApiUrl: String, val name: String, val notificationSenderEmail: String? = null, val portalUrl: String, val privateIPAddresses: List<String>, val provisioningState: String, val publicIPAddresses: List<String>, val publisherEmail: String, val publisherName: String, val restore: Boolean? = null, val scmUrl: String, val sku: ApiManagementServiceSkuPropertiesResponse, val tags: Map<String, String>? = null, val targetProvisioningState: String, val type: String, val virtualNetworkConfiguration: VirtualNetworkConfigurationResponse? = null, val virtualNetworkType: String? = null, val zones: List<String>? = null)

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

Constructors

Link copied to clipboard
constructor(additionalLocations: List<AdditionalLocationResponse>? = null, apiVersionConstraint: ApiVersionConstraintResponse? = null, certificates: List<CertificateConfigurationResponse>? = null, createdAtUtc: String, customProperties: Map<String, String>? = null, developerPortalUrl: String, disableGateway: Boolean? = null, enableClientCertificate: Boolean? = null, etag: String, gatewayRegionalUrl: String, gatewayUrl: String, hostnameConfigurations: List<HostnameConfigurationResponse>? = null, id: String, identity: ApiManagementServiceIdentityResponse? = null, location: String, managementApiUrl: String, name: String, notificationSenderEmail: String? = null, portalUrl: String, privateIPAddresses: List<String>, provisioningState: String, publicIPAddresses: List<String>, publisherEmail: String, publisherName: String, restore: Boolean? = null, scmUrl: String, sku: ApiManagementServiceSkuPropertiesResponse, tags: Map<String, String>? = null, targetProvisioningState: String, type: String, virtualNetworkConfiguration: VirtualNetworkConfigurationResponse? = null, virtualNetworkType: String? = null, zones: List<String>? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Additional datacenter locations of the API Management service.

Link copied to clipboard

Control Plane Apis version constraint for the API Management service.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

Custom properties of the API Management service.
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).
Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 can be used to disable just TLS 1.1.
Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 can be used to disable TLS 1.0 on an API Management service.
Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 can be used to disable just TLS 1.1 for communications with backends.
Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 can be used to disable TLS 1.0 for communications with backends.
Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 can be used to enable HTTP2 protocol on an API Management service.
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.

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. Note: next ciphers can't be disabled since they are required by Azure CloudService internal components: TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_256_GCM_SHA384

Link copied to clipboard

DEveloper Portal endpoint URL of the API Management service.

Link copied to clipboard
val disableGateway: Boolean? = null

Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region.

Link copied to clipboard

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.

Link copied to clipboard

ETag of the resource.

Link copied to clipboard

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

Link copied to clipboard

Gateway URL of the API Management service.

Link copied to clipboard

Custom hostname configuration of the API Management service.

Link copied to clipboard
val id: String

Resource ID.

Link copied to clipboard

Managed service identity of the Api Management service.

Link copied to clipboard

Resource location.

Link copied to clipboard

Management API endpoint URL of the API Management service.

Link copied to clipboard

Resource name.

Link copied to clipboard

Email address from which the notification will be sent.

Link copied to clipboard

Publisher portal endpoint Url of the API Management service.

Link copied to clipboard

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, Premium and Isolated SKU.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Publisher email.

Link copied to clipboard

Publisher name.

Link copied to clipboard
val restore: Boolean? = null

Undelete Api Management Service if it was previously soft-deleted. If this flag is specified and set to True all other properties will be ignored.

Link copied to clipboard

SCM endpoint URL of the API Management service.

Link copied to clipboard

SKU properties of the API Management service.

Link copied to clipboard
val tags: Map<String, String>? = null

Resource tags.

Link copied to clipboard

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

Link copied to clipboard

Resource type for API Management resource is set to Microsoft.ApiManagement.

Link copied to clipboard

Virtual network configuration of the API Management service.

Link copied to clipboard

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.

Link copied to clipboard
val zones: List<String>? = null

A list of availability zones denoting where the resource needs to come from.