The recent announcement of first-class support for CloudEvents with Azure Event Grid is very exciting. The release emphasizes Microsoft’s dedication to an open-standard for defining event data in a consistent manner – across all clouds and platforms.
In this blog post we’ll take a look at how to publish events to Event Grid using the CloudEvents schema. We’ll also create an Azure Function (v2) that subscribes to those events and receives them using the same definition.
The key takeaway, and perhaps the most important element; will be that the schema used for these examples will be from the open-standard defined by the Serverless Working Group. The event format can be reviewed at the following repository: https://github.com/cloudevents/spec/blob/master/json-format.md
All the code from this post can be found at: https://github.com/dbarkol/cloud-events
Let’s start by setting up a few things in Azure, the first of which is enabling the CloudEvents CLI extension. From the Cloud Shell in the Azure Portal, run the following command:
az extension add –-name eventgrid
This will provide us with support for CloudEvents when creating custom topics and event subscriptions that want to leverage the schema.
Now, let’s create a resource group to manage all the services and assets that we want to leverage:
az group create --name cloudeventsdemo-rg -l westcentralus
We then create a custom topic, just like we are accustomed to, but with the addition of the input-schema parameter:
az eventgrid topic create --name <topic-name> -l westcentralus -g cloudeventsdemo-rg --input-schema cloudeventv01schema
Moving on to the publishing side, we can now create a strongly-typed class to represent a cloud event. For more information about the schema and how it maps to the Event Grid format, see: https://docs.microsoft.com/en-us/azure/event-grid/cloudevents-schema
For the data, to keep things interesting, we’ll go with information about bands and their albums to demonstrate the usage of a custom objects within the payload.
The complete code for a .NET Core console application that publishes the event, is listed below. We’ll talk about some of the key points right after the listing.
The code here isn’t much different than how you would already send an event to Event Grid. However, there are a few slight differences worth noting. The first thing we want to point us is obviously the use of the CloudEvent schema:
The property that stands out is Source, which according to the documentation, will be mapped to Event Grid like this: topic#subject. As a result, topic will need to be formatted as follows:
We can then append anything we like for the subject that follows the hashtag in the field. Also, notice that we are sending only one event at a time instead of an array to comply with the CloudEvents standard.
That about wraps it up for sending an event. Let’s start putting together an event subscription and handler.
I chose to use an Azure Function for a consumer in this example to showcase the first-class support on Azure. However, keep in mind that Event Grid publishers and handlers are actually platform-agnostic. The source and handlers for these events can reside almost anywhere. I also wanted a little more hands-on experience with v2 Functions. 🙂
The complete code for a Azure Function with a HTTP trigger is as follows:
The code is almost identical to a normal event except on line 35 when it is deserialized into the CloudEvent model we defined earlier.
Subscribe to events
Its time to wrap this us by creating an event subscription that leverages the CloudEvent schema. Assuming the function has been deployed, we can now execute the following from the CLI:
az eventgrid event-subscription create --name <subscription-name> --topic-name <topic-name> -g <resource-group-name> --endpoint <endpoint-url> --event-delivery-schema cloudeventv01schema
This was a lot of fun to experiment with and we are only just starting our journey with Event Grid and CloudEvents. If you’d like to review the sample code, please see: https://github.com/dbarkol/cloud-events.
For more about Cloud Events, the Event Grid announcement and other related information:
- Announcing first-class support for CloudEvents on Azure
- Use CloudEvents Schema with Event Grid
- Cloud Native Compute Foundation
- Cloud Events specification
- Azure Event Grid MSDN article