Skip to content

Commit 631d428

Browse files
authored
Merge pull request #250524 from MicrosoftDocs/release-preview-apim-skuv2
[READY TO MERGE] [APIM] Release preview apim skuv2 -> main
2 parents 2a8f529 + b98a79a commit 631d428

25 files changed

+1155
-48
lines changed

articles/api-management/TOC.yml

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77
href: api-management-key-concepts.md
88
- name: API Management features availability
99
href: api-management-features.md
10+
- name: v2 service tiers
11+
href: v2-service-tiers-overview.md
1012
- name: Service limits
1113
href: ../azure-resource-manager/management/azure-subscription-service-limits.md?toc=%2Fazure%2Fapi-management%2Ftoc.json&bc=/azure/api-management/breadcrumb/toc.json#api-management-limits
1214
- name: Quickstarts
@@ -163,17 +165,19 @@
163165
displayName: soft delete
164166
href: soft-delete.md
165167
- name: Migrate to stv2 platform
166-
href: migrate-stv1-to-stv2.md
168+
href: migrate-stv1-to-stv2.md
167169
- name: Configure networking
168170
items:
169-
- name: Connect to a virtual network
171+
- name: Deploy to a VNet - external
170172
href: api-management-using-with-vnet.md
171-
- name: Connect to an internal virtual network
173+
- name: Deploy to a VNet - internal
172174
href: api-management-using-with-internal-vnet.md
173-
- name: Integrate Application Gateway in an internal virtual network
175+
- name: Integrate Application Gateway in an internal VNet
174176
href: api-management-howto-integrate-internal-vnet-appgateway.md
175177
- name: Connect privately using private endpoint
176178
href: private-endpoint.md
179+
- name: Integrate with VNet for outbound requests
180+
href: integrate-vnet-outbound.md
177181
- name: Retrieve IP addresses
178182
href: api-management-howto-ip-addresses.md
179183
- name: Defend against DDoS attacks
@@ -251,7 +255,7 @@
251255
href: import-api-from-odata.md
252256
- name: Import SAP OData metadata
253257
href: sap-api.md
254-
- name: Configure API for SSE
258+
- name: Configure API for SSE
255259
href: how-to-server-sent-events.md
256260
- name: API import restrictions
257261
href: api-management-api-import-restrictions.md

