Skip to content

Commit b7c27a0

Browse files
huypubhuypub
authored
Merge pull request #269643 from MicrosoftDocs/release-ga-apim-v2-tiers
[DO NOT MERGE][APIM] Release-ga-apim-v2-tiers --> main
2 parents d45a01b + 524a4ad commit b7c27a0

File tree

270 files changed

+1524
-814
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

270 files changed

+1524
-814
lines changed

‎articles/api-management/TOC.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@
1212
href: api-management-key-concepts.md
1313
- name: API Management features availability
1414
href: api-management-features.md
15+
- name: API Management gateways
16+
href: api-management-gateways-overview.md
1517
- name: v2 service tiers
1618
href: v2-service-tiers-overview.md
1719
- name: Terminology
@@ -106,6 +108,8 @@
106108
items:
107109
- name: Networking options
108110
href: virtual-network-concepts.md
111+
- name: VNet injection - network requirements
112+
href: virtual-network-injection-resources.md
109113
- name: Deploy to a VNet - external
110114
href: api-management-using-with-vnet.md
111115
- name: Deploy to a VNet - internal
@@ -279,8 +283,6 @@
279283
href: configure-graphql-resolver.md
280284
- name: Manage APIs on-premises and in other clouds
281285
items:
282-
- name: API Management gateway overview
283-
href: api-management-gateways-overview.md
284286
- name: Self-hosted gateway overview
285287
href: self-hosted-gateway-overview.md
286288
- name: Deploy the gateway

‎articles/api-management/add-api-manually.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ ms.custom: fasttrack-edit, devdivchpfy22
1414

1515
# Add an API manually
1616

17+
[!INCLUDE [api-management-availability-all-tiers](../../includes/api-management-availability-all-tiers.md)]
18+
1719
This article shows steps to add an API manually to the API Management instance. When you want to mock the API, you can create a blank API or define it manually. For details about mocking an API, see [Mock API responses](mock-api-responses.md).
1820

