Skip to content

Commit 991aa07

Browse files
authored
Merge pull request #178568 from dlepow/apimvnet
[APIM] Vnet article clarifications/improvements
2 parents 5e590d1 + 3f5fdbf commit 991aa07

File tree

2 files changed

+37
-34
lines changed

2 files changed

+37
-34
lines changed

articles/api-management/api-management-using-with-internal-vnet.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Use API Management in internal mode to:
3939
Some prerequisites differ depending on the version (`stv2` or `stv1`) of the [compute platform](compute-infrastructure.md) for your API Management instance.
4040

4141
> [!TIP]
42-
> When you use the portal to create or update the network configuration of your API Management instance, the instance is hosted on then `stv2` compute platform.
42+
> When you use the portal to create or update the network connection of an existing API Management instance, the instance is hosted on the `stv2` compute platform.
4343
4444
### [stv2](#tab/stv2)
4545

@@ -111,12 +111,16 @@ After successful deployment, you should see your API Management service's **priv
111111

112112
## DNS configuration
113113

114-
In external VNET mode, Azure manages the DNS. For internal VNET mode, you have to manage your own DNS. We recommend:
114+
In external VNET mode, Azure manages the DNS. For internal VNET mode, you have to manage your own DNS to enable inbound access to your API Management service endpoints.
115+
116+
We recommend:
117+
115118
1. Configure an Azure [DNS private zone](../dns/private-dns-overview.md).
116119
1. Link the Azure DNS private zone to the VNET into which you've deployed your API Management service.
117120

118121
Learn how to [set up a private zone in Azure DNS](../dns/private-dns-getstarted-portal.md).
119122

123+
120124
> [!NOTE]
121125
> The API Management service does not listen to requests on its IP addresses. It only responds to requests to the host name configured on its service endpoints. These endpoints include:
122126
> * API gateway
@@ -136,7 +140,7 @@ When you create an API Management service (`contosointernalvnet`, for example),
136140
| Direct management endpoint | `contosointernalvnet.management.azure-api.net` |
137141
| Git | `contosointernalvnet.scm.azure-api.net` |
138142

139-
To access these API Management service endpoints, you can create a virtual machine in a subnet connected to the VNET in which API Management is deployed. Assuming the internal virtual IP address for your service is 10.1.0.5, you can map the hosts file as follows. On Windows, this file is at `%SystemDrive%\drivers\etc\hosts`.
143+
To access these API Management service endpoints, you can create a virtual machine in a subnet connected to the VNET in which API Management is deployed. Assuming the [private virtual IP address](#routing) for your service is 10.1.0.5, you can map the hosts file as follows. On Windows, this file is at `%SystemDrive%\drivers\etc\hosts`.
140144

141145
| Internal virtual IP address | Endpoint configuration |
142146
| ----- | ----- |
@@ -148,7 +152,6 @@ To access these API Management service endpoints, you can create a virtual machi
148152

149153
You can then access all the service endpoints from the virtual machine you created.
150154

151-
152155
### Access on custom domain names
153156

154157
If you don't want to access the API Management service with the default host names:
@@ -157,7 +160,7 @@ If you don't want to access the API Management service with the default host nam
157160

158161
:::image type="content" source="media/api-management-using-with-internal-vnet/api-management-custom-domain-name.png" alt-text="Set up custom domain name":::
159162

160-
2. Create records in your DNS server to access the endpoints accessible from within your VNET.
163+
2. Create records in your DNS server to access the endpoints accessible from within your VNET. Map the endpoint records to the [private virtual IP address](#routing) for your service.
161164

162165
## Routing
163166

@@ -180,7 +183,7 @@ The load-balanced public and private IP addresses can be found on the **Overview
180183
181184
### VIP and DIP addresses
182185

183-
DIP addresses will be assigned to each underlying virtual machine in the service and used to access resources *within* the VNET. A VIP address will be used to access resources *outside* the VNET. If IP restriction lists secure resources within the VNET, you must specify the entire subnet range where the API Management service is deployed to grant or restrict access from the service.
186+
Dynamic IP (DIP) addresses will be assigned to each underlying virtual machine in the service and used to access resources *within* the VNET. The API Management service's public virtual IP (VIP) address will be used to access resources *outside* the VNET. If IP restriction lists secure resources within the VNET, you must specify the entire subnet range where the API Management service is deployed to grant or restrict access from the service.
184187

185188
Learn more about the [recommended subnet size](virtual-network-concepts.md#subnet-size).
186189

0 commit comments

Comments
 (0)