| title | description | ms.topic | ms.date |
|---|---|---|---|
Authenticate event delivery to event handlers (Azure Event Grid) |
This article describes different ways of authenticating delivery to event handlers in Azure Event Grid. |
conceptual |
06/28/2021 |
This article provides information on authenticating event delivery to event handlers.
Azure Event Grid uses different authentication methods to deliver events to event handlers. `
| Authentication method | Supported handlers | Description |
|---|---|---|
| Access key | Event Hubs Service Bus Storage Queues Relay Hybrid Connections Azure Functions Storage Blobs (Deadletter) |
Access keys are fetched using Event Grid service principal's credentials. The permissions are granted to Event Grid when you register the Event Grid resource provider in their Azure subscription. |
| Managed System Identity & Role-based access control |
Event Hubs Service Bus Storage Queues Storage Blobs (Deadletter) |
Enable managed system identity for the topic and add it to the appropriate role on the destination. For details, see Use system-assigned identities for event delivery. |
| Bearer token authentication with Azure AD protected webhook | Webhook | See the Authenticate event delivery to webhook endpoints section for details.. |
| Client secret as a query parameter | Webhook | See the Using client secret as a query parameter section for details. |
Note
If you protect your Azure function with an Azure Active Directory app, you'll have to take the generic webhook approach using the HTTP trigger. Use the Azure function endpoint as a webhook URL when adding the subscription.
You can enable a system-assigned managed identity for a topic or domain and use the identity to forward events to supported destinations such as Service Bus queues and topics, event hubs, and storage accounts.
Here are the steps:
- Create a topic or domain with a system-assigned identity, or update an existing topic or domain to enable identity. For more information, see Enable managed identity for a system topic or Enable managed identity for a custom topic or a domain
- Add the identity to an appropriate role (for example, Service Bus Data Sender) on the destination (for example, a Service Bus queue). For more information, see Grand identity the access to Event Grid destination
- When you create event subscriptions, enable the usage of the identity to deliver events to the destination. For more information, see Create an event subscription that uses the identity.
For detailed step-by-step instructions, see Event delivery with a managed identity.
The following sections describe how to authenticate event delivery to webhook endpoints. Use a validation handshake mechanism irrespective of the method you use. See Webhook event delivery for details.
You can secure the webhook endpoint that's used to receive events from Event Grid by using Azure AD. You'll need to create an Azure AD application, create a role and service principal in your application authorizing Event Grid, and configure the event subscription to use the Azure AD application. Learn how to Configure Azure Active Directory with Event Grid.
You can also secure your webhook endpoint by adding query parameters to the webhook destination URL specified as part of creating an Event Subscription. Set one of the query parameters to be a client secret such as an access token or a shared secret. Event Grid service includes all the query parameters in every event delivery request to the webhook. The webhook service can retrieve and validate the secret. If the client secret is updated, event subscription also needs to be updated. To avoid delivery failures during this secret rotation, make the webhook accept both old and new secrets for a limited duration before updating the event subscription with the new secret.
As query parameters could contain client secrets, they are handled with extra care. They are stored as encrypted and are not accessible to service operators. They are not logged as part of the service logs/traces. When retrieving the Event Subscription properties, destination query parameters aren't returned by default. For example: --include-full-endpoint-url parameter is to be used in Azure CLI.
For more information on delivering events to webhooks, see Webhook event delivery
Important
Azure Event Grid only supports HTTPS webhook endpoints.
If you're already familiar with Event Grid, you might be aware of the endpoint validation handshake for preventing abuse. CloudEvents v1.0 implements its own abuse protection semantics by using the HTTP OPTIONS method. To read more about it, see HTTP 1.1 Web Hooks for event delivery - Version 1.0. When you use the CloudEvents schema for output, Event Grid uses the CloudEvents v1.0 abuse protection in place of the Event Grid validation event mechanism. For more information, see Use CloudEvents v1.0 schema with Event Grid.
See Authenticate publishing clients to learn about authenticating clients publishing events to topics or domains.