1921
If you want to import an existing API, see [related topics](#related-topics) section.

‎articles/api-management/api-management-api-import-restrictions.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ ms.author: danlep
1313

1414
# API import restrictions and known issues
1515

16+
[!INCLUDE [api-management-availability-all-tiers](../../includes/api-management-availability-all-tiers.md)]
17+
1618
When importing an API, you might encounter some restrictions or need to identify and rectify issues before you can successfully import. In this article, you'll learn:
1719

1820
* API Management's behavior during OpenAPI import.

‎articles/api-management/api-management-authenticate-authorize-azure-openai.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ ms.author: danlep
1111

1212
# Authenticate and authorize access to Azure OpenAI APIs using Azure API Management
1313

14+
[!INCLUDE [api-management-availability-all-tiers](../../includes/api-management-availability-all-tiers.md)]
15+
1416
In this article, you learn about ways to authenticate and authorize to Azure OpenAI API endpoints that are managed using Azure API Management. This article shows the following common methods:
1517

1618
* **Authentication** - Authenticate to an Azure OpenAI API using policies that authenticate using either an API key or a Microsoft Entra ID managed identity.

‎articles/api-management/api-management-capacity.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ ms.custom: fasttrack-edit
1313

1414
# Capacity of an Azure API Management instance
1515

16+
[!INCLUDE [api-management-availability-premium-dev-standard-basic](../../includes/api-management-availability-premium-dev-standard-basic.md)]
17+
1618
**Capacity** is the most important [Azure Monitor metric](api-management-howto-use-azure-monitor.md#view-metrics-of-your-apis) for making informed decisions whether to [scale or upgrade](upgrade-and-scale.md) an API Management instance to accommodate more load. Its construction is complex and imposes certain behavior.
1719

1820
This article explains what the **capacity** is and how it behaves. It shows how to access **capacity** metrics in the Azure portal and suggests when to consider scaling or upgrading your API Management instance.

‎articles/api-management/api-management-configuration-repository-git.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ ms.author: danlep
1111
---
1212
# How to save and configure your API Management service configuration using Git
1313

14+
[!INCLUDE [premium-dev-standard-basic.md](../../includes/api-management-availability-premium-dev-standard-basic.md)]
15+
1416
Each API Management service instance maintains a configuration database that contains information about the configuration and metadata for the service instance. Changes can be made to the service instance by changing a setting in the Azure portal, using Azure tools such as Azure PowerShell or the Azure CLI, or making a REST API call. In addition to these methods, you can manage your service instance configuration using Git, enabling scenarios such as:
1517

1618
* **Configuration versioning** - Download and store different versions of your service configuration
@@ -36,10 +38,6 @@ This article describes how to enable and use Git to manage your service configur
3638
> [!IMPORTANT]
3739
> This feature is designed to work with small to medium API Management service configurations, such as those with an exported size less than 10 MB, or with fewer than 10,000 entities. Services with a large number of entities (products, APIs, operations, schemas, and so on) may experience unexpected failures when processing Git commands. If you encounter such failures, please reduce the size of your service configuration and try again. Contact Azure Support if you need assistance.
3840
39-
[!INCLUDE [premium-dev-standard-basic.md](../../includes/api-management-availability-premium-dev-standard-basic.md)]
40-
41-
42-
4341
## Access Git configuration in your service
4442

4543
1. Navigate to your API Management instance in the [Azure portal](https://portal.azure.com/).

‎articles/api-management/api-management-debug-policies.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,11 @@ ms.topic: article
77
ms.date: 09/22/2020
88
ms.author: danlep
99
---
10+
1011
# Debug Azure API Management policies in Visual Studio Code
1112

13+
[!INCLUDE [api-management-availability-developer](../../includes/api-management-availability-developer.md)]
14+
1215
[Policies](api-management-policies.md) in Azure API Management provide powerful capabilities that help API publishers address cross-cutting concerns such as authentication, authorization, throttling, caching, and transformation. Policies are a collection of statements that are executed sequentially on the request or response of an API.
1316

1417
This article describes how to debug API Management policies using the [Azure API Management Extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-apimanagement).
@@ -23,8 +26,6 @@ This article describes how to debug API Management policies using the [Azure API
2326

2427
## Restrictions and limitations
2528

26-
* This feature is only available in the **Developer** tier of API Management. Each API Management instance supports only one concurrent debugging session.
27-
2829
* This feature uses the built-in (service-level) all-access subscription (display name "Built-in all-access subscription") for debugging. The [**Allow tracing**](api-management-howto-api-inspector.md#verify-allow-tracing-setting) setting must be enabled in this subscription.
2930

3031
[!INCLUDE [api-management-tracing-alert](../../includes/api-management-tracing-alert.md)]

‎articles/api-management/api-management-error-handling-policies.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ ms.author: danlep
1212

1313
# Error handling in API Management policies
1414

15+
[!INCLUDE [api-management-availability-all-tiers](../../includes/api-management-availability-all-tiers.md)]
16+
1517
By providing a `ProxyError` object, Azure API Management allows publishers to respond to error conditions, which may occur during processing of requests. The `ProxyError` object is accessed through the [context.LastError](api-management-policy-expressions.md#ContextVariables) property and can be used by policies in the `on-error` policy section. This article provides a reference for the error handling capabilities in Azure API Management.
1618

1719
## Error handling in API Management

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

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -6,51 +6,51 @@ author: dlepow
66

77
ms.service: api-management
88
ms.topic: article
9-
ms.date: 06/27/2023
9+
ms.date: 03/13/2024
1010
ms.author: danlep
1111
---
1212

1313
# Feature-based comparison of the Azure API Management tiers
1414

15-
Each API Management [pricing tier](https://aka.ms/apimpricing) offers a distinct set of features and per unit [capacity](api-management-capacity.md). The following table summarizes the key features available in each of the tiers. Some features might work differently or have different capabilities depending on the tier. In such cases the differences are called out in the documentation articles describing these individual features.
15+
[!INCLUDE [api-management-availability-all-tiers](../../includes/api-management-availability-all-tiers.md)]
16+
17+
Each API Management [pricing tier](api-management-key-concepts.md#api-management-tiers) offers a distinct set of features and per unit [capacity](api-management-capacity.md). The following table summarizes the key features available in each of the tiers. Some features might work differently or have different capabilities depending on the tier. In such cases the differences are called out in the documentation articles describing these individual features.
1618

1719
> [!IMPORTANT]
1820
> * The Developer tier is for non-production use cases and evaluations. It doesn't offer SLA.
19-
> * The Consumption tier isn't available in the US Government cloud or the Microsoft Azure operated by 21Vianet cloud.
20-
> * API Management **v2 tiers** are now in preview, with updated feature availability. [Learn more](v2-service-tiers-overview.md).
21-
22-
23-
| Feature | Consumption | Developer | Basic | Standard | Premium |
24-
| -------------------------------------------------------------------------------------------- | ----------- | --------- | ----- | -------- | ------- |
25-
| Microsoft Entra integration<sup>1</sup> | No | Yes | No | Yes | Yes |
26-
| Virtual Network (VNet) support | No | Yes | No | No | Yes |
27-
| Private endpoint support for inbound connections | No | Yes | Yes | Yes | Yes |
28-
| Multi-region deployment | No | No | No | No | Yes |
29-
| Availability zones | No | No | No | No | Yes |
30-
| Multiple custom domain names | No | Yes | No | No | Yes |
31-
| Developer portal<sup>2</sup> | No | Yes | Yes | Yes | Yes |
32-
| Built-in cache | No | Yes | Yes | Yes | Yes |
33-
| Built-in analytics | No | Yes | Yes | Yes | Yes |
34-
| [Self-hosted gateway](self-hosted-gateway-overview.md)<sup>3</sup> | No | Yes | No | No | Yes |
35-
| [Workspaces](workspaces-overview.md) | No | No | No | No | Yes |
36-
| [TLS settings](api-management-howto-manage-protocols-ciphers.md) | Yes | Yes | Yes | Yes | Yes |
37-
| [External cache](./api-management-howto-cache-external.md) | Yes | Yes | Yes | Yes | Yes |
38-
| [Client certificate authentication](api-management-howto-mutual-certificates-for-clients.md) | Yes | Yes | Yes | Yes | Yes |
39-
| [Policies](api-management-howto-policies.md)<sup>4</sup> | Yes | Yes | Yes | Yes | Yes |
40-
| [API credentials](credentials-overview.md) | Yes | Yes | Yes | Yes | Yes |
41-
| [Backup and restore](api-management-howto-disaster-recovery-backup-restore.md) | No | Yes | Yes | Yes | Yes |
42-
| [Management over Git](api-management-configuration-repository-git.md) | No | Yes | Yes | Yes | Yes |
43-
| Direct management API | No | Yes | Yes | Yes | Yes |
44-
| Azure Monitor metrics | Yes | Yes | Yes | Yes | Yes |
45-
| Azure Monitor and Log Analytics request logs | No | Yes | Yes | Yes | Yes |
46-
| Application Insights request logs | Yes | Yes | Yes | Yes | Yes |
47-
| Static IP | No | Yes | Yes | Yes | Yes |
48-
| [Pass-through WebSocket APIs](websocket-api.md) | No | Yes | Yes | Yes | Yes |
49-
| [Pass-through GraphQL APIs](graphql-apis-overview.md) | Yes | Yes | Yes | Yes | Yes |
50-
| [Synthetic GraphQL APIs](graphql-apis-overview.md) | Yes | Yes | Yes | Yes | Yes |
51-
| [Pass-through gRPC APIs](grpc-api.md) (preview) | No | Yes | No | No | Yes |
21+
> * The Consumption tier isn't available in the US Government cloud or the Microsoft Azure operated by 21Vianet cloud.
22+
> * For information about APIs supported in the API Management gateway available in different tiers, see [API Management gateways overview](api-management-gateways-overview.md#backend-apis).
23+
24+
25+
| Feature | Consumption | Developer | Basic | Basic v2 |Standard | Standard v2 | Premium |
26+
| -------------------------------------------------------------------------------------------- | ----------- | --------- | --------- | --------- | ----- | -------- | ------- |
27+
| Microsoft Entra integration<sup>1</sup> | No | Yes | No | Yes | Yes | Yes | Yes |
28+
| Virtual Network (VNet) injection support | No | Yes | No | No | No | No | Yes |
29+
| Private endpoint support for inbound connections | No | Yes | Yes | No | Yes | No | Yes |
30+
| Outbound virtual network integration support | No | No | No | No | No | Yes | No |
31+
| Multi-region deployment | No | No | No | No | No | No | Yes |
32+
| Availability zones | No | No | No | No | No | No | Yes |
33+
| Multiple custom domain names for gateway | No | Yes | No | No | No | No | Yes |
34+
| Developer portal<sup>2</sup> | No | Yes | Yes | Yes | Yes | Yes | Yes |
35+
| Built-in cache | No | Yes | Yes | Yes | Yes | Yes | Yes |
36+
| [External cache](./api-management-howto-cache-external.md) | Yes | Yes | Yes | Yes | Yes | Yes |Yes |
37+
| Autoscaling | No | No | Yes | No | Yes | No |Yes |
38+
| API analytics | No | Yes | Yes | Yes | Yes | Yes | Yes |
39+
| [Self-hosted gateway](self-hosted-gateway-overview.md)<sup>3</sup> | No | Yes | No | No | No | No | Yes |
40+
| [Workspaces](workspaces-overview.md) | No | No | No | No | No | No | Yes |
41+
| [TLS settings](api-management-howto-manage-protocols-ciphers.md) | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
42+
| [Client certificate authentication](api-management-howto-mutual-certificates-for-clients.md) | Yes | Yes | Yes | Yes | Yes | Yes |Yes |
43+
| [Policies](api-management-howto-policies.md)<sup>4</sup> | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
44+
| [Credential manager](credentials-overview.md) | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
45+
| [Backup and restore](api-management-howto-disaster-recovery-backup-restore.md) | No | Yes | Yes | No | Yes | No | Yes |
46+
| [Management over Git](api-management-configuration-repository-git.md) | No | Yes | Yes |No | Yes | No | Yes |
47+
| Direct management API | No | Yes | Yes | No | Yes |No | Yes |
48+
| Azure Monitor metrics | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
49+
| Azure Monitor and Log Analytics request logs | No | Yes | Yes | Yes | Yes | Yes |Yes |
50+
| Application Insights request logs | Yes | Yes | Yes | Yes | Yes | Yes |Yes |
51+
| Static IP | No | Yes | Yes | No |Yes | No | Yes |
5252

5353
<sup>1</sup> Enables the use of Microsoft Entra ID (and Azure AD B2C) as an identity provider for user sign in on the developer portal.<br/>
5454
<sup>2</sup> Including related functionality such as users, groups, issues, applications, and email templates and notifications.<br/>
5555
<sup>3</sup> See [Gateway overview](api-management-gateways-overview.md#feature-comparison-managed-versus-self-hosted-gateways) for a feature comparison of managed versus self-hosted gateways. In the Developer tier self-hosted gateways are limited to a single gateway node. <br/>
56-
<sup>4</sup> See [Gateway overview](api-management-gateways-overview.md#policies) for differences in policy support in the dedicated, consumption, and self-hosted gateways. <br/>
56+
<sup>4</sup> See [Gateway overview](api-management-gateways-overview.md#policies) for differences in policy support in the classic, v2, consumption, and self-hosted gateways. <br/>

0 commit comments

Comments
 (0)