Skip navigation

Deploy API Management in external VNet with public IP

Last updated: 2022-03-22

This template demonstrates how to create an instance of Azure API Management in the Premium tier within your virtual network's subnet in external mode and configure recommended NSG rules on the subnet. The instance is deployed to two availability zones. The template also configures a public IP address from your subscription.

This Azure Resource Manager template was created by a member of the community and not by Microsoft. Each Resource Manager template is licensed to you under a licence agreement by its owner, not Microsoft. Microsoft is not responsible for Resource Manager templates provided and licensed by community members and does not screen for security, compatibility, or performance. Community Resource Manager templates are not supported under any Microsoft support programme or service, and are made available AS IS without warranty of any kind.

Parameters

Parameter Name Description
publisherEmail The email address of the owner of the service
publisherName The name of the owner of the service
sku The pricing tier of this API Management service
skuCount The instance size of this API Management service. This should be a multiple of the number of availability zones getting deployed.
virtualNetworkName Virtual network name
virtualNetworkAddressPrefix Address prefix
subnetPrefix Subnet prefix
subnetName Subnet name
apimSubnetServiceEndpoints Service endpoints enabled on the API Management subnet
location Azure region where the resources will be deployed
availabilityZones Numbers for availability zones, for example, 1,2,3.
publicIpName Name for the public IP address used to access the API Management service.
publicIpSku SKU for the public IP address used to access the API Management service.
publicIPAllocationMethod Allocation method for the public IP address used to access the API Management service. Standard SKU public IP requires `Static` allocation.
dnsLabelPrefix Unique DNS name for the public IP address used to access the API management service.

Use the template

PowerShell

New-AzResourceGroup -Name <resource-group-name> -Location <resource-group-location> #use this command when you need to create a new resource group for your deployment
New-AzResourceGroupDeployment -ResourceGroupName <resource-group-name> -TemplateUri https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/quickstarts/microsoft.apimanagement/api-management-create-with-external-vnet-publicip/azuredeploy.json
Install and configure Azure PowerShell

Command line

az group create --name <resource-group-name> --location <resource-group-location> #use this command when you need to create a new resource group for your deployment
az group deployment create --resource-group <my-resource-group> --template-uri https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/quickstarts/microsoft.apimanagement/api-management-create-with-external-vnet-publicip/azuredeploy.json
Install and Configure the Azure Cross-Platform Command-Line Interface