Skip to content

Commit 401715f

Browse files
authored
Merge pull request #300673 from MicrosoftDocs/main
06/02/2025 AM Publishing
2 parents 2d164ba + 8cb19a6 commit 401715f

File tree

56 files changed

+477
-1184
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+477
-1184
lines changed

articles/api-management/api-management-howto-ip-addresses.md

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,39 @@
11
---
2-
title: IP addresses of Azure API Management service | Microsoft Docs
3-
description: Learn how to retrieve the IP addresses of an Azure API Management service and when they change.
2+
title: IP Addresses of API Management | Microsoft Docs
3+
description: Learn how to retrieve the IP addresses of Azure API Management. Also learn about when IP addresses can change.
44
services: api-management
55
author: dlepow
66

77
ms.service: azure-api-management
88
ms.topic: concept-article
9-
ms.date: 05/15/2024
9+
ms.date: 05/13/2025
1010
ms.author: danlep
1111
ms.custom: fasttrack-edit
12+
13+
#customer intent: As an API developer, I want to learn how to retrieve the IP addresses of API Management.
1214
---
1315

14-
# IP addresses of Azure API Management
16+
# IP addresses in Azure API Management
1517

1618
[!INCLUDE [api-management-availability-all-tiers](../../includes/api-management-availability-all-tiers.md)]
1719

18-
In this article we describe how to retrieve the IP addresses of Azure API Management service. IP addresses can be public or private if the service is in a virtual network. You can use IP addresses to create firewall rules, filter the incoming traffic to the backend services, or restrict the outbound traffic.
20+
This article describes how to retrieve the IP addresses of Azure API Management. IP addresses can be public or private if the service is in a virtual network. You can use IP addresses to create firewall rules, filter incoming traffic to backend services, or restrict outbound traffic.
1921

2022
## Public IP addresses
2123

