Skip to content

Commit 62d200e

Browse files
author
gitName
committed
PR review comments
1 parent fafe401 commit 62d200e

File tree

6 files changed

+10
-8
lines changed

6 files changed

+10
-8
lines changed

articles/api-management/how-to-event-grid.md

Lines changed: 4 additions & 4 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/06/2025
8+
ms.date: 05/07/2025
99
ms.custom: devx-track-azurecli
1010
---
1111

@@ -18,16 +18,16 @@ API Management integrates with [Azure Event Grid](../event-grid/overview.md) so
1818
You can subscribe to the following types of API Management events:
1919

2020
* **Control plane events**: These events are generated when you create, update, or delete certain API Management resources. For example, you can receive an event when a new user or new product is created in your API Management instance.
21-
* **Data plane events** (preview): These events are generated during operation of the API Management gateway. Currently, API Management can generate events for [backend circuit breakers](backends.md#circuit-breaker) and for the lifecycle of self-hosted gateway [authentication tokens](self-hosted-gateway-enable-azure-ad.md#).
21+
* **Data plane events** (preview): These events are generated during operation of the API Management gateway. Currently, API Management can generate events for [backend circuit breakers](backends.md#circuit-breaker) and for the lifecycle of self-hosted gateway [access tokens](self-hosted-gateway-overview.md#authentication-options).
2222

2323
For a complete list of available events, see the [Event Grid schema for API Management](../event-grid/event-schema-api-management.md).
2424

25+
:::image type="content" source="media/how-to-event-grid/event-grid-intro.png" alt-text="Diagram of API Management integration with Event Grid.":::
26+
2527
For example, using integration with Event Grid, you can build an application that updates a database, creates a billing account, and sends an email notification each time a user is added to your API Management instance.
2628

2729
In this article, you subscribe to Event Grid events in your API Management instance, trigger events, and send the events to an endpoint that processes the data. To keep it simple, you send events to a sample web app that collects and displays the messages:
2830

29-
:::image type="content" source="media/how-to-event-grid/event-grid-viewer-intro.png" alt-text="API Management events in Event Grid viewer":::
30-
3131
[!INCLUDE [azure-cli-prepare-your-environment.md](~/reusable-content/azure-cli/azure-cli-prepare-your-environment.md)]
3232
- If you don't already have an API Management service, complete the following quickstart: [Create an Azure API Management instance](get-started-create-service-instance.md)
3333
- Enable a [system-assigned managed identity](api-management-howto-use-managed-service-identity.md#create-a-system-assigned-managed-identity) in your API Management instance.
91.7 KB
Loading
Binary file not shown.

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

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -257,8 +257,6 @@ kubectl apply -f mygw.yaml
257257
* Learn more about the API Management [self-hosted gateway overview](self-hosted-gateway-overview.md).
258258
* Learn more about guidance for [running the self-hosted gateway on Kubernetes in production](how-to-self-hosted-gateway-on-kubernetes-in-production.md).
259259
* Learn [how to deploy API Management self-hosted gateway to Azure Arc-enabled Kubernetes clusters](how-to-deploy-self-hosted-gateway-azure-arc.md).
260-
* See [Azure API Management as an Event Grid source](/azure/event-grid/event-schema-api-management) for information about Event Grid events that are generated by a self-hosted gateway when a Microsoft Entra authentication token is near expiry or has expired. Use these events to ensure that deployed gateways are always able to authenticate with their associated API Management instance.
261-
262260

263261
[helm]: https://helm.sh/
264262
[helm-install]: https://helm.sh/docs/intro/install/

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,10 @@ To authenticate the connection between the self-hosted gateway and the cloud-bas
134134
| [Microsoft Entra authentication](self-hosted-gateway-enable-azure-ad.md) | Configure one or more Microsoft Entra apps for access to gateway<br/><br/>Manage access separately per app<br/><br/>Configure longer expiry times for secrets in accordance with your organization's policies<br/><br/>Use standard Microsoft Entra procedures to assign or revoke user or group permissions to app and to rotate secrets<br/><br/> |
135135
| Gateway access token (also called authentication key) | Token expires every 30 days at maximum and must be renewed in the containers<br/><br/>Backed by a gateway key that can be rotated independently (for example, to revoke access) <br/><br/>Regenerating gateway key invalidates all access tokens created with it |
136136

137+
> [!TIP]
138+
> See [Azure API Management as an Event Grid source](/azure/event-grid/event-schema-api-management) for information about Event Grid events that are generated by a self-hosted gateway when a gateway access token is near expiry or has expired. Use these events to ensure that deployed gateways are always able to authenticate with their associated API Management instance.
139+
140+
137141
### Connectivity failures
138142

139143
When connectivity to Azure is lost, the self-hosted gateway is unable to receive configuration updates, report its status, or upload telemetry.

articles/event-grid/event-schema-api-management.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@ API Management emits the following event types:
4343
| Microsoft.ApiManagement.GatewayHostnameConfigurationCreated | Raised when a hostname configuration is created for a self-hosted gateway. |
4444
| Microsoft.ApiManagement.GatewayHostnameConfigurationDeleted | Raised when a hostname configuration is deleted for a self-hosted gateway. |
4545
| Microsoft.ApiManagement.GatewayHostnameConfigurationUpdated | Raised when a hostname configuration is updated for a self-hosted gateway. |
46-
| Microsoft.ApiManagement.GatewayTokenNearExpiry (preview)| Raised when a self-hosted gateway authentication token is near expiry. |
47-
| Microsoft.ApiManagement.GatewayTokenExpired (preview) | Raised when a self-hosted gateway authentication token is expired. |
46+
| Microsoft.ApiManagement.GatewayTokenNearExpiry (preview)| Raised when a self-hosted gateway access token is near expiry. |
47+
| Microsoft.ApiManagement.GatewayTokenExpired (preview) | Raised when a self-hosted gateway access token is expired. |
4848
| Microsoft.ApiManagement.CircuitBreaker.Opened (preview) | Raised when a backend circuit breaker is opened. |
4949
| Microsoft.ApiManagement.CircuitBreaker.Closed (preview) | Raised when a backend circuit breaker is closed. |
5050

0 commit comments

Comments
 (0)