articles/api-management/api-management-features.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,9 @@ Each API Management [pricing tier](https://aka.ms/apimpricing) offers a distinct
1717

1818
> [!IMPORTANT]
1919
> * The Developer tier is for non-production use cases and evaluations. It doesn't offer SLA.
20-
> * The Consumption tier isn't available in the US Government cloud or the Microsoft Azure operated by 21Vianet cloud.
20+
> * The Consumption tier isn't available in the US Government cloud or the Microsoft Azure operated by 21Vianet cloud.
21+
> * API Management **v2 tiers** are now in preview, with updated feature availability. [Learn more](v2-service-tiers-overview.md).
22+
2123

2224
| Feature | Consumption | Developer | Basic | Standard | Premium |
2325
| -------------------------------------------------------------------------------------------- | ----------- | --------- | ----- | -------- | ------- |

articles/api-management/api-management-gateways-overview.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ Related information:
2121

2222
* For more information about the API Management service tiers and features, see [Feature-based comparison of the Azure API Management tiers](api-management-features.md).
2323

24+
[!INCLUDE [api-management-v2-tier-preview](../../includes/api-management-v2-tier-preview.md)]
25+
2426
## Role of the gateway
2527

2628
The API Management *gateway* (also called *data plane* or *runtime*) is the service component that's responsible for proxying API requests, applying policies, and collecting telemetry.

articles/api-management/api-management-howto-cache.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,9 @@ What you'll learn:
3737

3838
> [!NOTE]
3939
> Internal cache is not available in the **Consumption** tier of Azure API Management. You can [use an external Azure Cache for Redis](api-management-howto-cache-external.md) instead.
40+
>
41+
> For feature availability in the v2 tiers (preview), see the [v2 tiers overview](v2-service-tiers-overview.md).
42+
4043

4144
## Prerequisites
4245

articles/api-management/api-management-howto-developer-portal-customize.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
title: Tutorial - Access and customize the developer portal - Azure API Management | Microsoft Docs
3-
description: Follow this to tutorial to learn how to customize the API Management developer portal, an automatically generated, fully customizable website with the documentation of your APIs.
3+
description: In this tutorial, customize the API Management developer portal, an automatically generated, fully customizable website with the documentation of your APIs.
44
services: api-management
55
author: dlepow
66

77
ms.service: api-management
88
ms.topic: tutorial
9-
ms.date: 11/21/2022
9+
ms.date: 09/06/2023
1010
ms.author: danlep
1111
ms.custom: engagement-fy23
1212
---
@@ -40,8 +40,12 @@ You can find more details on the developer portal in the [Azure API Management d
4040
Follow the steps below to access the managed version of the portal.
4141

4242
1. In the [Azure portal](https://portal.azure.com), navigate to your API Management instance.
43-
1. Select the **Developer portal** button in the top navigation bar. A new browser tab with an administrative version of the portal will open.
44-
43+
1. If you created your instance in a v2 service tier that supports the developer portal, first enable the developer portal.
44+
1. In the left menu, under **Developer portal**, select **Portal settings**.
45+
1. In the **Portal settings** window, select **Enabled**. Select **Save**.
46+
47+
It might take a few minutes to enable the developer portal.
48+
1. In the left menu, under **Developer portal**, select **Portal overview**. Then select the **Developer portal** button in the top navigation bar. A new browser tab with an administrative version of the portal will open.
4549

4650
## Developer portal architectural concepts
4751

articles/api-management/api-management-howto-manage-protocols-ciphers.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ By default, API Management enables TLS 1.2 for client and backend connectivity a
2222

2323
:::image type="content" source="media/api-management-howto-manage-protocols-ciphers/api-management-protocols-ciphers.png" alt-text="Screenshot of managing protocols and ciphers in the Azure portal.":::
2424

25+
[!INCLUDE [api-management-v2-tier-preview](../../includes/api-management-v2-tier-preview.md)]
2526

2627
> [!NOTE]
2728
> * If you're using the self-hosted gateway, see [self-hosted gateway security](self-hosted-gateway-overview.md#security) to manage TLS protocols and cipher suites.

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

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Connect to an internal virtual network using Azure API Management
3-
description: Learn how to set up and configure Azure API Management in a virtual network using internal mode
2+
title: Deploy Azure API Management instance to internal VNet
3+
description: Learn how to deploy (inject) your Azure API instance to a virtual network in internal mode and access API backends through it.
44
author: dlepow
55

66
ms.service: api-management
@@ -9,8 +9,9 @@ ms.date: 01/03/2022
99
ms.author: danlep
1010
---
1111

12-
# Connect to a virtual network in internal mode using Azure API Management
13-
With Azure virtual networks (VNets), Azure API Management can manage internet-inaccessible APIs using several VPN technologies to make the connection. For VNet connectivity options, requirements, and considerations, see [Using a virtual network with Azure API Management](virtual-network-concepts.md).
12+
# Deploy your Azure API Management instance to a virtual network - internal mode
13+
14+
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 [Using a virtual network with Azure API Management](virtual-network-concepts.md).
1415

1516
This article explains how to set up VNet connectivity for your API Management instance in the *internal* mode. In this mode, you can only access the following API Management endpoints within a VNet whose access you control.
1617
* The API gateway
@@ -30,7 +31,7 @@ Use API Management in internal mode to:
3031

3132
:::image type="content" source="media/api-management-using-with-internal-vnet/api-management-vnet-internal.png" alt-text="Connect to internal VNet":::
3233

33-
For configurations specific to the *external* mode, where the API Management endpoints are accessible from the public internet, and backend services are located in the network, see [Connect to a virtual network using Azure API Management](api-management-using-with-vnet.md).
34+
For configurations specific to the *external* mode, where the API Management endpoints are accessible from the public internet, and backend services are located in the network, see [Deploy your Azure API Management instance to a virtual network - external mode](api-management-using-with-vnet.md).
3435

3536
[!INCLUDE [updated-for-az](../../includes/updated-for-az.md)]
3637

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Connect to a virtual network using Azure API Management
3-
description: Learn how to set up a connection to a virtual network in Azure API Management and access API backends through it.
2+
title: Deploy Azure API Management instance to external VNet
3+
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

@@ -9,15 +9,15 @@ ms.topic: how-to
99
ms.date: 01/03/2022
1010
ms.author: danlep
1111
---
12-
# Connect to a virtual network using Azure API Management
12+
# Deploy your Azure API Management instance to a virtual network - external mode
1313

14-
Azure API Management can be deployed inside an Azure virtual network (VNet) to access backend services within the network. For VNet connectivity options, requirements, and considerations, see [Using a virtual network with Azure API Management](virtual-network-concepts.md).
14+
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 [Using a virtual network with Azure API Management](virtual-network-concepts.md).
1515

1616
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.
1717

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

20-
For configurations specific to the *internal* mode, where the endpoints are accessible only within the VNet, see [Connect to an internal virtual network using Azure API Management](./api-management-using-with-internal-vnet.md).
20+
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).
2121

2222
[!INCLUDE [updated-for-az](../../includes/updated-for-az.md)]
2323

articles/api-management/compute-infrastructure.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Learn about the compute platform used to host your API Management s
44
author: dlepow
55
ms.service: api-management
66
ms.topic: conceptual
7-
ms.date: 04/17/2023
7+
ms.date: 09/18/2023
88
ms.author: danlep
99
ms.custom:
1010
---
@@ -19,7 +19,7 @@ Most new instances created in service tiers other than the Consumption tier are
1919

2020
## What are the compute platforms for API Management?
2121

22-
The following table summarizes the compute platforms currently used for instances in the different API Management service tiers.
22+
The following table summarizes the compute platforms currently used in the **Consumption**, **Developer**, **Basic**, **Standard**, and **Premium** tiers of API Management.
2323

2424
| Version | Description | Architecture | Tiers |
2525
| -------| ----------| ----------- | ---- |
@@ -64,6 +64,12 @@ The `stv2` platform infrastructure supports several resiliency and security feat
6464
6565
Migration steps depend on features enabled in your API Management instance. If the instance isn't injected in a VNet, you can use a migration API. For instances that are VNet-injected, follow manual steps. For details, see the [migration guide](migrate-stv1-to-stv2.md).
6666

67+
## What about the v2 pricing tiers?
68+
69+
The v2 pricing tiers are a new set of tiers for API Management currently in preview. Hosted on a new, highly scalable and available Azure infrastructure that's different from the `stv1` and `stv2` compute platforms, the v2 tiers aren't affected by the retirement of the `stv1` platform.
70+
71+
The v2 tiers are designed to make API Management accessible to a broader set of customers and offer flexible options for a wider variety of scenarios. For more information, see [v2 tiers overview](v2-service-tiers-overview.md).
72+
6773
## Next steps
6874

6975
* [Migrate an API Management instance to the stv2 platform](migrate-stv1-to-stv2.md).
Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
title: Connect API Management instance to a private network | Microsoft Docs
3+
description: Learn how to integrate an Azure API Management instance in the Standard v2 tier with a virtual network to access backend APIs hosted within the network.
4+
author: dlepow
5+
ms.author: danlep
6+
ms.service: api-management
7+
ms.topic: how-to
8+
ms.date: 09/20/2023
9+
---
10+
11+
# Integrate an Azure API Management instance with a private VNet for outbound connections (preview)
12+
13+
This article guides you through the process of configuring *VNet integration* for your Azure API Management instance so that your API Management instance can make outbound requests to API backends that are isolated in the network.
14+
15+
When an API Management instance is integrated with a virtual network for outbound requests, the API Management itself is not deployed in a VNet; the gateway and other endpoints remain publicly accessible. In this configuration, the API Management instance can reach both public and network-isolated backend services.
16+
17+
:::image type="content" source="./media/integrate-vnet-outbound/vnet-integration.svg" alt-text="Diagram of integrating API Management instance with a delegated subnet." :::
18+
19+
[!INCLUDE [api-management-availability-standard-v2](../../includes/api-management-availability-standard-v2.md)]
20+
21+
## Prerequisites
22+
23+
- An Azure API Management instance in the [Standard v2](v2-service-tiers-overview.md) pricing tier
24+
- A virtual network with a subnet where your API Management backend APIs are hosted
25+
- The network must be deployed in the same region as your API Management instance
26+
- (Optional) For testing, a sample backend API hosted within a different subnet in the virtual network. For example, see [Tutorial: Establish Azure Functions private site access](../azure-functions/functions-create-private-site-access.md).
27+
28+
## Delegate the subnet
29+
30+
The subnet used for integration must be delegated to the **Microsoft.Web/serverFarms** service. In the subnet settings, in **Delegate subnet to a service**, select **Microsoft.Web/serverFarms**.
31+
32+
:::image type="content" source="media/integrate-vnet-outbound/delegate-subnet.png" alt-text="Screenshot of delegating the subnet to a service in the portal.":::
33+
34+
For details, see [Add or remove a subnet delegation](../virtual-network/manage-subnet-delegation.md).
35+
36+
## Enable VNet integration
37+
38+
This section will guide you through the process of enabling VNet integration for your Azure API Management instance.
39+
40+
1. In the [Azure portal](https://portal.azure.com), navigate to your API Management instance.
41+
1. In the left menu, under **Deployment + Infrastructure**, select **Network**.
42+
1. On the **Outbound traffic** card, select **VNET integration**.
43+
44+
:::image type="content" source="media/integrate-vnet-outbound/integrate-vnet.png" lightbox="media/integrate-vnet-outbound/integrate-vnet.png" alt-text="Screenshot of VNet integration in the portal.":::
45+
46+
1. In the **Virtual network** blade, enable the **Virtual network** checkbox.
47+
1. Select the location of your API Management instance.
48+
1. In **Virtual network**, select the virtual network and the delegated subnet that you want to integrate.
49+
1. Select **Apply**, and then select **Save**. The VNet is integrated.
50+
51+
:::image type="content" source="media/integrate-vnet-outbound/vnet-settings.png" lightbox="media/integrate-vnet-outbound/vnet-settings.png" alt-text="Screenshot of VNet settings in the portal.":::
52+
53+
## (Optional) Test VNet integration
54+
55+
If you have an API hosted in the virtual network, you can import it to your Management instance and test the VNet integration. For basic steps, see [Import and publish an API](import-and-publish.md).
56+
57+
58+
## Related content
59+
60+
* [Use a virtual network with Azure API Management](virtual-network-concepts.md)
61+
62+
63+

0 commit comments

Comments
 (0)