This browser is no longer supported.
Upgrade to Microsoft Edge to take advantage of the latest features, security updates, and technical support.
Note
Access to this page requires authorization. You can trysigning in orchanging directories.
Access to this page requires authorization. You can trychanging directories.
The article provides step-by-step instructions to publish events to Azure Event Grid in theCloudEvents JSON format and deliver those events by using the push delivery model. To be specific, you use Azure CLI and Curl to publish events to a namespace topic in Event Grid and push those events from an event subscription to an Event Hubs handler destination. For more information about the push delivery model, seePush delivery overview.
Note
The AzureCLI Event Grid extension doesn't yet support namespaces and any of the resources it contains. We will useAzure CLI resource to create Event Grid resources.
If you don't have an Azure account, create afree account before you begin.
Use the Bash environment inAzure Cloud Shell. For more information, seeQuickstart for Bash in Azure Cloud Shell.
If you prefer to run CLI reference commands locally,install the Azure CLI. If you're running on Windows or macOS, consider running Azure CLI in a Docker container. For more information, seeHow to run the Azure CLI in a Docker container.
If you're using a local installation, sign in to the Azure CLI by using theaz login command. To finish the authentication process, follow the steps displayed in your terminal. For other sign-in options, seeSign in with the Azure CLI.
When you're prompted, install the Azure CLI extension on first use. For more information about extensions, seeUse extensions with the Azure CLI.
Runaz version to find the version and dependent libraries that are installed. To upgrade to the latest version, runaz upgrade.
This article requires version 2.0.70 or later of the Azure CLI. If using Azure Cloud Shell, the latest version is already installed.
If this is the first time you're using Event Grid in your Azure subscription, you might need to register the Event Grid resource provider. Run the following command to register the provider:
az provider register --namespace Microsoft.EventGridIt might take a moment for the registration to finish. To check the status, run the following command:
az provider show --namespace Microsoft.EventGrid --query "registrationState"WhenregistrationState isRegistered, you're ready to continue.
Create an Azure resource group with theaz group create command. You use this resource group to contain all resources created in this article.
The general steps to use Cloud Shell to run commands are:
Declare a variable to hold the name of an Azure resource group. Specify a name for the resource group by replacing<your-resource-group-name> with a value you like.
resource_group="<your-resource-group-name>"location="<your-resource-group-location>"Create a resource group. Change the location as you see fit.
az group create --name $resource_group --location $locationAn Event Grid namespace provides a user-defined endpoint to which you post your events. The following example creates a namespace in your resource group using Bash in Azure Cloud Shell. The namespace name must be unique because it's part of a Domain Name System (DNS) entry. A namespace name should meet the following rules:
Microsoft,System, orEventGrid.Declare a variable to hold the name for your Event Grid namespace. Specify a name for the namespace by replacing<your-namespace-name> with a value you like.
namespace="<your-namespace-name>"Create a namespace. You might want to change the location where it's deployed.
az eventgrid namespace create -g $resource_group -n $namespace -l $locationCreate a topic that's used to hold all events published to the namespace endpoint.
Declare a variable to hold the name for your namespace topic. Specify a name for the namespace topic by replacing<your-topic-name> with a value you like.
topic="<your-topic-name>"Create your namespace topic:
az eventgrid namespace topic create -g $resource_group -n $topic --namespace-name $namespaceCreate an Event Hubs resource that is used as the handler destination for the namespace topic push delivery subscription.
Declare a variable to hold the Event Hubs namespace name.
eventHubsNamespace="<your-event-hubs-namespace-name>"Create the Event Hubs namespace.
az eventhubs namespace create --resource-group $resource_group --name $eventHubsNamespace --location $locationDeclare a variable to hold the event hub name.
eventHubsEventHub="<your-event-hub-name>"Run the following command to create an event hub in the namespace.
az eventhubs eventhub create --resource-group $resource_group --namespace-name $eventHubsNamespace --name $eventHubsEventHubTo deliver events to event hubs in your Event Hubs namespace using managed identity, follow these steps:
Enable system assigned managed identity in the Event Grid namespace.
az eventgrid namespace update --resource-group $resource_group --name $namespace --identity {type:systemassigned}Get Event Grid namespace system managed identity principal ID.
principalId=$(az eventgrid namespace show --resource-group $resource_group --name $namespace --query identity.principalId -o tsv)Get Event Hubs event hub resource ID.
eventHubResourceId=$(az eventhubs eventhub show --resource-group $resource_group --namespace-name $eventHubsNamespace --name $eventHubsEventHub --query id -o tsv)Add role assignment in Event Hubs for the Event Grid system managed identity.
az role assignment create --role "Azure Event Hubs Data Sender" --assignee $principalId --scope $eventHubResourceIdCreate a new push delivery event subscription.
event_subscription="<your_event_subscription_name>"az resource create --api-version 2023-06-01-preview --resource-group $resource_group --namespace Microsoft.EventGrid --resource-type eventsubscriptions --name $event_subscription --parent namespaces/$namespace/topics/$topic --location $location --properties "{\"deliveryConfiguration\":{\"deliveryMode\":\"Push\",\"push\":{\"maxDeliveryCount\":10,\"deliveryWithResourceIdentity\":{\"identity\":{\"type\":\"SystemAssigned\"},\"destination\":{\"endpointType\":\"EventHub\",\"properties\":{\"resourceId\":\"$eventHubResourceId\"}}}}}}"Now, send a sample event to the namespace topic by following steps in this section.
Get the access keys associated with the namespace you created. You use one of them to authenticate when publishing events. To list your keys, you need the full namespace resource ID first. Get it by running the following command:
namespace_resource_id=$(az eventgrid namespace show -g $resource_group -n $namespace --query "id" --output tsv)Get the first key from the namespace:
key=$(az eventgrid namespace list-key -g $resource_group --namespace-name $namespace --query "key1" --output tsv)Retrieve the namespace hostname. You use it to compose the namespace HTTP endpoint to which events are sent. The following operations were first available with API version2023-06-01-preview.
publish_operation_uri="https://"$(az eventgrid namespace show -g $resource_group -n $namespace --query "topicsConfiguration.hostname" --output tsv)"/topics/"$topic:publish?api-version=2023-06-01-previewCreate a sampleCloudEvents compliant event:
event=' { "specversion": "1.0", "id": "'"$RANDOM"'", "type": "com.yourcompany.order.ordercreatedV2", "source" : "/mycontext", "subject": "orders/O-234595", "time": "'`date +%Y-%m-%dT%H:%M:%SZ`'", "datacontenttype" : "application/json", "data":{ "orderId": "O-234595", "url": "https://yourcompany.com/orders/o-234595"}} 'Thedata element is the payload of your event. Any well-formed JSON can go in this field. For more information on properties (also known as context attributes) that can go in an event, see theCloudEvents specifications.
Use CURL to send the event to the topic. CURL is a utility that sends HTTP requests.
curl -X POST -H "Content-Type: application/cloudevents+json" -H "Authorization:SharedAccessKey $key" -d "$event" $publish_operation_uriNavigate to theEvent Hubs Namespace page in the Azure portal, refresh the page and verify that incoming messages counter in the chart indicates that an event has been received.
In this article, you created and configured the Event Grid namespace and Event Hubs resources. For step-by-step instructions to receive events from an event hub, see these tutorials:
Was this page helpful?
Need help with this topic?
Want to try using Ask Learn to clarify or guide you through this topic?
Was this page helpful?
Want to try using Ask Learn to clarify or guide you through this topic?