Skip to content

Commit 3ac07dd

Browse files
Merge pull request #306841 from MicrosoftDocs/main
Auto Publish – main to live - 2025-10-13 17:00 UTC
2 parents 6f7fc22 + c1e5de5 commit 3ac07dd

21 files changed

Lines changed: 131 additions & 114 deletions

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

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
title: Deploy Azure API Management instance to external VNet
2+
title: Deploy Azure API Management Instance to External VNet
33
description: Learn how to deploy (inject) your Azure API instance to a virtual network in external mode and access API backends through it.
44
services: api-management
55
author: dlepow
66

77
ms.service: azure-api-management
88
ms.topic: how-to
9-
ms.date: 05/15/2024
9+
ms.date: 10/1/2025
1010
ms.author: danlep
1111
---
1212
# Deploy your Azure API Management instance to a virtual network - external mode
@@ -18,11 +18,11 @@ Azure API Management can be deployed (injected) inside an Azure virtual network
1818
* [Using a virtual network with Azure API Management](virtual-network-concepts.md)
1919
* [Network resource requirements for API Management injection into a virtual network](virtual-network-injection-resources.md)
2020

21-
This article explains how to set up VNet connectivity for your API Management instance in the *external* mode, where the developer portal, API gateway, and other API Management endpoints are accessible from the public internet, and backend services are located in the network.
21+
This article explains how to set up VNet connectivity for your API Management instance in the *external* mode, where the developer portal, API gateway, and other API Management endpoints are accessible from the public internet, and backend services are located in the network.
2222

2323
:::image type="content" source="media/api-management-using-with-vnet/api-management-vnet-external.png" alt-text="Connect to external VNet":::
2424

25-
For configurations specific to the *internal* mode, where the endpoints are accessible only within the VNet, see [Deploy your Azure API Management instance to a virtual network - internal mode](./api-management-using-with-internal-vnet.md).
25+
For configurations specific to the *internal* mode, where the endpoints are accessible only within the VNet, see [Deploy your Azure API Management instance to a virtual network - internal mode](./api-management-using-with-internal-vnet.md).
2626

2727
[!INCLUDE [updated-for-az](~/reusable-content/ce-skilling/azure/includes/updated-for-az.md)]
2828

@@ -40,10 +40,10 @@ For configurations specific to the *internal* mode, where the endpoints are acce
4040
1. Select the **External** access type.
4141
:::image type="content" source="media/api-management-using-with-vnet/api-management-menu-vnet.png" alt-text="Select VNet in Azure portal.":::
4242

43-
1. In the list of locations (regions) where your API Management service is provisioned:
43+
1. In the list of locations (regions) where your API Management service is provisioned:
4444
1. Choose a **Location**.
45-
1. Select **Virtual network**, **Subnet**, and (optionally) **IP address**.
46-
* The VNet list is populated with Resource Manager VNets available in your Azure subscriptions, set up in the region you are configuring.
45+
1. Select **Virtual network**, **Subnet**, and (optionally) **IP address**.
46+
* The VNet list is populated with Resource Manager VNets available in your Azure subscriptions, set up in the region you're configuring.
4747

4848
:::image type="content" source="media/api-management-using-with-vnet/api-management-using-vnet-select.png" alt-text="VNet settings in the portal.":::
4949

@@ -59,30 +59,30 @@ For configurations specific to the *internal* mode, where the endpoints are acce
5959

6060
:::image type="content" source="~/reusable-content/ce-skilling/azure/media/template-deployments/deploy-to-azure-button.svg" alt-text="Button to deploy the Resource Manager template to Azure." border="false" link="https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure%2Fazure-quickstart-templates%2Fmaster%2Fquickstarts%2Fmicrosoft.apimanagement%2Fapi-management-create-with-external-vnet-publicip%2Fazuredeploy.json":::
6161

62-
63-
6462
[!INCLUDE [api-management-recommended-nsg-rules](../../includes/api-management-recommended-nsg-rules.md)]
6563

6664
## Connect to a web service hosted within a virtual network
65+
6766
Once you've connected your API Management service to the VNet, you can access backend services within it just as you do public services. When creating or editing an API, type the local IP address or the host name (if a DNS server is configured for the VNet) of your web service into the **Web service URL** field.
6867

6968
:::image type="content" source="media/api-management-using-with-vnet/api-management-using-vnet-add-api.png" alt-text="Add API from VNet":::
7069

71-
## Custom DNS server setup
72-
In external VNet mode, Azure manages the DNS by default. You can optionally configure a custom DNS server.
70+
## Custom DNS server setup
71+
72+
In external VNet mode, Azure manages the DNS by default. You can optionally configure a custom DNS server.
73+
74+
The API Management service depends on several Azure services. When API Management is hosted in a VNet with a custom DNS server, it needs to resolve the hostnames of those Azure services.
7375

