ApiManagementServiceResource interface
A single API Management service resource in List or Get response.
- Extends
Properties
additional |
Additional datacenter locations of the API Management service. |
api |
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. |
created |
Creation UTC date of the API Management service.The date conforms to the following format: |
custom |
Custom properties of the API Management service. |
developer |
DEveloper Portal endpoint URL of the API Management service. NOTE: This property will not be serialized. It can only be populated by the server. |
disable |
Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region. |
enable |
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. |
etag | ETag of the resource. NOTE: This property will not be serialized. It can only be populated by the server. |
gateway |
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. |
gateway |
Gateway URL of the API Management service. NOTE: This property will not be serialized. It can only be populated by the server. |
hostname |
Custom hostname configuration of the API Management service. |
identity | Managed service identity of the Api Management service. |
location | Resource location. |
management |
Management API endpoint URL of the API Management service. NOTE: This property will not be serialized. It can only be populated by the server. |
nat |
Property can be used to enable NAT Gateway for this API Management service. |
notification |
Email address from which the notification will be sent. |
outbound |
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. |
platform |
Compute Platform Version running the service in this location. NOTE: This property will not be serialized. It can only be populated by the server. |
portal |
Publisher portal endpoint Url of the API Management service. NOTE: This property will not be serialized. It can only be populated by the server. |
private |
List of Private Endpoint Connections of this service. |
private |
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. |
provisioning |
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. |
public |
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. |
public |
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. |
public |
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' |
publisher |
Publisher email. |
publisher |
Publisher name. |
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. |
scm |
SCM endpoint URL of the API Management service. NOTE: This property will not be serialized. It can only be populated by the server. |
sku | SKU properties of the API Management service. |
system |
Metadata pertaining to creation and last modification of the resource. NOTE: This property will not be serialized. It can only be populated by the server. |
target |
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. |
virtual |
Virtual network configuration of the API Management service. |
virtual |
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. |
zones | A list of availability zones denoting where the resource needs to come from. |
Inherited Properties
id | Resource ID. NOTE: This property will not be serialized. It can only be populated by the server. |
name | Resource name. NOTE: This property will not be serialized. It can only be populated by the server. |
tags | Resource tags. |
type | Resource type for API Management resource is set to Microsoft.ApiManagement. NOTE: This property will not be serialized. It can only be populated by the server. |
Property Details
additionalLocations
Additional datacenter locations of the API Management service.
additionalLocations?: AdditionalLocation[]
Property Value
apiVersionConstraint
Control Plane Apis version constraint for the API Management service.
apiVersionConstraint?: ApiVersionConstraint
Property Value
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
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
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}
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
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
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
etag
ETag of the resource. NOTE: This property will not be serialized. It can only be populated by the server.
etag?: string
Property Value
string
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
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
hostnameConfigurations
Custom hostname configuration of the API Management service.
hostnameConfigurations?: HostnameConfiguration[]
Property Value
identity
Managed service identity of the Api Management service.
identity?: ApiManagementServiceIdentity
Property Value
location
Resource location.
location: string
Property Value
string
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
natGatewayState
Property can be used to enable NAT Gateway for this API Management service.
natGatewayState?: string
Property Value
string
notificationSenderEmail
Email address from which the notification will be sent.
notificationSenderEmail?: string
Property Value
string
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[]
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
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
privateEndpointConnections
List of Private Endpoint Connections of this service.
privateEndpointConnections?: RemotePrivateEndpointConnectionWrapper[]
Property Value
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[]
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
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[]
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
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
publisherEmail
Publisher email.
publisherEmail: string
Property Value
string
publisherName
Publisher name.
publisherName: string
Property Value
string
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
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
sku
SKU properties of the API Management service.
sku: ApiManagementServiceSkuProperties
Property Value
systemData
Metadata pertaining to creation and last modification of the resource. NOTE: This property will not be serialized. It can only be populated by the server.
systemData?: SystemData
Property Value
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
virtualNetworkConfiguration
Virtual network configuration of the API Management service.
virtualNetworkConfiguration?: VirtualNetworkConfiguration
Property Value
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
zones
A list of availability zones denoting where the resource needs to come from.
zones?: string[]
Property Value
string[]
Inherited Property Details
id
Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.
id?: string
Property Value
string
Inherited From ApimResource.id
name
Resource name. NOTE: This property will not be serialized. It can only be populated by the server.
name?: string
Property Value
string
Inherited From ApimResource.name
tags
Resource tags.
tags?: {[propertyName: string]: string}
Property Value
{[propertyName: string]: string}
Inherited From ApimResource.tags
type
Resource type for API Management resource is set to Microsoft.ApiManagement. NOTE: This property will not be serialized. It can only be populated by the server.
type?: string
Property Value
string
Inherited From ApimResource.type