Skip to content

Commit 1d77164

Browse files
committed
Merge branch 'main' of https://github.com/MicrosoftDocs/azure-docs-pr into afd-toc2
2 parents dfc2aab + d0db27b commit 1d77164

File tree

43 files changed

+549
-257
lines changed

Some content is hidden

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

43 files changed

+549
-257
lines changed

articles/api-management/TOC.yml

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -204,24 +204,6 @@
204204
href: sap-api.md
205205
- name: Import gRPC API
206206
href: grpc-api.md
207-
- name: Azure OpenAI and LLM APIs
208-
items:
209-
- name: AI gateway capabilities in API Management
210-
href: genai-gateway-capabilities.md
211-
- name: Import Azure AI Foundry API
212-
href: azure-ai-foundry-api.md
213-
- name: Import Azure OpenAI API
214-
href: azure-openai-api-from-specification.md
215-
- name: Import OpenAI-compatible LLM API
216-
href: openai-compatible-llm-api.md
217-
- name: Authenticate and authorize to Azure OpenAI
218-
href: api-management-authenticate-authorize-azure-openai.md
219-
- name: Expose REST API as MCP server
220-
href: export-rest-mcp-server.md
221-
- name: Semantic caching for Azure OpenAI API requests
222-
href: azure-openai-enable-semantic-caching.md
223-
- name: Protect Azure OpenAI keys
224-
href: /semantic-kernel/deploy/use-ai-apis-with-api-management?toc=%2Fazure%2Fapi-management%2Ftoc.json&bc=/azure/api-management/breadcrumb/toc.json
225207
- name: Configure API for SSE
226208
href: how-to-server-sent-events.md
227209
- name: API import restrictions
@@ -250,6 +232,24 @@
250232
href: api-management-howto-cache.md
251233
- name: Custom caching
252234
href: api-management-sample-cache-by-key.md
235+
- name: API management for AI
236+
items:
237+
- name: AI gateway capabilities in API Management
238+
href: genai-gateway-capabilities.md
239+
- name: Import Azure AI Foundry API
240+
href: azure-ai-foundry-api.md
241+
- name: Import Azure OpenAI API
242+
href: azure-openai-api-from-specification.md
243+
- name: Import OpenAI-compatible LLM API
244+
href: openai-compatible-llm-api.md
245+
- name: Authenticate and authorize to Azure OpenAI
246+
href: api-management-authenticate-authorize-azure-openai.md
247+
- name: Expose REST API as MCP server
248+
href: export-rest-mcp-server.md
249+
- name: Semantic caching for Azure OpenAI API requests
250+
href: azure-openai-enable-semantic-caching.md
251+
- name: Protect Azure OpenAI keys
252+
href: /semantic-kernel/deploy/use-ai-apis-with-api-management?toc=%2Fazure%2Fapi-management%2Ftoc.json&bc=/azure/api-management/breadcrumb/toc.json
253253
- name: Manage APIs with policies
254254
items:
255255
- name: API Management policies overview

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

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ author: dlepow
66