22-
Every API Management service instance in Developer, Basic, Standard, or Premium tier has public IP addresses, which are exclusive only to that service instance (they are not shared with other resources).
24+
Every API Management instance in Developer, Basic, Standard, or Premium tier has public IP addresses that are exclusive only to that instance. (They're not shared with other resources.)
2325

24-
You can retrieve the IP addresses from the overview dashboard of your resource in the Azure portal.
26+
You can retrieve the IP addresses from the overview dashboard of your resource in the Azure portal:
2527

26-
![API Management IP address](media/api-management-howto-ip-addresses/public-ip.png)
28+
:::image type="content" source="media/api-management-howto-ip-addresses/public-ip.png" alt-text="Screenshot that shows an IP address in API Management." lightbox="media/api-management-howto-ip-addresses/public-ip.png":::
2729

28-
You can also fetch them programmatically with the following API call:
30+
You can also fetch them programmatically by using this API call:
2931

30-
```
32+
```json
3133
GET https://management.azure.com/subscriptions/<subscription-id>/resourceGroups/<resource-group>/providers/Microsoft.ApiManagement/service/<service-name>?api-version=<api-version>
3234
```
3335

34-
Public IP addresses will be part of the response:
36+
Public IP addresses will appear in the response:
3537

3638
```json
3739
{
@@ -49,17 +51,17 @@ Public IP addresses will be part of the response:
4951

5052
In [multi-regional deployments](api-management-howto-deploy-multi-region.md), each regional deployment has one public IP address.
5153

52-
## IP addresses of API Management service in VNet
54+
## IP addresses of API Management in a virtual network
5355

54-
If your API Management service is inside a virtual network, it will have two types of IP addresses: public and private.
56+
If your API Management instance is inside a virtual network, it has two types of IP addresses: public and private.
5557

56-
* Public IP addresses are used for internal communication on port `3443` - for managing configuration (for example, through Azure Resource Manager). In the *external* VNet configuration, they are also used for runtime API traffic. In the *internal* VNet configuration, public IP addresses are only used for Azure internal management operations and don't expose your instance to the internet.
58+
* Public IP addresses are used for internal communication, on port `3443`, for managing configuration (for example, through Azure Resource Manager). In the *external* virtual network configuration, they're also used for runtime API traffic. In the *internal* virtual network configuration, public IP addresses are used only for Azure internal management operations and don't expose your instance to the internet.
5759

58-
* Private virtual IP (VIP) addresses, available **only** in the [internal VNet mode](api-management-using-with-internal-vnet.md), are used to connect from within the network to API Management endpoints - gateways, the developer portal, and the management plane for direct API access. You can use them for setting up DNS records within the network.
60+
* Private virtual IP (VIP) addresses, available only in [internal virtual network mode](api-management-using-with-internal-vnet.md), are used to connect from within the network to API Management endpoints: gateways, the developer portal, and the management plane for direct API access. You can use these addresses for setting up DNS records within the network.
5961

60-
You will see addresses of both types in the Azure portal and in the response of the API call:
62+
You'll see addresses of both types in the Azure portal and in the response of an API call:
6163

62-
![API Management in VNet IP address](media/api-management-howto-ip-addresses/vnet-ip.png)
64+
:::image type="content" source="media/api-management-howto-ip-addresses/vnet-ip.png" alt-text="Screenshot that shows a VIP address in API Management." lightbox="media/api-management-howto-ip-addresses/vnet-ip.png":::
6365

6466

6567
```json
@@ -82,24 +84,23 @@ GET https://management.azure.com/subscriptions/<subscription-id>/resourceGroups/
8284
```
8385

8486
> [!IMPORTANT]
85-
> The private IP addresses of internal load balancer and API Management units are assigned dynamically. Therefore, it is impossible to anticipate the private IP of the API Management instance prior to its deployment. Additionally, changing to a different subnet and then returning may cause a change in the private IP address.
86-
87+
> The private IP addresses of internal load balancer and API Management units are assigned dynamically. It's therefore impossible to anticipate the private IP of the API Management instance before its deployment. Additionally, changing to a different subnet and then returning might cause a change in the private IP address.
8788
8889
### IP addresses for outbound traffic
8990

90-
API Management uses a public IP address for a connection outside the VNet or a peered VNet, and it uses a private IP address for a connection in the VNet or a peered VNet.
91+
API Management uses a public IP address for a connection outside the virtual network or a peered virtual network. It uses a private IP address for a connection in the virtual network or a peered virtual network.
9192

92-
* When API Management is deployed in an external or internal virtual network and API Management connects to private (intranet-facing) backends, internal IP addresses (dynamic IP, or DIP addresses) from the subnet are used for the runtime API traffic. When a request is sent from API Management to a private backend, a private IP address will be visible as the origin of the request.
93+
* When API Management is deployed in an external or internal virtual network and API Management connects to private (intranet-facing) backends, internal IP addresses (dynamic IP, or DIP, addresses) from the subnet are used for the runtime API traffic. When a request is sent from API Management to a private backend, a private IP address will be visible as the origin of the request.
9394

94-
Therefore, if IP restriction lists secure resources within the VNet or a peered VNet, it is recommended to use the whole API Management [subnet range](virtual-network-injection-resources.md#subnet-size) with an IP rule - and (in internal mode) not just the private IP address associated with the API Management resource.
95+
Therefore, if IP restriction lists secure resources within the virtual network or a peered virtual network, we recommend that you use the whole API Management [subnet range](virtual-network-injection-resources.md#subnet-size) with an IP rule and (in internal mode) not just the private IP address associated with the API Management resource.
9596

9697
* When a request is sent from API Management to a public (internet-facing) backend, a public IP address will always be visible as the origin of the request.
9798

98-
## IP addresses of Consumption, Basic v2, Standard v2, and Premium v2 tier API Management service
99+
## IP addresses of Consumption, Basic v2, Standard v2, and Premium v2 tier API Management instances
99100

100101
If your API Management instance is created in a service tier that runs on a shared infrastructure, it doesn't have a dedicated IP address. Currently, instances in the following service tiers run on a shared infrastructure and without a deterministic IP address: Consumption, Basic v2, Standard v2, Premium v2.
101102

102-
If you need to add the outbound IP addresses used by your Consumption, Basic v2, Standard v2, or Premium v2 tier instance to an allowlist, you can add the instance's data center (Azure region) to an allowlist. You can [download a JSON file that lists IP addresses for all Azure data centers](https://www.microsoft.com/download/details.aspx?id=56519). Then find the JSON fragment that applies to the region that your instance runs in.
103+
If you need to add the outbound IP addresses used by your Consumption, Basic v2, Standard v2, or Premium v2 tier instance to an allowlist, you can add the instance's datacenter (Azure region) to an allowlist. You can [download a JSON file that lists IP addresses for all Azure datacenters](https://www.microsoft.com/download/details.aspx?id=56519). Then find the JSON fragment that applies to the region that your instance runs in.
103104

104105
For example, the following JSON fragment is what the allowlist for Western Europe might look like:
105106

@@ -116,7 +117,6 @@ For example, the following JSON fragment is what the allowlist for Western Europ
116117
"13.69.0.0/17",
117118
"13.73.128.0/18",
118119
... Some IP addresses not shown here
119-
"213.199.180.192/27",
120120
"213.199.183.0/24"
121121
]
122122
}
@@ -125,15 +125,15 @@ For example, the following JSON fragment is what the allowlist for Western Europ
125125

126126
For information about when this file is updated and when the IP addresses change, expand the **Details** section of the [Download Center page](https://www.microsoft.com/en-us/download/details.aspx?id=56519).
127127

128-
## Changes to the IP addresses
128+
## Changes to IP addresses
129129

130-
In the Developer, Basic, Standard, and Premium tiers of API Management, the public IP address or addresses (VIP) and private VIP addresses (if configured in the internal VNet mode) are static for the lifetime of a service, with the following exceptions:
130+
In the Developer, Basic, Standard, and Premium tiers of API Management, the public IP address or addresses (VIP) and private VIP addresses (if configured in the internal virtual network mode) are static for the lifetime of a service, with the following exceptions:
131131

132-
* The API Management service is deleted and then re-created.
133-
* The service subscription is disabled or warned (for example, for nonpayment) and then reinstated. [Learn more about subscription states](/azure/cost-management-billing/manage/subscription-states)
132+
* The API Management is deleted and then re-created.
133+
* The service subscription is disabled or warned (for example, for nonpayment) and then reinstated. [Learn more about subscription states.](/azure/cost-management-billing/manage/subscription-states)
134134
* (Developer and Premium tiers) Azure Virtual Network is added to or removed from the service.
135-
* (Developer and Premium tiers) API Management service is switched between external and internal VNet deployment mode.
136-
* (Developer and Premium tiers) API Management service is moved to a different subnet or configured with a different public IP address resource.
135+
* (Developer and Premium tiers) API Management is switched between external and internal virtual network deployment mode.
136+
* (Developer and Premium tiers) API Management is moved to a different subnet or configured with a different public IP address resource.
137137
* (Premium tier) [Availability zones](../reliability/migrate-api-mgt.md) are enabled, added, or removed.
138138
* (Premium tier) In [multi-regional deployments](api-management-howto-deploy-multi-region.md), the regional IP address changes if a region is vacated and then reinstated.
139139

0 commit comments

Comments
 (0)