Skip to content

Commit a6209fc

Browse files
committed
PR review
1 parent 2a607ea commit a6209fc

6 files changed

Lines changed: 17 additions & 13 deletions

articles/api-management/how-to-deploy-self-hosted-gateway-azure-arc.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ ms.service: azure-api-management
77
ms.custom: devx-track-azurecli
88
ms.topic: how-to
99
ms.date: 10/06/2025
10+
ms.custom: references_regions
1011
---
1112

1213
# Deploy an Azure API Management gateway on Azure Arc (preview)

articles/api-management/how-to-self-hosted-gateway-on-kubernetes-in-production.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,15 @@ In order to run the self-hosted gateway in production, there are various aspects
1919

2020
This article provides guidance on how to run [self-hosted gateway](./self-hosted-gateway-overview.md) on Kubernetes for production workloads to ensure that it will run smoothly and reliably.
2121

22-
## Access token
22+
## Authentication
2323

2424
By default, an access token (also called an authentication key) is used by the self-hosted gateway to authenticate with the API Management instance.
2525

2626
Without a valid access token, a self-hosted gateway can't access and download configuration data from the endpoint of the associated API Management service. The access token can be valid for a maximum of 30 days. It must be regenerated, and the cluster configured with a fresh token, either manually or via automation before it expires.
2727

2828
When you're automating token refresh, use [this management API operation](/rest/api/apimanagement/current-ga/gateway/generate-token) to generate a new token. For information on managing Kubernetes secrets, see the [Kubernetes website](https://kubernetes.io/docs/concepts/configuration/secret).
2929

30-
You can also deploy the self-hosted gateway to Kubernetes and enable authentication to the API Management instance by using Microsoft Entra ID. For more information, see [Self-hosted gateway authentication options](self-hosted-gateway-authentication-options.md).
30+
You can also deploy the self-hosted gateway to Kubernetes and enable authentication to the API Management instance by using Microsoft Entra ID. For more information and considerations, see [Self-hosted gateway authentication options](self-hosted-gateway-authentication-options.md).
3131

3232
## Autoscaling
3333

