Share via

ApiManagementServiceProperties interface

  • Reference
Package:
@azure/arm-apimanagement

Properties of an API Management service resource description.

Extends
ApiManagementServiceBaseProperties

Properties

publisherEmail

Publisher email.
publisherName

Publisher name.

Inherited Properties

additionalLocations

Additional datacenter locations of the API Management service.
apiVersionConstraint

Control Plane Apis version constraint for the API Management service.
certificates

List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.
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. NOTE: This property will not be serialized. It can only be populated by the server.
customProperties

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 1, 2018 and False otherwise. Http2 setting's default value is False.

You can disable any of the following 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: The following ciphers can't be disabled since they are required by internal platform components: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,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
developerPortalUrl

DEveloper Portal endpoint URL of the API Management service. NOTE: This property will not be serialized. It can only be populated by the server.
disableGateway

Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region.
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.
gatewayRegionalUrl

Gateway URL of the API Management service in the Default Region. NOTE: This property will not be serialized. It can only be populated by the server.
gatewayUrl

Gateway URL of the API Management service. NOTE: This property will not be serialized. It can only be populated by the server.
hostnameConfigurations

Custom hostname configuration of the API Management service.
managementApiUrl

Management API endpoint URL of the API Management service. NOTE: This property will not be serialized. It can only be populated by the server.
natGatewayState

Property can be used to enable NAT Gateway for this API Management service.
notificationSenderEmail

Email address from which the notification will be sent.
outboundPublicIPAddresses

Outbound public IPV4 address prefixes associated with NAT Gateway deployed service. Available only for Premium SKU on stv2 platform. NOTE: This property will not be serialized. It can only be populated by the server.
platformVersion

Compute Platform Version running the service in this location. NOTE: This property will not be serialized. It can only be populated by the server.
portalUrl

Publisher portal endpoint Url of the API Management service. NOTE: This property will not be serialized. It can only be populated by the server.
privateEndpointConnections

List of Private Endpoint Connections of this service.
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, Premium and Isolated SKU. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
publicIPAddresses

Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard, Premium and Isolated SKU. NOTE: This property will not be serialized. It can only be populated by the server.
publicIpAddressId

Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the region. Supported only for Developer and Premium SKU being deployed in Virtual Network.
publicNetworkAccess

Whether or not public endpoint access is allowed for this API Management service. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled'
restore

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.
scmUrl

SCM endpoint URL of the API Management service. NOTE: This property will not be serialized. It can only be populated by the server.
targetProvisioningState

The provisioning state of the API Management service, which is targeted by the long running operation started on the service. NOTE: This property will not be serialized. It can only be populated by the server.
virtualNetworkConfiguration

Virtual network configuration of the API Management service.
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.

Property Details

publisherEmail

Publisher email.

publisherEmail: string

Property Value

string

publisherName

Publisher name.

publisherName: string

Property Value

string

Inherited Property Details

additionalLocations

Additional datacenter locations of the API Management service.

additionalLocations?: AdditionalLocation[]

Property Value

AdditionalLocation[]

Inherited From ApiManagementServiceBaseProperties.additionalLocations

apiVersionConstraint

Control Plane Apis version constraint for the API Management service.

apiVersionConstraint?: ApiVersionConstraint

Property Value

ApiVersionConstraint

Inherited From ApiManagementServiceBaseProperties.apiVersionConstraint

certificates

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

certificates?: CertificateConfiguration[]

Property Value

CertificateConfiguration[]

Inherited From ApiManagementServiceBaseProperties.certificates

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. NOTE: This property will not be serialized. It can only be populated by the server.

createdAtUtc?: Date

Property Value

Date

Inherited From ApiManagementServiceBaseProperties.createdAtUtc

customProperties

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 1, 2018 and False otherwise. Http2 setting's default value is False.

You can disable any of the following 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: The following ciphers can't be disabled since they are required by internal platform components: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,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

customProperties?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From ApiManagementServiceBaseProperties.customProperties

developerPortalUrl

DEveloper Portal endpoint URL of the API Management service. NOTE: This property will not be serialized. It can only be populated by the server.

developerPortalUrl?: string

Property Value

string

Inherited From ApiManagementServiceBaseProperties.developerPortalUrl

disableGateway

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

disableGateway?: boolean

Property Value

boolean

Inherited From ApiManagementServiceBaseProperties.disableGateway

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.

enableClientCertificate?: boolean

Property Value

boolean

Inherited From ApiManagementServiceBaseProperties.enableClientCertificate

gatewayRegionalUrl