77
ms.service: azure-api-management
88
ms.topic: how-to
9-
ms.date: 02/06/2024
9+
ms.date: 06/03/2025
1010
ms.author: danlep
1111
ms.custom: engagement-fy23
1212
---
@@ -22,7 +22,6 @@ The article walks through the process of configuring autoscale and suggests opti
2222
> [!NOTE]
2323
> * In service tiers that support multiple scale units, you can also [manually scale](upgrade-and-scale.md) your API Management instance.
2424
> * An API Management service in the **Consumption** tier scales automatically based on the traffic - without any additional configuration needed.
25-
> * Currently, autoscale is not supported for the [workspace gateway](workspaces-overview.md#workspace-gateway) in API Management workspaces.
2625
2726
[!INCLUDE [api-management-service-update-behavior](../../includes/api-management-service-update-behavior.md)]
2827

@@ -41,15 +40,15 @@ Certain limitations and consequences of scaling decisions need to be considered
4140

4241
+ The [pricing tier](api-management-features.md) of your API Management instance determines the [maximum number of units](upgrade-and-scale.md#upgrade-and-scale) you may scale to. For example, the **Standard tier** can be scaled to 4 units. You can add any number of units to the **Premium** tier.
4342
+ If the service is locked by another operation, the scaling request will fail and retry automatically.
44-
+ If your service instance is deployed in multiple regions (locations), only units in the **Primary location** can be autoscaled with Azure Monitor autoscale. Units in other locations can only be scaled manually.
45-
+ If your service instance is configured with [availability zones](zone-redundancy.md) in the **Primary location**, be aware of the number of zones when configuring autoscaling. The number of API Management units in autoscale rules and limits must be a multiple of the number of zones.
43+
+ If your service instance is deployed in multiple regions (locations), only units in the **Primary location** can be autoscaled with Azure Monitor autoscale. Units in other locations can be scaled manually or using custom scaling tools.
44+
+ If your service instance is configured with [availability zones](zone-redundancy.md) in the **Primary location**, we recommend leaving the default **Automatic** setting for availability zones. If you select specific zones, the number of API Management units in autoscale rules and limits must be a multiple of the number of zones configured.
4645

4746
## Enable and configure autoscale for an API Management instance
4847

4948
Follow these steps to configure autoscale for an Azure API Management service:
5049

5150
1. Sign in to the [Azure portal](https://portal.azure.com), and navigate to your API Management instance.
52-
1. In the left menu, select **Scale out (auto-scale)**, and then select **Custom autoscale**.
51+
1. In the left menu, select **Deployment + infrastructure** > **Scale out (auto-scale)**, and then select **Custom autoscale**.
5352

5453
:::image type="content" source="media/api-management-howto-autoscale/01.png" alt-text="Screenshot of scale-out options in the portal.":::
5554

articles/api-management/how-to-create-workspace.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ author: dlepow
55
ms.topic: how-to
66
ms.service: azure-api-management
77
ms.author: danlep
8-
ms.date: 05/14/2025
8+
ms.date: 06/03/2025
99
ms.custom:
1010
- build-2025
1111
---
@@ -56,7 +56,7 @@ Follow the steps in this article to:
5656
> [!IMPORTANT]
5757
> Plan your workspace's network configuration carefully. You can't change the network configuration after you create the workspace.
5858
59-
* If you select a network configuration that includes private inbound or private outbound network access, select a **Virtual network** and **Subnet** to isolate the workspace gateway, or create a new one. For network requirements, see [Network resource requirements for workspace gateways](virtual-network-workspaces-resources.md).
59+
* If you select either **Inbound public access, outbound private access** (virtual network integration) or **Inbound private access, outbound private access** (virtual network injection), select a **Virtual network** and **Subnet** to isolate the workspace gateway, or create a new one. For network requirements, see [Network resource requirements for workspace gateways](virtual-network-workspaces-resources.md).
6060

6161
1. Select **Next**. After validation completes, select **Create**.
6262

articles/api-management/index.yml

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -104,12 +104,14 @@ landingContent:
104104
linkLists:
105105
- linkListType: how-to-guide
106106
links:
107-
- text: Import API from Azure OpenAI service
107+
- text: Import Azure AI Foundry API
108+
url: azure-ai-foundry-api.md
109+
- text: Import Azure OpenAI API
108110
url: azure-openai-api-from-specification.md
109-
- text: Enable semantic caching for Azure OpenAI APIs
110-
url: azure-openai-enable-semantic-caching.md
111-
- text: Authenticate and authorize to Azure OpenAI APIs
112-
url: api-management-authenticate-authorize-azure-openai.md
111+
- text: Import OpenAI-compatible LLM API
112+
url: openai-compatible-llm-api.md
113+
- text: Expose REST API as MCP server
114+
url: export-rest-mcp-server.md
113115
- linkListType: concept
114116
links:
115117
- text: Premium v2 tier (preview)
-4.97 KB
Loading

articles/api-management/upgrade-and-scale.md

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

77
ms.service: azure-api-management
88
ms.topic: how-to
9-
ms.date: 07/02/2024
9+
ms.date: 06/03/2025
1010
ms.author: danlep
1111
ms.custom:
1212
- engagement-fy23
@@ -20,7 +20,7 @@ ms.custom:
2020
Customers can scale an Azure API Management instance in a dedicated service tier by adding and removing units. A **unit** is composed of dedicated Azure resources and has a certain load-bearing capacity expressed as a number of API calls per second. This number doesn't represent a call limit, but rather an estimated maximum throughput value to allow for rough capacity planning. Actual throughput and latency vary broadly depending on factors such as number and rate of concurrent connections, the kind and number of configured policies, request and response sizes, and backend latency.
2121

2222
> [!NOTE]
23-
> * In the **Basic**, **Standard**, and **Premium** tiers of the API Management service, you can configure an instance to [scale automatically](api-management-howto-autoscale.md) based on a set of rules.
23+
> * In the **Basic**, **Standard**, and **Premium** tiers of the API Management service, and in [workspace gateways](workspaces-overview.md#workspace-gateway), you can configure an instance to [scale automatically](api-management-howto-autoscale.md) based on a set of rules.
2424
> * API Management instances in the **Consumption** tier scale automatically based on the traffic. Currently, you cannot upgrade from or downgrade to the Consumption tier.
2525
2626
The throughput and price of each unit depend on the [service tier](api-management-features.md) in which the unit exists. If you need to increase capacity for a service within a tier, you should add a unit. If the tier that is currently selected in your API Management instance doesn't allow adding more units, you need to upgrade to a higher-level tier.

articles/api-management/virtual-network-workspaces-resources.md

Lines changed: 29 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,34 @@
11
---
22
title: Azure API Management workspace gateways - VNet integration - network resources
3-
description: Learn about requirements for network resources when you integrate your API Management workspace gateway in an Azure virtual network.
3+
description: Learn about requirements for network resources when you integrate or inject your API Management workspace gateway in an Azure virtual network.
44
author: dlepow
55

66
ms.service: azure-api-management
77
ms.topic: concept-article
8-
ms.date: 07/15/2024
8+
ms.date: 06/03/2025
99
ms.author: danlep
1010
---
1111

12-
# Network resource requirements for integration of a workspace gateway into a virtual network
12+
# Network resource requirements to integrate or inject a workspace gateway into a virtual network
1313

1414
[!INCLUDE [api-management-availability-premium](../../includes/api-management-availability-premium.md)]
1515

16-
Network isolation is an optional feature of an API Management [workspace gateway](workspaces-overview.md#workspace-gateway). This article provides network resource requirements when you integrate your gateway in an Azure virtual network. Some requirements differ depending on the desired inbound and outbound access mode. The following modes are supported:
16+
Network isolation is an optional feature of an API Management [workspace gateway](workspaces-overview.md#workspace-gateway). This article provides network resource requirements when you integrate or inject your gateway in an Azure virtual network. Some requirements differ depending on the desired inbound and outbound access mode. The following modes are supported:
1717

18-
* Public inbound access, private outbound access (Public/Private)
19-
* Private inbound access, private outbound access (Private/Private)
18+
* **Virtual network integration**: public inbound access, private outbound access
19+
* **Virtual network injection**: private inbound access, private outbound access
2020

21-
For information about networking options in API Management, see [Use a virtual network to secure inbound or outbound traffic for Azure API Management](virtual-network-concepts.md).
21+
For background about networking options in API Management, see [Use a virtual network to secure inbound or outbound traffic for Azure API Management](virtual-network-concepts.md).
2222

2323
[!INCLUDE [api-management-virtual-network-workspaces-alert](../../includes/api-management-virtual-network-workspaces-alert.md)]
2424

25-
2625
## Network location
2726

28-
* The virtual network must be in the same region and Azure subscription as the API Management instance.
27+
The virtual network must be in the same region and Azure subscription as the API Management instance.
2928

3029
### Dedicated subnet
3130

32-
* The subnet used for virtual network integration can only be used by a single workspace gateway. It can't be shared with another Azure resource.
31+
* The subnet used for virtual network integration or injection can only be used by a single workspace gateway. It can't be shared with another Azure resource.
3332

3433
## Subnet size
3534

@@ -42,19 +41,19 @@ The subnet must be delegated as follows to enable the desired inbound and outbou
4241

4342
For information about configuring subnet delegation, see [Add or remove a subnet delegation](../virtual-network/manage-subnet-delegation.md).
4443

45-
#### [Public/Private](#tab/external)
44+
#### [Virtual network integration](#tab/external)
4645

4746

48-
For Public/Private mode, the subnet needs to be delegated to the **Microsoft.Web/serverFarms** service.
47+
For virtual network integration, the subnet needs to be delegated to the **Microsoft.Web/serverFarms** service.
4948

5049
:::image type="content" source="media/virtual-network-injection-workspaces-resources/delegate-external.png" alt-text="Screenshot showing subnet delegation to Microsoft.Web/serverFarms in the portal.":::
5150

5251
> [!NOTE]
5352
> You might need to register the `Microsoft.Web/serverFarms` resource provider in the subscription so that you can delegate the subnet to the service.
5453
55-
#### [Private/Private](#tab/internal)
54+
#### [Virtual network injection](#tab/internal)
5655

57-
For Private/Private mode, the subnet needs to be delegated to the **Microsoft.Web/hostingEnvironments** service.
56+
For virtual network injection, the subnet needs to be delegated to the **Microsoft.Web/hostingEnvironments** service.
5857

5958
:::image type="content" source="media/virtual-network-injection-workspaces-resources/delegate-internal.png" alt-text="Screenshot showing subnet delegation to Microsoft.Web/hostingEnvironments in the portal.":::
6059

@@ -67,27 +66,30 @@ For Private/Private mode, the subnet needs to be delegated to the **Microsoft.We
6766

6867
## Network security group (NSG) rules
6968

70-
A network security group (NSG) must be attached to the subnet to explicitly allow inbound connectivity. Configure the following rules in the NSG. Set the priority of these rules higher than that of the default rules.
69+
A network security group (NSG) must be attached to the subnet to explicitly allow certain inbound or outbound connectivity. Configure the following rules in the NSG. Set the priority of these rules higher than that of the default rules.
70+
71+
Configure other NSG rules to meet your organization's network access requirements.
7172

72-
#### [Public/Private](#tab/external)
73+
#### [Virtual network integration](#tab/external)
7374

74-
| Source / Destination Port(s) | Direction | Transport protocol | Source | Destination | Purpose |
75-
|------------------------------|--------------------|--------------------|---------------------------------------|----------------------------------|-----------|
76-
| */80 | Inbound | TCP | AzureLoadBalancer | Workspace gateway subnet range | Allow internal health ping traffic |
77-
| */80,443 | Inbound | TCP | Internet | Workspace gateway subnet range | Allow inbound traffic |
75+
| Direction | Source | Source port ranges | Destination | Destination port ranges | Protocol | Action | Purpose |
76+
|-------|--------------|----------|---------|------------|-----------|-----|--------|
77+
| Inbound | AzureLoadBalancer | * | Workspace gateway subnet range | 80 | TCP | Allow | Allow internal health ping traffic |
78+
| Inbound | Internet | * | Workspace gateway subnet range | 80,443 | TCP | Allow | Allow inbound traffic |
7879

79-
#### [Private/Private](#tab/internal)
80+
#### [Virtual network injection](#tab/internal)
8081

81-
| Source / Destination Port(s) | Direction | Transport protocol | Source | Destination | Purpose |
82-
|------------------------------|--------------------|--------------------|---------------------------------------|----------------------------------|-----------|
83-
| */80 | Inbound | TCP | AzureLoadBalancer | Workspace gateway subnet range | Allow internal health ping traffic |
84-
| */80,443 | Inbound | TCP | Virtual network | Workspace gateway subnet range | Allow inbound traffic |
82+
| Direction | Source | Source port ranges | Destination | Destination port ranges | Protocol | Action | Purpose |
83+
|-------|--------------|----------|---------|------------|-----------|-----|--------|
84+
| Inbound | AzureLoadBalancer | * | Workspace gateway subnet range | 80 | TCP | Allow | Allow internal health ping traffic |
85+
| Inbound | VirtualNetwork | * | Workspace gateway subnet range | 80,443 | TCP | Allow | Allow inbound traffic |
86+
| Outbound | VirtualNetwork | * | Storage | 443 | TCP | Allow | Dependency on Azure Storage |
8587

8688
---
8789

88-
## DNS settings for Private/Private configuration
90+
## DNS settings for virtual network injection
8991

90-
In the Private/Private network configuration, you have to manage your own DNS to enable inbound access to your workspace gateway.
92+
For virtual network injection, you have to manage your own DNS to enable inbound access to your workspace gateway.
9193

9294
We recommend:
9395

articles/api-management/workspaces-overview.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ author: dlepow
66

77
ms.service: azure-api-management
88
ms.topic: concept-article
9-
ms.date: 05/14/2025
9+
ms.date: 06/03/2025
1010
ms.author: danlep
1111
#customer intent: As administrator of an API Management instance, I want to learn about using workspaces to manage APIs in a decentralized way, so that I can enable my development teams to manage and productize their own APIs.
1212
ms.custom:
@@ -112,7 +112,7 @@ For detailed requirements, see [Network resource requirements for workspace gate
112112

113113
### Scale capacity
114114

115-
Manage gateway capacity by manually adding or removing scale units, similar to the [units](upgrade-and-scale.md) that can be added to the API Management instance in certain service tiers. The costs of a workspace gateway are based on the number of units you select.
115+
Manage gateway capacity by adding or removing scale units, similar to the [units](upgrade-and-scale.md) that can be added to the API Management instance in certain service tiers. The costs of a workspace gateway are based on the number of units you select.
116116

117117
### Regional availability
118118

@@ -131,7 +131,6 @@ The following constraints currently apply to workspace gateways:
131131
* Workspace gateways don't support creating APIs directly from Azure resources such as Azure OpenAI Service, App Service, Function Apps, and so on
132132
* Request metrics can't be split by workspace in Azure Monitor; all workspace metrics are aggregated at the service level
133133
* Workspace gateways don't support CA certificates
134-
* Workspace gateways don't support autoscaling
135134
* Workspace gateways don't support managed identities, including related features like storing secrets in Azure Key Vault and using the `authentication-managed-identity` policy
136135

137136
## RBAC roles for workspaces

0 commit comments

Comments
 (0)