@@ -50,7 +50,7 @@ Kubernetes allows you to autoscale the self-hosted gateway based on resource usa
5050
An alternative is to use Kubernetes Event-driven Autoscaling (KEDA) allowing you to scale workloads based on a [variety of scalers](https://keda.sh/docs/latest/scalers/), including CPU and memory.
5151

5252
> [!TIP]
53-
> If you are already using KEDA to scale other workloads, we recommend using KEDA as a unified app autoscaler. If that is not the case, then we strongly suggest to rely on the native Kubernetes functionality through Horizontal Pod Autoscaler.
53+
> If you are already using KEDA to scale other workloads, we recommend using KEDA as a unified app autoscaler. If that is not the case, then we strongly suggest relying on the native Kubernetes functionality through Horizontal Pod Autoscaler.
5454
5555
### Traffic-based autoscaling
5656

articles/api-management/self-hosted-gateway-authentication-options.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Authentication Options for API Management Self-hosted Gateway
2+
title: Authentication Options for Self-hosted Gateway - Azure API Management
33
description: Options for the Azure API Management self-hosted gateway to authenticate to the cloud-based API Management instance.
44
services: api-management
55
author: dlepow
@@ -12,7 +12,11 @@ ms.author: danlep
1212

1313
# Self-hosted gateway authentication options
1414

15-
The gateway container's [configuration settings](self-hosted-gateway-settings-reference.md) provide the following options for authenticating the connection between the self-hosted gateway and the cloud-based API Management instance's configuration endpoint.
15+
The gateway container's [configuration settings](self-hosted-gateway-settings-reference.md) provide options for authenticating the connection between the self-hosted gateway and the cloud-based API Management instance's configuration endpoint.
16+
17+
### Options and considerations
18+
19+
THe following table lists authentication options for the self-hosted gateway and considerations for each option. The linked articles provide step-by-step instructions for how to configure each authentication method.
1620

1721
|Option |Considerations |
1822
|---------|---------|

articles/api-management/self-hosted-gateway-enable-azure-ad.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,10 +59,10 @@ Create a new Microsoft Entra app. For steps, see [Create a Microsoft Entra appli
5959
6060
#### Step 2: Assign API Management Gateway Configuration Reader Service Role
6161

62-
[Assign](../active-directory/develop/howto-create-service-principal-portal.md#assign-a-role-to-the-application) the API Management Gateway Configuration Reader Service Role to the app.
62+
[Assign](../active-directory/develop/howto-create-service-principal-portal.md#assign-a-role-to-the-application) the API Management Gateway Configuration Reader Service role to the app.
6363

6464
- Scope: The API Management instance (or resource group or subscription in which the app is deployed)
65-
- Role: API Management Gateway Configuration Reader Role
65+
- Role: API Management Gateway Configuration Reader role
6666
- Assign access to: Microsoft Entra app
6767

6868
## Deploy the self-hosted gateway
@@ -73,7 +73,7 @@ Deploy the self-hosted gateway to a containerized environment, such as Kubernete
7373

7474
You can deploy the self-hosted gateway with Microsoft Entra authentication by using a [Helm chart](https://github.com/Azure/api-management-self-hosted-gateway).
7575

76-
Replace the following values in the the `helm install` command with your actual values:
76+
Replace the following values in the `helm install` command with your actual values:
7777

7878
- `<gateway-name>`: Your Azure API Management instance name
7979
- `<gateway-url>`: The URL of your gateway, in the format `https://<gateway-name>.configuration.azure-api.net`

articles/api-management/self-hosted-gateway-enable-workload-identity.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ To enable workload identity authentication, complete the following steps:
5454

5555
<a name='step-1-register-azure-ad-app-and-configure-workload-identity'></a>
5656

57-
#### Step 1: Register Microsoft Entra app and configure workload identity
57+
#### Step 1: Register the Microsoft Entra app and configure workload identity
5858

5959
Create a new Microsoft Entra app. For steps, see [Create a Microsoft Entra application and service principal that can access resources](../active-directory/develop/howto-create-service-principal-portal.md). The Microsoft Entra app is used by the self-hosted gateway to authenticate to the API Management instance.
6060

@@ -77,12 +77,12 @@ Next, configure federated identity credentials to establish trust between your M
7777

7878
For more information, see [Configure a federated identity credential on an app](/entra/workload-id/workload-identity-federation-create-trust).
7979

80-
#### Step 2: Assign API Management Gateway Configuration Reader Service Role
80+
#### Step 2: Assign API Management Gateway Configuration Reader Service role
8181

82-
[Assign](../active-directory/develop/howto-create-service-principal-portal.md#assign-a-role-to-the-application) the API Management Gateway Configuration Reader Service Role to the app.
82+
[Assign](../active-directory/develop/howto-create-service-principal-portal.md#assign-a-role-to-the-application) the API Management Gateway Configuration Reader Service role to the app.
8383

8484
- Scope: The API Management instance (or resource group or subscription in which the app is deployed)
85-
- Role: API Management Gateway Configuration Reader Role
85+
- Role: API Management Gateway Configuration Reader role
8686
- Assign access to: Microsoft Entra app
8787

8888
## Deploy the self-hosted gateway

articles/api-management/self-hosted-gateway-overview.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,6 @@ With v2.1.1 and later, you can manage the ciphers that are being used via config
215215

216216
- [API gateway overview](api-management-gateways-overview.md)
217217
- [Support policy for self-hosted gateway](self-hosted-gateway-support-policies.md)
218-
- [API Management in a hybrid and multicloud world](https://aka.ms/hybrid-and-multi-cloud-api-management)
219218
- [Guidance for running self-hosted gateway on Kubernetes in production](how-to-self-hosted-gateway-on-kubernetes-in-production.md)
220219
- [Deploy a self-hosted gateway to Docker](how-to-deploy-self-hosted-gateway-docker.md)
221220
- [Deploy a self-hosted gateway to Kubernetes](how-to-deploy-self-hosted-gateway-kubernetes.md)

0 commit comments

Comments
 (0)