Gateway URL of the API Management service in the Default Region. NOTE: This property will not be serialized. It can only be populated by the server.

gatewayRegionalUrl?: string

Property Value

string

Inherited From ApiManagementServiceBaseProperties.gatewayRegionalUrl

gatewayUrl

Gateway URL of the API Management service. NOTE: This property will not be serialized. It can only be populated by the server.

gatewayUrl?: string

Property Value

string

Inherited From ApiManagementServiceBaseProperties.gatewayUrl

hostnameConfigurations

Custom hostname configuration of the API Management service.

hostnameConfigurations?: HostnameConfiguration[]

Property Value

HostnameConfiguration[]

Inherited From ApiManagementServiceBaseProperties.hostnameConfigurations

managementApiUrl

Management API endpoint URL of the API Management service. NOTE: This property will not be serialized. It can only be populated by the server.

managementApiUrl?: string

Property Value

string

Inherited From ApiManagementServiceBaseProperties.managementApiUrl

natGatewayState

Property can be used to enable NAT Gateway for this API Management service.

natGatewayState?: string

Property Value

string

Inherited From ApiManagementServiceBaseProperties.natGatewayState

notificationSenderEmail

Email address from which the notification will be sent.

notificationSenderEmail?: string

Property Value

string

Inherited From ApiManagementServiceBaseProperties.notificationSenderEmail

outboundPublicIPAddresses

Outbound public IPV4 address prefixes associated with NAT Gateway deployed service. Available only for Premium SKU on stv2 platform. NOTE: This property will not be serialized. It can only be populated by the server.

outboundPublicIPAddresses?: string[]

Property Value

string[]

Inherited From ApiManagementServiceBaseProperties.outboundPublicIPAddresses

platformVersion

Compute Platform Version running the service in this location. NOTE: This property will not be serialized. It can only be populated by the server.

platformVersion?: string

Property Value

string

Inherited From ApiManagementServiceBaseProperties.platformVersion

portalUrl

Publisher portal endpoint Url of the API Management service. NOTE: This property will not be serialized. It can only be populated by the server.

portalUrl?: string

Property Value

string

Inherited From ApiManagementServiceBaseProperties.portalUrl

privateEndpointConnections

List of Private Endpoint Connections of this service.

privateEndpointConnections?: RemotePrivateEndpointConnectionWrapper[]

Property Value

RemotePrivateEndpointConnectionWrapper[]

Inherited From ApiManagementServiceBaseProperties.privateEndpointConnections

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, Premium and Isolated SKU. NOTE: This property will not be serialized. It can only be populated by the server.

privateIPAddresses?: string[]

Property Value

string[]

Inherited From ApiManagementServiceBaseProperties.privateIPAddresses

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. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

Inherited From ApiManagementServiceBaseProperties.provisioningState

publicIPAddresses

Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard, Premium and Isolated SKU. NOTE: This property will not be serialized. It can only be populated by the server.

publicIPAddresses?: string[]

Property Value

string[]

Inherited From ApiManagementServiceBaseProperties.publicIPAddresses

publicIpAddressId

Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the region. Supported only for Developer and Premium SKU being deployed in Virtual Network.

publicIpAddressId?: string

Property Value

string

Inherited From ApiManagementServiceBaseProperties.publicIpAddressId

publicNetworkAccess

Whether or not public endpoint access is allowed for this API Management service. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled'

publicNetworkAccess?: string

Property Value

string

Inherited From ApiManagementServiceBaseProperties.publicNetworkAccess

restore

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.

restore?: boolean

Property Value

boolean

Inherited From ApiManagementServiceBaseProperties.restore

scmUrl

SCM endpoint URL of the API Management service. NOTE: This property will not be serialized. It can only be populated by the server.

scmUrl?: string

Property Value

string

Inherited From ApiManagementServiceBaseProperties.scmUrl

targetProvisioningState

The provisioning state of the API Management service, which is targeted by the long running operation started on the service. NOTE: This property will not be serialized. It can only be populated by the server.

targetProvisioningState?: string

Property Value

string

Inherited From ApiManagementServiceBaseProperties.targetProvisioningState

virtualNetworkConfiguration

Virtual network configuration of the API Management service.

virtualNetworkConfiguration?: VirtualNetworkConfiguration

Property Value

VirtualNetworkConfiguration

Inherited From ApiManagementServiceBaseProperties.virtualNetworkConfiguration

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.

virtualNetworkType?: string

Property Value

string

Inherited From ApiManagementServiceBaseProperties.virtualNetworkType