Microsoft.ApiManagement service

Template format

To create a Microsoft.ApiManagement/service resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.ApiManagement/service",
  "apiVersion": "2020-06-01-preview",
  "tags": {},
  "properties": {
    "notificationSenderEmail": "string",
    "hostnameConfigurations": [
      {
        "type": "string",
        "hostName": "string",
        "keyVaultId": "string",
        "identityClientId": "string",
        "encodedCertificate": "string",
        "certificatePassword": "string",
        "defaultSslBinding": "boolean",
        "negotiateClientCertificate": "boolean",
        "certificate": {
          "expiry": "string",
          "thumbprint": "string",
          "subject": "string"
        }
      }
    ],
    "virtualNetworkConfiguration": {
      "subnetResourceId": "string"
    },
    "additionalLocations": [
      {
        "location": "string",
        "sku": {
          "name": "string",
          "capacity": "integer"
        },
        "zones": [
          "string"
        ],
        "virtualNetworkConfiguration": {
          "subnetResourceId": "string"
        },
        "disableGateway": "boolean"
      }
    ],
    "customProperties": {},
    "certificates": [
      {
        "encodedCertificate": "string",
        "certificatePassword": "string",
        "storeName": "string",
        "certificate": {
          "expiry": "string",
          "thumbprint": "string",
          "subject": "string"
        }
      }
    ],
    "enableClientCertificate": "boolean",
    "disableGateway": "boolean",
    "virtualNetworkType": "string",
    "apiVersionConstraint": {
      "minApiVersion": "string"
    },
    "restore": "boolean",
    "publisherEmail": "string",
    "publisherName": "string"
  },
  "sku": {
    "name": "string",
    "capacity": "integer"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {}
  },
  "location": "string",
  "zones": [
    "string"
  ]
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.ApiManagement/service object

Name Type Required Value
name string Yes The name of the API Management service.
type enum Yes Microsoft.ApiManagement/service
apiVersion enum Yes 2020-06-01-preview
tags object No Resource tags.
properties object Yes Properties of the API Management service. - ApiManagementServiceProperties object
sku object Yes SKU properties of the API Management service. - ApiManagementServiceSkuProperties object
identity object No Managed service identity of the Api Management service. - ApiManagementServiceIdentity object
location string Yes Resource location.
zones array No A list of availability zones denoting where the resource needs to come from. - string

ApiManagementServiceProperties object

Name Type Required Value
notificationSenderEmail string No Email address from which the notification will be sent.
hostnameConfigurations array No Custom hostname configuration of the API Management service. - HostnameConfiguration object
virtualNetworkConfiguration object No Virtual network configuration of the API Management service. - VirtualNetworkConfiguration object
additionalLocations array No Additional datacenter locations of the API Management service. - AdditionalLocation object
customProperties object No 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
certificates array No List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10. - CertificateConfiguration object
enableClientCertificate boolean No 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.
disableGateway boolean No Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region.
virtualNetworkType enum No 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. - None, External, Internal
apiVersionConstraint object No Control Plane Apis version constraint for the API Management service. - ApiVersionConstraint object
restore boolean No 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.
publisherEmail string Yes Publisher email.
publisherName string Yes Publisher name.

ApiManagementServiceSkuProperties object

Name Type Required Value
name enum Yes Name of the Sku. - Developer, Standard, Premium, Basic, Consumption, Isolated
capacity integer Yes Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0.

ApiManagementServiceIdentity object

Name Type Required Value
type enum Yes The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service. - SystemAssigned, UserAssigned, SystemAssigned, UserAssigned, None
userAssignedIdentities object No The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

HostnameConfiguration object

Name Type Required Value
type enum Yes Hostname type. - Proxy, Portal, Management, Scm, DeveloperPortal
hostName string Yes Hostname to configure on the Api Management service.
keyVaultId string No Url to the KeyVault Secret containing the Ssl Certificate. If absolute Url containing version is provided, auto-update of ssl certificate will not work. This requires Api Management service to be configured with MSI. The secret should be of type application/x-pkcs12
identityClientId string No System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.
encodedCertificate string No Base64 Encoded certificate.
certificatePassword string No Certificate Password.
defaultSslBinding boolean No Specify true to setup the certificate associated with this Hostname as the Default SSL Certificate. If a client does not send the SNI header, then this will be the certificate that will be challenged. The property is useful if a service has multiple custom hostname enabled and it needs to decide on the default ssl certificate. The setting only applied to Proxy Hostname Type.
negotiateClientCertificate boolean No Specify true to always negotiate client certificate on the hostname. Default Value is false.
certificate object No Certificate information. - CertificateInformation object

VirtualNetworkConfiguration object

Name Type Required Value
subnetResourceId string No The full resource ID of a subnet in a virtual network to deploy the API Management service in.

AdditionalLocation object

Name Type Required Value
location string Yes The location name of the additional region among Azure Data center regions.
sku object Yes SKU properties of the API Management service. - ApiManagementServiceSkuProperties object
zones array No A list of availability zones denoting where the resource needs to come from. - string
virtualNetworkConfiguration object No Virtual network configuration for the location. - VirtualNetworkConfiguration object
disableGateway boolean No Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in this additional location.

CertificateConfiguration object

Name Type Required Value
encodedCertificate string No Base64 Encoded certificate.
certificatePassword string No Certificate Password.
storeName enum Yes The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations. - CertificateAuthority or Root
certificate object No Certificate information. - CertificateInformation object

ApiVersionConstraint object

Name Type Required Value
minApiVersion string No Limit control plane API calls to API Management service with version equal to or newer than this value.

CertificateInformation object

Name Type Required Value
expiry string Yes Expiration date of the certificate. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
thumbprint string Yes Thumbprint of the certificate.
subject string Yes Subject of the certificate.

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create an API Management instance having MSI Identity

Deploy to Azure
This template creates a developer instance of Azure API Management having an MSI Identity
Create an API Management instance using a template

Deploy to Azure
This template creates a developer instance of Azure API Management
Create an API Management instance and all sub resources using template

Deploy to Azure
This template demonstrates how to create a API Management service and configure sub-entities
Create an API Management service in External Virtual Network

Deploy to Azure
This template demonstrates how to create a instance of Azure API Management within your virtual network's subnet in External mode and configure NSG on the subnet as per recommendation.
Create an API Management instance in Premium tier with custom hostnames for proxy and portal

Deploy to Azure
This template demonstrates how to create a instance of Azure API Management with custom hostname for portal and multiple custom hostnames for proxy
Create an API Management service in Internal Virtual network

Deploy to Azure
This template demonstrates how to create a instance of Azure API Management within your virtual network's subnet in Internal Virtual Network mode and configure NSG on the subnet as per recommendation.
Create a multi-region Premium tier API Management service

Deploy to Azure
This template demonstrates how to create API Management service with additional locations. The primary location is the same as location of the resource group. For Additional locations, the template shows NorthCentralUs and East US2. The primary location should be different from additional locations
Create API Management with custom proxy ssl using KeyVault.

Deploy to Azure
This template demonstrates how to Create a instance of Azure API Management and configure custom hostname for proxy with ssl certificate from keyvault.
Create and monitor API Management instance with Operations Management Suite (OMS) - Log Analytics

Deploy to Azure
This template creates an instance of Azure API Management service and OMS workspace and sets up monitoring for your API Management service with Operations Management Suite - Log Analytics
Create Azure Front Door in front of Azure API Management

Deploy to Azure
This sample demonstrates how to use Azure Front Door as a global load balancer in front of Azure API Management.