Merge pull request #306743 from MicrosoftDocs/main

Auto Publish – main to live - 2025-10-09 17:00 UTC

Author: learn-build-service-prod[bot]

articles/api-management/developer-portal-extend-custom-functionality.md

@@ -1,19 +1,19 @@
 ---
-title: Deploy an Azure API Management gateway on Azure Arc
+title: Deploy an Azure API Management Gateway on Azure Arc
 description: Enable Azure Arc to deploy your self-hosted Azure API Management gateway. 
 author: dlepow
 ms.author: danlep
 ms.service: azure-api-management
 ms.custom: devx-track-azurecli
 ms.topic: how-to 
-ms.date: 06/12/2023
+ms.date: 10/06/2025
 ---
 
 # Deploy an Azure API Management gateway on Azure Arc (preview)
 
 [!INCLUDE [api-management-availability-premium-dev](../../includes/api-management-availability-premium-dev.md)]
 
-With the integration between Azure API Management and [Azure Arc on Kubernetes](/azure/azure-arc/kubernetes/overview), you can deploy the API Management gateway component as an [extension in an Azure Arc-enabled Kubernetes cluster](/azure/azure-arc/kubernetes/extensions). 
+With the integration between Azure API Management and [Azure Arc on Kubernetes](/azure/azure-arc/kubernetes/overview), you can deploy the API Management gateway component as an [extension in an Azure Arc-enabled Kubernetes cluster](/azure/azure-arc/kubernetes/extensions).
 
 Deploying the API Management gateway on an Azure Arc-enabled Kubernetes cluster expands API Management support for hybrid and multicloud environments. Enable the deployment using a cluster extension to make managing and applying policies to your Azure Arc-enabled cluster a consistent experience.
 
@@ -30,21 +30,23 @@ Deploying the API Management gateway on an Azure Arc-enabled Kubernetes cluster
     ```azurecli
     az extension add --name k8s-extension
     ```
+
     If you've already installed the `k8s-extension` module, update to the latest version:
 
     ```azurecli
     az extension update --name k8s-extension
     ```
+
 * [Create an Azure API Management instance](./get-started-create-service-instance.md).
 * [Provision a gateway resource in your Azure API Management instance](./api-management-howto-provision-self-hosted-gateway.md).
 
 ## Deploy the API Management gateway extension using Azure CLI
 
 1. In the Azure portal, navigate to your API Management instance.
-1. Select **Gateways** from the side navigation menu.
+1. Select **Deployment + infrastructure** > **Gateways** from the side navigation menu.
 1. Select and open your provisioned gateway resource from the list.
 1. In your provisioned gateway resource, click **Deployment** from the side navigation menu.
-1. Make note of the **Token** and **Configuration URL** values for the next step.
+1. Make note of the **Token** and **Configuration endpoint** values for the next step.
 1. In Azure CLI, deploy the gateway extension using the `az k8s-extension create` command. Fill in the `token` and `configuration URL` values.
     * The following example uses the `service.type='LoadBalancer'` extension configuration. See more [available extension configurations](#available-extension-configurations).
 
@@ -61,17 +63,19 @@ Deploying the API Management gateway on an Azure Arc-enabled Kubernetes cluster
     > `-protected-` flag for `gateway.auth.token` is optional, but recommended. 
 
 1. Verify deployment status using the following CLI command:
+
     ```azurecli
     az k8s-extension show --cluster-type connectedClusters --cluster-name <cluster-name> --resource-group <rg-name> --name <extension-name>
     ```
+
 1. Navigate back to the **Gateways** list to verify the gateway status shows a green check mark with a node count. This status means the deployed self-hosted gateway pods:
     * Are successfully communicating with the API Management service.
     * Have a regular "heartbeat".
 
 ## Deploy the API Management gateway extension using Azure portal
 
 1. In the Azure portal, navigate to your Azure Arc-connected cluster.
-1. In the left menu, select **Extensions** > **+ Add** > **API Management gateway (preview)**.
+1. In the left menu, select **Settings** > **Extensions + applications** > **+ Add** > **API Management gateway (preview)**.
 1. Select **Create**.
 1. In the **Install API Management gateway** window, configure the gateway extension:
     * Select the subscription and resource group for your API Management instance.
@@ -81,7 +85,7 @@ Deploying the API Management gateway on an Azure Arc-enabled Kubernetes cluster
     :::image type="content" source="./media/how-to-deploy-self-hosted-gateway-azure-arc/deploy-gateway-extension-azure-arc.png" alt-text="Screenshot of deploying the extension in Azure portal":::
 
 1. On the **Monitoring** tab, optionally enable monitoring to upload metrics tracking requests to the gateway and backend. If enabled, select an existing **Log Analytics** workspace.
-1. Select **Review + install** and then **Install**.
+1. Select **Review + install**, then select **Install**.
 
 ## Available extension configurations
 
@@ -92,31 +96,32 @@ The self-hosted gateway extension for Azure Arc provides many configuration sett
 The following extension configurations are **required**.
 
 | Setting | Description |
-| ------- | ----------- | 
+| ------- | ----------- |
 | `gateway.configuration.uri` | Configuration endpoint in API Management service for the self-hosted gateway. |
-| `gateway.auth.token` | Gateway token (authentication key) to authenticate to API Management service. Typically starts with `GatewayKey`. | 
+| `gateway.auth.token` | Gateway token (authentication key) to authenticate to API Management service. Typically starts with `GatewayKey`. |
 | `service.type` | Kubernetes service configuration for the gateway: `LoadBalancer`, `NodePort`, or `ClusterIP`. |
 
 ### Log Analytics settings
 
 To enable monitoring of the self-hosted gateway, configure the following Log Analytics settings:
 
 | Setting | Description |
-| ------- | ----------- | 
+| ------- | ----------- |
 | `monitoring.customResourceId` | Azure Resource Manager resource ID for the API Management instance. |
-| `monitoring.workspaceId` | Workspace ID of Log Analytics. | 
+| `monitoring.workspaceId` | Workspace ID of Log Analytics. |
 | `monitoring.ingestionKey` | Secret with ingestion key from Log Analytics. |
 
 > [!NOTE]
-> If you haven't enabled Log Analytics: 
-> 1. Walk through the [Create a Log Analytics workspace](/azure/azure-monitor/logs/quick-create-workspace) quickstart. 
+> If you haven't enabled Log Analytics:
+>
+> 1. Walk through the [Create a Log Analytics workspace](/azure/azure-monitor/logs/quick-create-workspace) quickstart.
 > 1. Learn where to find the [Log Analytics agent settings](/azure/azure-monitor/agents/log-analytics-agent).
 
 ## Related content
 
 * To learn more about the self-hosted gateway, see [Azure API Management self-hosted gateway overview](self-hosted-gateway-overview.md).
 * Learn more about the [observability capabilities of the Azure API Management gateways](observability.md).
-* Discover all [Azure Arc-enabled Kubernetes extensions](/azure/azure-arc/kubernetes/extensions). 
+* Discover all [Azure Arc-enabled Kubernetes extensions](/azure/azure-arc/kubernetes/extensions).
 * Learn more about [Azure Arc-enabled Kubernetes](/azure/azure-arc/kubernetes/overview).
 * Learn more about guidance to [run the self-hosted gateway on Kubernetes in production](how-to-self-hosted-gateway-on-kubernetes-in-production.md).
-* For configuration options, see the self-hosted gateway extension [reference](self-hosted-gateway-arc-reference.md).
+* For configuration options, see the [self-hosted gateway extension reference](self-hosted-gateway-arc-reference.md).