Microsoft.ApiManagement service 2016-07-07

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": "2016-07-07",
  "tags": {},
  "properties": {
    "publisherEmail": "string",
    "publisherName": "string",
    "addresserEmail": "string",
    "hostnameConfigurations": [
      {
        "type": "string",
        "hostname": "string",
        "certificate": {
          "expiry": "string",
          "thumbprint": "string",
          "subject": "string"
        }
      }
    ],
    "vpnconfiguration": {
      "subnetResourceId": "string",
      "location": "string"
    },
    "additionalLocations": [
      {
        "location": "string",
        "skuType": "string",
        "skuUnitCount": "integer",
        "vpnconfiguration": {
          "subnetResourceId": "string",
          "location": "string"
        }
      }
    ],
    "customProperties": {},
    "vpnType": "string"
  },
  "sku": {
    "name": "string",
    "capacity": "integer"
  },
  "location": "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 2016-07-07
tags object No API Management service tags. A maximum of 10 tags can be provided for a resource, and each tag must have a key no greater than 128 characters (and a value no greater than 256 characters).
properties object Yes Properties of the API Management service. - ApiManagementServiceProperties object
sku object No SKU properties of the API Management service. - ApiManagementServiceSkuProperties object
location string Yes Datacenter location of the API Management service.

ApiManagementServiceProperties object

Name Type Required Value
publisherEmail string Yes Publisher email.
publisherName string Yes Publisher name.
addresserEmail string No Addresser email.
hostnameConfigurations array No Custom hostname configuration of the API Management service. - HostnameConfiguration object
vpnconfiguration object No Virtual network configuration of the API Management service. - VirtualNetworkConfiguration object
additionalLocations array No Additional datacenter locations of the API Management service. - AdditionalRegion object
customProperties object No Custom properties of the API Management service, like disabling TLS 1.0.
vpnType 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

ApiManagementServiceSkuProperties object

Name Type Required Value
name enum Yes Name of the Sku. - Developer, Standard, Premium
capacity integer No Capacity of the SKU (number of deployed units of the SKU). The default value is 1.

HostnameConfiguration object

Name Type Required Value
type enum Yes Hostname type. - Proxy, Portal, Management, Scm
hostname string Yes Hostname.
certificate object Yes Certificate information. - CertificateInformation object

VirtualNetworkConfiguration object

Name Type Required Value
subnetResourceId string No The name of the subnet Resource ID. This has format /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft.{Network ClassicNetwork}/VirtualNetworks/{virtual network name}/subnets/{subnet name}.
location string No The location of the virtual network.

AdditionalRegion object

Name Type Required Value
location string Yes The location name of the additional region among Azure Data center regions.
skuType enum Yes The SKU type in the location. - Developer, Standard, Premium
skuUnitCount integer No The SKU Unit count at the location. The maximum SKU Unit count depends on the SkuType. Maximum allowed for Developer SKU is 1, for Standard SKU is 4, and for Premium SKU is 10, at a location.
vpnconfiguration object No Virtual network configuration for the location. - VirtualNetworkConfiguration object

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 service with SSL from KeyVault

Deploy to Azure
This template deploys an API Management service configured with User Assigned Identity. It uses this identity to fetch SSL certificate from KeyVault and keeps it updated by checking every 4 hours.
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.