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
Azure API Management can be deployed (injected) inside an Azure virtual network (VNet) to access backend services within the network. For VNet connectivity options, requirements, and considerations, see:
16
+
You can deploy Azure API Management inside an Azure virtual network to access backend services within the network. For virtual network connectivity options, requirements, and considerations, see:
17
17
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 virtual network connectivity for your API Management Developer tier or Premium tier instance in the *external* mode. In this mode, the developer portal, API gateway, and other API Management endpoints are accessible from the public internet, and backend services can be located in the network.
22
22
23
-
:::image type="content" source="media/api-management-using-with-vnet/api-management-vnet-external.png" alt-text="Connect to external VNet":::
23
+
:::image type="content" source="media/api-management-using-with-vnet/api-management-vnet-external.png" alt-text="Diagram showing API Management in an external virtual network.":::
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 virtual network, see [Deploy your Azure API Management instance to a virtual network - internal mode](./api-management-using-with-internal-vnet.md).
### Enable VNet connectivity using the Azure portal
35
+
### Enable virtual network connectivity by using the Azure portal
36
36
37
37
1. Go to the [Azure portal](https://portal.azure.com) to find your API management instance. Search for and select **API Management services**.
38
-
1.Choose your API Management instance.
39
-
1.Select**Network**.
38
+
1.Select your API Management instance.
39
+
1.In the sidebar menu, under **Deployment + infrastructure**, select**Network**.
40
40
1. Select the **External** access type.
41
-
:::image type="content" source="media/api-management-using-with-vnet/api-management-menu-vnet.png" alt-text="Select VNet in Azure portal.":::
41
+
:::image type="content" source="media/api-management-using-with-vnet/api-management-menu-vnet.png" alt-text="Screenshot of network settings in the Azure portal.":::
42
42
43
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're configuring.
45
+
1. Select **Virtual network**, **Subnet**, and (optionally) **Public IP address**.
46
+
* The virtual network list is populated with virtual networks available in your Azure subscriptions, set up in the region you're configuring.
47
47
48
-
:::image type="content" source="media/api-management-using-with-vnet/api-management-using-vnet-select.png" alt-text="VNet settings in the portal.":::
48
+
:::image type="content" source="media/api-management-using-with-vnet/api-management-using-vnet-select.png" alt-text="Screenshot showing virtual network configuration in the portal.":::
49
49
50
-
1. Select **Apply**. The **Network** page of your API Management instance is updated with your new VNet and subnet choices.
50
+
1. Select **Apply**. The **Network** page of your API Management instance is updated with your new virtual network and subnet choices.
51
51
52
-
1. Continue configuring VNet settings for the remaining locations of your API Management instance.
52
+
1. Select **Verify** to confirm that the prerequisites are met and the API Management service can successfully update.
53
+
54
+
1. Continue configuring virtual network settings for the remaining locations of your API Management instance.
53
55
54
56
1. In the top navigation bar, select **Save**.
55
57
56
-
### Enable connectivity using a Resource Manager template
58
+
### Enable connectivity by using a Resource Manager template
57
59
58
60
* Azure Resource Manager [template](https://github.com/Azure/azure-quickstart-templates/tree/master/quickstarts/microsoft.apimanagement/api-management-create-with-external-vnet-publicip) (API version 2021-08-01)
59
61
@@ -63,26 +65,26 @@ For configurations specific to the *internal* mode, where the endpoints are acce
63
65
64
66
## 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
+
After you connect your API Management service to the virtual network, you can access backend services within the virtual network 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 virtual network) of your web service into the **Web service URL** field.
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
+
:::image type="content" source="media/api-management-using-with-vnet/api-management-using-vnet-add-api.png" alt-text="Screenshot showing how to add API from virtual network in the portal.":::
69
71
70
72
## Custom DNS server setup
71
73
72
-
In external VNet mode, Azure manages the DNS by default. You can optionally configure a custom DNS server.
74
+
In external virtual network mode, Azure manages the DNS by default. You can optionally configure a custom DNS server.
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.
76
+
The API Management service depends on several Azure services. When API Management is hosted in a virtual network with a custom DNS server, it needs to resolve the hostnames of those Azure services.
75
77
76
78
* 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).
77
79
* 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).
78
80
79
81
> [!IMPORTANT]
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).
82
+
> If you plan to use custom DNS servers for the virtual network, set them up **before** deploying an API Management service into the virtual network. Otherwise, you need to update the API Management service each time you change the DNS servers by running the [Apply Network Configuration Operation](/rest/api/apimanagement/current-ga/api-management-service/apply-network-configuration-updates). You can also apply a network configuration on the **Network/Network status** blade in the Azure portal.
81
83
82
84
## Routing
83
85
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
+
* A load-balanced public IP address (VIP) is reserved to provide access to the API Management endpoints and resources outside the virtual network.
87
+
*You can find the public VIP on the **Overview/Essentials** blade in the Azure portal.
86
88
87
89
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: includes/api-management-recommended-nsg-rules.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ ms.author: danlep
8
8
9
9
## Configure NSG rules
10
10
11
-
Configure custom network rules in the API Management subnet to filter traffic to and from your API Management instance. We recommend the following *minimum* NSG rules to ensure proper operation and access to your instance. Review your environment carefully to determine more rules that might be needed.
11
+
Configure custom network security rules in the API Management subnet to filter traffic to and from your API Management instance. We recommend the following *minimum* NSG rules to ensure proper operation and access to your instance. Review your environment carefully to determine more rules that might be needed.
12
12
13
13
> [!IMPORTANT]
14
14
> Depending on your use of caching and other features, you may need to configure additional NSG rules beyond the minimum rules in the following table. For detailed settings, see [Virtual network configuration reference](../articles/api-management/virtual-network-reference.md#required-ports).
Copy file name to clipboardExpand all lines: includes/api-management-virtual-network-troubleshooting.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,7 +24,7 @@ ms.custom: sfi-image-nochange
24
24
### Verify network status
25
25
26
26
* After deploying API Management into the subnet, use the portal to check the connectivity of your instance to dependencies, such as Azure Storage.
27
-
* In the portal, in the left-hand menu, under **Deployment and infrastructure**, select **Network** > **Network status**.
27
+
* In the portal, in the sidebar menu, under **Deployment + infrastructure**, select **Network** > **Network status**.
28
28
29
29
:::image type="content" source="../articles/api-management/media/api-management-using-with-vnet/verify-network-connectivity-status.png" alt-text="Screenshot of verify network connectivity status in the portal." lightbox="../articles/api-management/media/api-management-using-with-vnet/verify-network-connectivity-status.png":::
0 commit comments