Skip to content

Files

Latest commit

dlepowdlepow
[APIM] Update VIP/DIP guidance
Apr 22, 2022
5626c81 · Apr 22, 2022

History

History
42 lines (25 loc) · 2.79 KB

api-management-virtual-network-prerequisites.md

File metadata and controls

42 lines (25 loc) · 2.79 KB
author ms.service ms.topic ms.date ms.author
dlepow
api-management
include
12/15/2021
danlep

Prerequisites

Some prerequisites differ depending on the version (stv2 or stv1) of the compute platform hosting your API Management instance.

Tip

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.

stv2

  • A virtual network and subnet in the same region and subscription as your API Management instance. A dedicated subnet is recommended but not required.

  • A network security group attached to the subnet above. A network security group (NSG) is required to explicitly allow inbound connectivity, because the load balancer used internally by API Management is secure by default and rejects all inbound traffic. For specific configuration, see Configure NSG rules, later in this article.

  • A Standard SKU public IPv4 address. The public IP address resource is required when setting up the virtual network for either external or internal access. With an internal virtual network, the public IP address is used only for management operations. Learn more about IP addresses of API Management.

    • The IP address must be in the same region and subscription as the API Management instance and the virtual network.

    • When creating a public IP resource, ensure you assign a DNS name label to it. The label you choose to use does not matter but a label is required if this resource will be assigned to an API Management service.

    • The value of the IP address is assigned as the virtual public IPv4 address of the API Management instance in that region.

    • When changing from an external to internal virtual network (or vice versa), changing subnets in the network, or updating availability zones for the API Management instance, you must configure a different public IP address.

stv1

  • A virtual network and subnet in the same region and subscription as your API Management instance.

    The subnet must be dedicated to API Management instances. Attempting to deploy an Azure API Management instance to a Resource Manager VNET subnet that contains other resources will cause the deployment to fail.