74-
The API Management service depends on several Azure services. When API Management is hosted in a VNet with a custom DNS server, it needs to resolve the hostnames of those Azure services.
7576
* For guidance on custom DNS setup, including forwarding for Azure-provided hostnames, see [Name resolution for resources in Azure virtual networks](../virtual-network/virtual-networks-name-resolution-for-vms-and-role-instances.md#name-resolution-that-uses-your-own-dns-server).
7677
* Outbound network access on port `53` is required for communication with DNS servers. For more settings, see [Virtual network configuration reference](virtual-network-reference.md).
7778

78-
> [!IMPORTANT]
79+
> [!IMPORTANT]
7980
> If you plan to use a custom DNS server(s) for the VNet, set it up **before** deploying an API Management service into it. Otherwise, you'll need to update the API Management service each time you change the DNS Server(s) by running the [Apply Network Configuration Operation](/rest/api/apimanagement/current-ga/api-management-service/apply-network-configuration-updates).
8081
81-
8282
## Routing
8383

84-
+ A load-balanced public IP address (VIP) is reserved to provide access to the API Management endpoints and resources outside the VNet.
85-
+ The public VIP can be found on the **Overview/Essentials** blade in the Azure portal.
84+
* A load-balanced public IP address (VIP) is reserved to provide access to the API Management endpoints and resources outside the VNet.
85+
* The public VIP can be found on the **Overview/Essentials** blade in the Azure portal.
8686

8787
For more information and considerations, see [IP addresses of Azure API Management](api-management-howto-ip-addresses.md#ip-addresses-of-api-management-in-a-virtual-network).
8888

articles/api-management/how-to-configure-cloud-metrics-logs.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
title: Configure cloud metrics and logs for Azure API Management self-hosted gateway | Microsoft Docs
2+
title: Configure Cloud Metrics and Logs for Azure API Management Self-Hosted Gateway | Microsoft Docs
33
description: Learn how to configure cloud metrics and logs for Azure API Management self-hosted gateway
44
services: api-management
55
author: dlepow
66
manager: gwallace
77
ms.service: azure-api-management
88
ms.topic: how-to
9-
ms.date: 04/30/2020
9+
ms.date: 10/06/2025
1010
ms.author: danlep
1111
---
1212

@@ -16,19 +16,19 @@ ms.author: danlep
1616

1717
This article provides details for configuring cloud metrics and logs for the [self-hosted gateway](./self-hosted-gateway-overview.md).
1818

19-
The self-hosted gateway has to be associated with an API management service and requires outbound TCP/IP connectivity to Azure on port 443. The gateway leverages the outbound connection to send telemetry to Azure, if configured to do so.
19+
You must associate the self-hosted gateway with an Azure API Management service and provide outbound TCP/IP connectivity to Azure on port 443. The gateway uses the outbound connection to send telemetry to Azure, if you configure it to do so.
2020

2121
## Metrics
22-
By default, the self-hosted gateway emits a number of metrics through [Azure Monitor](https://azure.microsoft.com/services/monitor/), same as the managed gateway [in the cloud](api-management-howto-use-azure-monitor.md).
2322

24-
The feature can be enabled or disabled using the `telemetry.metrics.cloud` key in the ConfigMap of the gateway Deployment. Below is a breakdown of the available configurations:
23+
By default, the self-hosted gateway emits several metrics through [Azure Monitor](https://azure.microsoft.com/services/monitor/), just like the managed gateway [in the cloud](api-management-howto-use-azure-monitor.md).
24+
25+
You can enable or disable this feature by using the `telemetry.metrics.cloud` key in the ConfigMap of the gateway Deployment. The following table describes the available configurations:
2526

2627
| Field | Default | Description |
2728
| ------------- | ------------- | ------------- |
2829
| telemetry.metrics.cloud | `true` | Enables logging through Azure Monitor. Value can be `true`, `false`. |
2930

30-
31-
Here is a sample configuration:
31+
Here's a sample configuration:
3232

3333
```yaml
3434
apiVersion: v1
@@ -46,16 +46,16 @@ The self-hosted gateway currently emits the following metrics through Azure Moni
4646
| ------------- | ------------- |
4747
| Requests | Number of API requests in the period |
4848
| Duration of gateway requests | Number of milliseconds from the moment gateway received request until the moment response sent in full |
49-
| Duration of backend requests | Number of milliseconds spent on overall backend IO (connecting, sending and receiving bytes) |
49+
| Duration of backend requests | Number of milliseconds spent on overall backend IO (connecting, sending, and receiving bytes) |
5050
5151
## Logs
5252
53-
The self-hosted gateway currently does not send [diagnostic logs](./api-management-howto-use-azure-monitor.md#activity-logs) to the cloud. However, it is possible to [configure and persist logs locally](how-to-configure-local-metrics-logs.md) where the self-hosted gateway is deployed.
53+
The self-hosted gateway currently doesn't send [diagnostic logs](./api-management-howto-use-azure-monitor.md#activity-logs) to the cloud. However, you can [configure and persist logs locally](how-to-configure-local-metrics-logs.md) where the self-hosted gateway is deployed.
5454
55-
If a gateway is deployed in [Azure Kubernetes Service](https://azure.microsoft.com/services/kubernetes-service/), you can enable [Azure Monitor for containers](/azure/azure-monitor/containers/container-insights-overview) to collect logs from your containers and view them in Log Analytics.
55+
If a gateway is deployed in [Azure Kubernetes Service](https://azure.microsoft.com/services/kubernetes-service/), you can enable [Azure Monitor for containers](/azure/azure-monitor/containers/container-insights-overview) to collect logs from your containers and view them in Log Analytics.
5656
5757
## Related content
5858
59-
* To learn more about the [observability capabilities of the Azure API Management gateways](observability.md).
59+
* Learn more about the [observability capabilities of the Azure API Management gateways](observability.md).
6060
* To learn more about the self-hosted gateway, see [Azure API Management self-hosted gateway overview](self-hosted-gateway-overview.md)
6161
* Learn about [configuring and persisting logs locally](how-to-configure-local-metrics-logs.md)

0 commit comments

Comments
 (0)