Azure Event Grid client library for Python — Azure SDK for Python 2.0.0 documentation

Azure Event Grid is a fully-managed intelligent event routing service that allows for uniform event consumption using a publish-subscribe model.

Getting started¶

Prerequisites¶

Python 2.7, or 3.5 or later is required to use this package.
You must have an Azure subscription and an Event Grid Topic resource to use this package.

Install the package¶

Install the Azure Event Grid client library for Python with pip:

pip install azure-eventgrid

An existing Event Grid topic or domain is required. You can create the resource using Azure Portal or Azure CLI

If you use Azure CLI, replace <resource-group-name> and <resource-name> with your own unique names.

Create an Event Grid Topic¶

az eventgrid topic --create --location <location> --resource-group <resource-group-name> --name <resource-name>

Create an Event Grid Domain¶

az eventgrid domain --create --location <location> --resource-group <resource-group-name> --name <resource-name>

Authenticate the client¶

In order to interact with the Event Grid service, you will need to create an instance of a client. A topic_hostname and credential are necessary to instantiate the client object.

Looking up the endpoint¶

You can find the endpoint and the hostname on the Azure portal.

Create the client with AzureKeyCredential¶

To use an API key as the credential parameter, pass the key as a string into an instance of AzureKeyCredential.

from azure.core.credentials import AzureKeyCredentialfrom azure.eventgrid import EventGridPublisherClienttopic_hostname = ""credential = AzureKeyCredential("<api_key>")eg_publisher_client = EventGridPublisherClient(topic_hostname, credential)

Key concepts¶

Information about the key concepts on Event Grid, see Concepts in Azure Event Grid

EventGridPublisherClient¶

EventGridPublisherClient provides operations to send event data to topic hostname specified during client initialization. Either a list or a single instance of CloudEvent/EventGridEvent/CustomEvent can be sent.

EventGridConsumer¶

EventGridConsumer is used to desrialize an event received.

Examples¶

The following sections provide several code snippets covering some of the most common Event Grid tasks, including:

Send an Event Grid Event¶

This example publishes an Event Grid event.

import osfrom azure.core.credentials import AzureKeyCredentialfrom azure.eventgrid import EventGridPublisherClient, EventGridEventkey = os.environ["EG_ACCESS_KEY"]topic_hostname = os.environ["EG_TOPIC_HOSTNAME"]event = EventGridEvent( subject="Door1", data={"team": "azure-sdk"}, event_type="Azure.Sdk.Demo", data_version="2.0")credential = AzureKeyCredential(key)client = EventGridPublisherClient(topic_hostname, credential)client.send(event)

Send a Cloud Event¶

This example publishes a Cloud event.

import osfrom azure.core.credentials import AzureKeyCredentialfrom azure.eventgrid import EventGridPublisherClient, CloudEventkey = os.environ["CLOUD_ACCESS_KEY"]topic_hostname = os.environ["CLOUD_TOPIC_HOSTNAME"]event = CloudEvent( type="Azure.Sdk.Sample", source="", data={"team": "azure-sdk"})credential = AzureKeyCredential(key)client = EventGridPublisherClient(topic_hostname, credential)client.send(event)

Consume an Event Grid Event¶

This example demonstrates consuming and deserializing an eventgrid event.

import osfrom azure.eventgrid import EventGridConsumerconsumer = EventGridConsumer()eg_storage_dict = { "id":"bbab625-dc56-4b22-abeb-afcc72e5290c", "subject":"/blobServices/default/containers/oc2d2817345i200097container/blobs/oc2d2817345i20002296blob", "data":{ "api":"PutBlockList", }, "eventType":"Microsoft.Storage.BlobCreated", "dataVersion":"2.0", "metadataVersion":"1", "eventTime":"2020-08-07T02:28:23.867525Z", "topic":"/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/"}deserialized_event = consumer.decode_eventgrid_event(eg_storage_dict)# both allow access to raw properties as stringstime_string = deserialized_event.event_time

Consume a Cloud Event¶

This example demonstrates consuming and deserializing a cloud event.

import osfrom azure.eventgrid import EventGridConsumerconsumer = EventGridConsumer()cloud_storage_dict = { "id":"a0517898-9fa4-4e70-b4a3-afda1dd68672", "source":"/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/", "data":{ "api":"PutBlockList", }, "type":"Microsoft.Storage.BlobCreated", "time":"2020-08-07T01:11:49.765846Z", "specversion":"1.0"}deserialized_event = consumer.decode_cloud_event(cloud_storage_dict)# both allow access to raw properties as stringstime_string = deserialized_event.time

Troubleshooting¶

Enable azure.eventgrid logger to collect traces from the library.

General¶

Event Grid client library will raise exceptions defined in Azure Core.

Logging¶

This library uses the standardlogging library for logging. Basic information about HTTP sessions (URLs, headers, etc.) is logged at INFO level.

Optional Configuration¶

Optional keyword arguments can be passed in at the client and per-operation level. The azure-core reference documentationdescribes available configurations for retries, logging, transport protocols, and more.

Next steps¶

The following section provides several code snippets illustrating common patterns used in the Event Grid Python API.

More sample code¶

These code samples show common champion scenario operations with the Azure Event Grid client library.

More samples can be found here.

Additional documentation¶

For more extensive documentation on Azure Event Grid, see the Event Grid documentation on docs.microsoft.com.

Contributing¶

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Indices and tables¶

Developer Documentation