You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/api-management/api-management-using-with-vnet.md
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
1
---
2
-
title: Deploy Azure API Management instance to external VNet
2
+
title: Deploy Azure API Management Instance to External VNet
3
3
description: Learn how to deploy (inject) your Azure API instance to a virtual network in external mode and access API backends through it.
4
4
services: api-management
5
5
author: dlepow
6
6
7
7
ms.service: azure-api-management
8
8
ms.topic: how-to
9
-
ms.date: 05/15/2024
9
+
ms.date: 10/1/2025
10
10
ms.author: danlep
11
11
---
12
12
# 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
18
18
*[Using a virtual network with Azure API Management](virtual-network-concepts.md)
19
19
*[Network resource requirements for API Management injection into a virtual network](virtual-network-injection-resources.md)
20
20
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.
22
22
23
23
:::image type="content" source="media/api-management-using-with-vnet/api-management-vnet-external.png" alt-text="Connect to external VNet":::
24
24
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).
@@ -40,10 +40,10 @@ For configurations specific to the *internal* mode, where the endpoints are acce
40
40
1. Select the **External** access type.
41
41
:::image type="content" source="media/api-management-using-with-vnet/api-management-menu-vnet.png" alt-text="Select VNet in Azure portal.":::
42
42
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:
44
44
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.
47
47
48
48
:::image type="content" source="media/api-management-using-with-vnet/api-management-using-vnet-select.png" alt-text="VNet settings in the portal.":::
49
49
@@ -59,30 +59,30 @@ For configurations specific to the *internal* mode, where the endpoints are acce
59
59
60
60
:::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":::
## Connect to a web service hosted within a virtual network
65
+
67
66
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.
68
67
69
68
:::image type="content" source="media/api-management-using-with-vnet/api-management-using-vnet-add-api.png" alt-text="Add API from VNet":::
70
69
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.
73
75
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.
75
76
* 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).
76
77
* 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).
77
78
78
-
> [!IMPORTANT]
79
+
> [!IMPORTANT]
79
80
> 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).
80
81
81
-
82
82
## Routing
83
83
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.
86
86
87
87
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).
Copy file name to clipboardExpand all lines: articles/api-management/how-to-configure-cloud-metrics-logs.md
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
1
---
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
3
3
description: Learn how to configure cloud metrics and logs for Azure API Management self-hosted gateway
4
4
services: api-management
5
5
author: dlepow
6
6
manager: gwallace
7
7
ms.service: azure-api-management
8
8
ms.topic: how-to
9
-
ms.date: 04/30/2020
9
+
ms.date: 10/06/2025
10
10
ms.author: danlep
11
11
---
12
12
@@ -16,19 +16,19 @@ ms.author: danlep
16
16
17
17
This article provides details for configuring cloud metrics and logs for the [self-hosted gateway](./self-hosted-gateway-overview.md).
18
18
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.
20
20
21
21
## 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).
23
22
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:
25
26
26
27
| Field | Default | Description |
27
28
| ------------- | ------------- | ------------- |
28
29
| telemetry.metrics.cloud |`true`| Enables logging through Azure Monitor. Value can be `true`, `false`. |
29
30
30
-
31
-
Here is a sample configuration:
31
+
Here's a sample configuration:
32
32
33
33
```yaml
34
34
apiVersion: v1
@@ -46,16 +46,16 @@ The self-hosted gateway currently emits the following metrics through Azure Moni
46
46
| ------------- | ------------- |
47
47
| Requests | Number of API requests in the period |
48
48
| 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) |
50
50
51
51
## Logs
52
52
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.
54
54
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.
56
56
57
57
## Related content
58
58
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).
60
60
* To learn more about the self-hosted gateway, see [Azure API Management self-hosted gateway overview](self-hosted-gateway-overview.md)
61
61
* Learn about [configuring and persisting logs locally](how-to-configure-local-metrics-logs.md)
0 commit comments