| title | description | services | author | ms.service | ms.topic | ms.date | ms.author | ms.custom |
|---|---|---|---|---|---|---|---|---|
VNet configuration settings | Azure API Management |
Reference for network configuration settings when deploying Azure API Management to a virtual network |
api-management |
dlepow |
api-management |
reference |
01/06/2023 |
danlep |
references_regions |
This reference provides detailed network configuration settings for an API Management instance deployed in an Azure virtual network in the external or internal mode.
For VNet connectivity options, requirements, and considerations, see Using a virtual network with Azure API Management.
Control inbound and outbound traffic into the subnet in which API Management is deployed by using network security group rules. If certain ports are unavailable, API Management may not operate properly and may become inaccessible.
When an API Management service instance is hosted in a VNet, the ports in the following table are used. Some requirements differ depending on the version (stv2 or stv1) of the compute platform hosting your API Management instance.
Important
-
Bold items in the Purpose column indicate port configurations required for successful deployment and operation of the API Management service. Configurations labeled "optional" enable specific features, as noted. They are not required for the overall health of the service.
-
We recommend using service tags instead of IP addresses in NSG rules to specify network sources and destinations. Service tags prevent downtime when infrastructure improvements necessitate IP address changes.
Important
When using stv2, it is required to assign a Network Security Group to your VNet in order for the Azure Load Balancer to work. Learn more in the Azure Load Balancer documentation.
| Source / Destination Port(s) | Direction | Transport protocol | Service tags Source / Destination |
Purpose | VNet type |
|---|---|---|---|---|---|
| * / [80], 443 | Inbound | TCP | Internet / VirtualNetwork | Client communication to API Management | External only |
| * / 3443 | Inbound | TCP | ApiManagement / VirtualNetwork | Management endpoint for Azure portal and PowerShell | External & Internal |
| * / 443 | Outbound | TCP | VirtualNetwork / Storage | Dependency on Azure Storage | External & Internal |
| * / 443 | Outbound | TCP | VirtualNetwork / AzureActiveDirectory | Azure Active Directory and Azure Key Vault dependency (optional) | External & Internal |
| * / 443 | Outbound | TCP | VirtualNetwork / AzureConnectors | Authorizations dependency (optional) | External & Internal |
| * / 1433 | Outbound | TCP | VirtualNetwork / Sql | Access to Azure SQL endpoints | External & Internal |
| * / 443 | Outbound | TCP | VirtualNetwork / AzureKeyVault | Access to Azure Key Vault | External & Internal |
| * / 5671, 5672, 443 | Outbound | TCP | VirtualNetwork / EventHub | Dependency for Log to Azure Event Hubs policy and Azure Monitor (optional) | External & Internal |
| * / 445 | Outbound | TCP | VirtualNetwork / Storage | Dependency on Azure File Share for GIT (optional) | External & Internal |
| * / 1886, 443 | Outbound | TCP | VirtualNetwork / AzureMonitor | Publish Diagnostics Logs and Metrics, Resource Health, and Application Insights (optional) | External & Internal |
| * / 6380 | Inbound & Outbound | TCP | VirtualNetwork / VirtualNetwork | Access external Azure Cache for Redis service for caching policies between machines (optional) | External & Internal |
| * / 6381 - 6383 | Inbound & Outbound | TCP | VirtualNetwork / VirtualNetwork | Access internal Azure Cache for Redis service for caching policies between machines (optional) | External & Internal |
| * / 4290 | Inbound & Outbound | UDP | VirtualNetwork / VirtualNetwork | Sync Counters for Rate Limit policies between machines (optional) | External & Internal |
| * / 6390 | Inbound | TCP | AzureLoadBalancer / VirtualNetwork | Azure Infrastructure Load Balancer | External & Internal |
| Source / Destination Port(s) | Direction | Transport protocol | Service Tags Source / Destination |
Purpose | VNet type |
|---|---|---|---|---|---|
| * / [80], 443 | Inbound | TCP | Internet / VirtualNetwork | Client communication to API Management | External only |
| * / 3443 | Inbound | TCP | ApiManagement / VirtualNetwork | Management endpoint for Azure portal and PowerShell | External & Internal |
| * / 443 | Outbound | TCP | VirtualNetwork / Storage | Dependency on Azure Storage | External & Internal |
| * / 443 | Outbound | TCP | VirtualNetwork / AzureActiveDirectory | Azure Active Directory and Azure Key Vault dependency (optional) | External & Internal |
| * / 443 | Outbound | TCP | VirtualNetwork / AzureKeyVault | Access to Azure Key Vault for named values integration (optional) | External & Internal |
| * / 443 | Outbound | TCP | VirtualNetwork / AzureConnectors | Authorizations dependency (optional) | External & Internal |
| * / 1433 | Outbound | TCP | VirtualNetwork / Sql | Access to Azure SQL endpoints | External & Internal |
| * / 5671, 5672, 443 | Outbound | TCP | VirtualNetwork / Azure Event Hubs | Dependency for Log to Azure Event Hubs policy and monitoring agent (optional) | External & Internal |
| * / 445 | Outbound | TCP | VirtualNetwork / Storage | Dependency on Azure File Share for GIT (optional) | External & Internal |
| * / 443, 12000 | Outbound | TCP | VirtualNetwork / AzureCloud | Health and Monitoring Extension & Dependency on Event Grid (if events notification activated) (optional) | External & Internal |
| * / 1886, 443 | Outbound | TCP | VirtualNetwork / AzureMonitor | Publish Diagnostics Logs and Metrics, Resource Health, and Application Insights (optional) | External & Internal |
| * / 6380 | Inbound & Outbound | TCP | VirtualNetwork / VirtualNetwork | Access external Azure Cache for Redis service for caching policies between machines (optional) | External & Internal |
| * / 6381 - 6383 | Inbound & Outbound | TCP | VirtualNetwork / VirtualNetwork | Access internal Azure Cache for Redis service for caching policies between machines (optional) | External & Internal |
| * / 4290 | Inbound & Outbound | UDP | VirtualNetwork / VirtualNetwork | Sync Counters for Rate Limit policies between machines (optional) | External & Internal |
| * / * | Inbound | TCP | AzureLoadBalancer / VirtualNetwork | Azure Infrastructure Load Balancer (required for Premium SKU, optional for other SKUs) | External & Internal |
NSG rules allowing outbound connectivity to Storage, SQL, and Azure Event Hubs service tags may use the regional versions of those tags corresponding to the region containing the API Management instance (for example, Storage.WestUS for an API Management instance in the West US region). In multi-region deployments, the NSG in each region should allow traffic to the service tags for that region and the primary region.
To enable TLS/SSL certificate chain building and validation, the API Management service needs outbound network connectivity to ocsp.msocsp.com, mscrl.microsoft.com, and crl.microsoft.com. This dependency is not required if any certificate you upload to API Management contains the full chain to the CA root.
Outbound access on port 53 is required for communication with DNS servers. If a custom DNS server exists on the other end of a VPN gateway, the DNS server must be reachable from the subnet hosting API Management.
To operate properly, the API Management service needs outbound connectivity on port 443 to the following endpoints associated with its cloud-based API Management instance:
| Description | Required | Notes |
|---|---|---|
| Endpoints for Azure Active Directory integration | ✔️ | Required endpoints are <region>.login.microsoft.com and login.microsoftonline.com. |
Outbound network connectivity to Azure Monitoring endpoints, which resolve under the following domains, are represented under the AzureMonitor service tag for use with Network Security Groups.
Outbound network connectivity to Azure Monitoring endpoints, which resolve under the following domains, are represented under the AzureMonitor service tag for use with Network Security Groups.
| Azure Environment | Endpoints | |-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Azure Public |
- gcs.prod.monitoring.core.windows.net
- global.prod.microsoftmetrics.com
- shoebox2.prod.microsoftmetrics.com
- shoebox2-red.prod.microsoftmetrics.com
- shoebox2-black.prod.microsoftmetrics.com
- prod3.prod.microsoftmetrics.com
- prod3-black.prod.microsoftmetrics.com
- prod3-red.prod.microsoftmetrics.com
- gcs.prod.warm.ingestion.monitoring.azure.com
- fairfax.warmpath.usgovcloudapi.net
- global.prod.microsoftmetrics.com
- shoebox2.prod.microsoftmetrics.com
- shoebox2-red.prod.microsoftmetrics.com
- shoebox2-black.prod.microsoftmetrics.com
- prod3.prod.microsoftmetrics.com
- prod3-black.prod.microsoftmetrics.com
- prod3-red.prod.microsoftmetrics.com
- prod5.prod.microsoftmetrics.com
- prod5-black.prod.microsoftmetrics.com
- prod5-red.prod.microsoftmetrics.com
- gcs.prod.warm.ingestion.monitoring.azure.us
- mooncake.warmpath.chinacloudapi.cn
- global.prod.microsoftmetrics.com
- shoebox2.prod.microsoftmetrics.com
- shoebox2-red.prod.microsoftmetrics.com
- shoebox2-black.prod.microsoftmetrics.com
- prod3.prod.microsoftmetrics.com
- prod3-red.prod.microsoftmetrics.com
- prod5.prod.microsoftmetrics.com
- prod5-black.prod.microsoftmetrics.com
- prod5-red.prod.microsoftmetrics.com
- gcs.prod.warm.ingestion.monitoring.azure.cn
Allow outbound network connectivity for the developer portal's CAPTCHA, which resolves under the hosts client.hip.live.com and partner.hip.live.com.
Enable publishing the developer portal for an API Management instance in a VNet by allowing outbound connectivity to blob storage in the West US region. For example, use the Storage.WestUS service tag in an NSG rule. Currently, connectivity to blob storage in the West US region is required to publish the developer portal for any API Management instance.
When using the API Management diagnostics extension from inside a VNet, outbound access to dc.services.visualstudio.com on port 443 is required to enable the flow of diagnostic logs from Azure portal. This access helps in troubleshooting issues you might face when using the extension.
You're not required to allow inbound requests from service tag AzureLoadBalancer for the Developer SKU, since only one compute unit is deployed behind it. However, inbound connectivity from AzureLoadBalancer becomes critical when scaling to a higher SKU, such as Premium, because failure of the health probe from load balancer then blocks all inbound access to the control plane and data plane.
If you enabled Azure Application Insights monitoring on API Management, allow outbound connectivity to the telemetry endpoint from the VNet.
When adding virtual machines running Windows to the VNet, allow outbound connectivity on port 1688 to the KMS endpoint in your cloud. This configuration routes Windows VM traffic to the Azure Key Management Services (KMS) server to complete Windows activation.
The following IP addresses are divided by Azure Environment and Region. In some cases, two IP addresses are listed. Permit both IP addresses.
Important
Control plane IP addresses should be configured for network access rules only when needed in certain networking scenarios. We recommend using the ApiManagement service tag instead of control plane IP addresses to prevent downtime when infrastructure improvements necessitate IP address changes.
| Azure Environment | Region | IP address |
|---|---|---|
| Azure Public | Australia Central | 20.37.52.67 |
| Azure Public | Australia Central 2 | 20.39.99.81 |
| Azure Public | Australia East | 20.40.125.155 |
| Azure Public | Australia Southeast | 20.40.160.107 |
| Azure Public | Brazil South | 191.233.24.179, 191.238.73.14 |
| Azure Public | Brazil Southeast | 191.232.18.181 |
| Azure Public | Canada Central | 52.139.20.34, 20.48.201.76 |
| Azure Public | Canada East | 52.139.80.117 |
| Azure Public | Central India | 13.71.49.1, 20.192.45.112 |
| Azure Public | Central US | 13.86.102.66 |
| Azure Public | Central US EUAP | 52.253.159.160 |
| Azure Public | East Asia | 52.139.152.27 |
| Azure Public | East US | 52.224.186.99 |
| Azure Public | East US 2 | 20.44.72.3 |
| Azure Public | East US 2 EUAP | 52.253.229.253 |
| Azure Public | France Central | 40.66.60.111 |
| Azure Public | France South | 20.39.80.2 |
| Azure Public | Germany North | 51.116.0.0 |
| Azure Public | Germany West Central | 51.116.96.0, 20.52.94.112 |
| Azure Public | Japan East | 52.140.238.179 |
| Azure Public | Japan West | 40.81.185.8 |
| Azure Public | India Central | 20.192.234.160 |
| Azure Public | India West | 20.193.202.160 |
| Azure Public | Korea Central | 40.82.157.167, 20.194.74.240 |
| Azure Public | Korea South | 40.80.232.185 |
| Azure Public | North Central US | 40.81.47.216 |
| Azure Public | North Europe | 52.142.95.35 |
| Azure Public | Norway East | 51.120.2.185 |
| Azure Public | Norway West | 51.120.130.134 |
| Azure Public | South Africa North | 102.133.130.197, 102.37.166.220 |
| Azure Public | South Africa West | 102.133.0.79 |
| Azure Public | South Central US | 20.188.77.119, 20.97.32.190 |
| Azure Public | South India | 20.44.33.246 |
| Azure Public | Southeast Asia | 40.90.185.46 |
| Azure Public | Switzerland North | 51.107.246.176, 51.107.0.91 |
| Azure Public | Switzerland West | 51.107.96.8 |
| Azure Public | UAE Central | 20.37.81.41 |
| Azure Public | UAE North | 20.46.144.85 |
| Azure Public | UK South | 51.145.56.125 |
| Azure Public | UK West | 51.137.136.0 |
| Azure Public | West Central US | 52.253.135.58 |
| Azure Public | West Europe | 51.145.179.78 |
| Azure Public | West India | 40.81.89.24 |
| Azure Public | West US | 13.64.39.16 |
| Azure Public | West US 2 | 51.143.127.203 |
| Azure Public | West US 3 | 20.150.167.160 |
| Microsoft Azure operated by 21Vianet | China North (Global) | 139.217.51.16 |
| Microsoft Azure operated by 21Vianet | China East (Global) | 139.217.171.176 |
| Microsoft Azure operated by 21Vianet | China North | 40.125.137.220 |
| Microsoft Azure operated by 21Vianet | China East | 40.126.120.30 |
| Microsoft Azure operated by 21Vianet | China North 2 | 40.73.41.178 |
| Microsoft Azure operated by 21Vianet | China East 2 | 40.73.104.4 |
| Azure Government | USGov Virginia (Global) | 52.127.42.160 |
| Azure Government | USGov Texas (Global) | 52.127.34.192 |
| Azure Government | USGov Virginia | 52.227.222.92 |
| Azure Government | USGov Iowa | 13.73.72.21 |
| Azure Government | USGov Arizona | 52.244.32.39 |
| Azure Government | USGov Texas | 52.243.154.118 |
| Azure Government | USDoD Central | 52.182.32.132 |
| Azure Government | USDoD East | 52.181.32.192 |
Learn more about: