# Azure Event Grid client library for Python
Azure Event Grid is a fully-managed intelligent event routing service that allows for uniform event consumption using a publish-subscribe model.
[Source code][python-eg-src]
| [Package (PyPI)][python-eg-pypi]
| [Package (Conda)](https://anaconda.org/microsoft/azure-eventgrid/)
| [API reference documentation][python-eg-ref-docs]
| [Product documentation][python-eg-product-docs]
| [Samples][python-eg-samples]
| [Changelog][python-eg-changelog]
## _Disclaimer_
This is a GA release of Azure Event Grid's `EventGridPublisherClient` and `EventGridConsumerClient`. `EventGridPublisherClient` supports `send` for Event Grid Basic and Event Grid Namespaces. `EventGridConsumerClient` supports `receive`, `acknowledge` , `release`, `reject`, and `renew_locks` operations for Event Grid Namespaces. Please refer to the [samples](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/eventgrid/azure-eventgrid/samples) for further information.
## Getting started
### Prerequisites
* Python 3.8 or later is required to use this package.
* You must have an [Azure subscription][azure_subscription] and at least one of the following:
* an Event Grid Namespace resource. To create an Event Grid Namespace resource follow [this tutorial](https://learn.microsoft.com/azure/event-grid/create-view-manage-namespaces).
* an Event Grid Basic resource. To create an Event Grid Basic resource via the Azure portal follow this [step-by-step tutorial](https://docs.microsoft.com/azure/event-grid/custom-event-quickstart-portal). To create an Event Grid Basic resource via the [Azure CLI](https://docs.microsoft.com/cli/azure) follow this [tutorial](https://docs.microsoft.com/azure/event-grid/custom-event-quickstart)
### Event Grid Resources
Azure Event Grid Namespaces supports both pull and push delivery. Azure Event Grid Basic supports only push delivery.
More information on the two resource tiers can be found [here](https://learn.microsoft.com/azure/event-grid/choose-right-tier).
**Note:** Azure Event Grid Namespaces only supports the Cloud Event v1.0 Schema.
### Install the package
Install the Azure Event Grid client library for Python with [pip][pip]:
```bash
pip install azure-eventgrid
```
* An existing Event Grid Basic topic or domain, or Event Grid Namespace topic is required. You can create the resource using [Azure Portal][azure_portal_create_EG_resource] or [Azure CLI][azure_cli_link]
If you use Azure CLI, replace `<resource-group-name>` and `<resource-name>` with your own unique names.
#### Create an Event Grid Namespace
```
az eventgrid namespace create --location <location> --resource-group <resource-group-name> --name <resource-name>
```
#### Create an Event Grid Namespace Topic
```
az eventgrid namespace create topic --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.
An **endpoint** and **credential** are necessary to instantiate the client object.
The default EventGridPublisherClient created is compatible with an Event Grid Basic Resource. To create an Event Grid Namespace compatible client, specify `namespace_topic="YOUR_TOPIC_NAME"` when instantiating the client.
```python
# Event Grid Namespace client
client = EventGridPublisherClient(endpoint, credential, namespace_topic=YOUR_TOPIC_NAME)
# Event Grid Basic Client
client = EventGridPublisherClient(endpoint, credential)
```
EventGridConsumerClient only supports Event Grid Namespaces.
```python
# Event Grid Namespace Client
client = EventGridConsumerClient(endpoint, credential, namespace_topic=YOUR_TOPIC_NAME, subscription=YOUR_SUBSCRIPTION_NAME)
```
#### Using Azure Active Directory (AAD)
Azure Event Grid provides integration with Azure Active Directory (Azure AD) for identity-based authentication of requests. With Azure AD, you can use role-based access control (RBAC) to grant access to your Azure Event Grid resources to users, groups, or applications.
To send events to a topic or domain with a `TokenCredential`, the authenticated identity should have the "Event Grid Data Sender" role assigned.
To receive events from a topic event subscription with a `TokenCredential`, the authenticated identity should have the "Event Grid Data Receiver" role assigned.
To send and receive events to/from a topic with a `TokenCredential`, the authenticated identity should have the "Event Grid Data Contributor" role assigned.
More about RBAC setup can be found [here](https://learn.microsoft.com/azure/role-based-access-control/role-assignments-steps).
With the `azure-identity` package, you can seamlessly authorize requests in both development and production environments. To learn more about Azure Active Directory, see the [`azure-identity` README](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/identity/azure-identity/README.md).
For example, you can use `DefaultAzureCredential` to construct a client which will authenticate using Azure Active Directory:
<!-- SNIPPET:sample_authentication.client_auth_with_token_cred -->
```python
from azure.identity import DefaultAzureCredential
from azure.eventgrid import EventGridPublisherClient, EventGridEvent
default_az_credential = DefaultAzureCredential()
endpoint = os.environ["EVENTGRID_TOPIC_ENDPOINT"]
client = EventGridPublisherClient(endpoint, default_az_credential)
```
<!-- END SNIPPET -->
### Looking up the endpoint
#### Event Grid Namespace
You can find the Namespace endpoint within the Event Grid Namespace resource on the Azure portal. This will look like:
`"<event-grid-namespace-name>.<namespace-location>.eventgrid.azure.net"`
#### Event Grid Basic
You can find the topic endpoint within the Event Grid Topic resource on the Azure portal. This will look like:
`"https://<event-grid-topic-name>.<topic-location>.eventgrid.azure.net/api/events"`
### Create the client with AzureKeyCredential
To use an Access key as the `credential` parameter,
pass the key as a string into an instance of [AzureKeyCredential][azure-key-credential].
> **Note:** The Access Key may be found in the azure portal in the "Access Keys" menu of the Event Grid Topic resource. They may also be obtained via the azure CLI, or the `azure-mgmt-eventgrid` library. A guide for getting access keys can be found [here](https://docs.microsoft.com/azure/event-grid/get-access-keys).
<!-- SNIPPET:sample_authentication.client_auth_with_key_cred -->
```python
import os
from azure.eventgrid import EventGridPublisherClient
from azure.core.credentials import AzureKeyCredential
topic_key = os.environ["EVENTGRID_TOPIC_KEY"]
endpoint = os.environ["EVENTGRID_TOPIC_ENDPOINT"]
credential_key = AzureKeyCredential(topic_key)
client = EventGridPublisherClient(endpoint, credential_key)
```
<!-- END SNIPPET -->
> **Note:** A Basic client may also be authenticated via SAS signature, using the `AzureSasCredential`. A sample demonstrating this, is available [here][python-eg-sample-send-using-sas] ([async_version][python-eg-sample-send-using-sas-async]).
> **Note:** The `generate_sas` method can be used to generate a shared access signature. A sample demonstrating this can be seen [here][python-eg-generate-sas].
## Key concepts
### Event Grid Namespace
A **[namespace](https://learn.microsoft.com/azure/event-grid/concepts-event-grid-namespaces#namespaces)** is a management container for other resources. It allows for grouping of related resources in order to manage them under one subscription.
#### Namespace Topic
A **[namespace topic](https://learn.microsoft.com/azure/event-grid/concepts-event-grid-namespaces#namespace-topics)** is a topic that is created within an Event Grid namespace. The client publishes events to an HTTP namespace endpoint specifying a namespace topic where published events are logically contained. A namespace topic only supports the CloudEvent v1.0 schema.
#### Event Subscription
An **[event subscription](https://learn.microsoft.com/azure/event-grid/concepts-event-grid-namespaces#event-subscriptions)** is a configuration resource associated with a single topic.
### Event Grid Basic
#### Topic
A **[topic](https://docs.microsoft.com/azure/event-grid/concepts#topics)** is a channel within the Event Grid service to send events. The event schema that a topic accepts is decided at topic creation time. If events of a schema type are sent to a topic that requires a different schema type, errors will be raised.
#### Domain
An event **[domain](https://docs.microsoft.com/azure/event-grid/event-domains)** is a management tool for large numbers of Event Grid topics related to the same application. They allow you to publish events to thousands of topics. Domains also give you authorization and authentication control over each topic. For more information, visit [Event domain overview](https://docs.microsoft.com/azure/event-grid/event-domains).
#### Event schemas
An **[event](https://docs.microsoft.com/azure/event-grid/concepts#events)** is the smallest amount of information that fully describes something that happened in the system. When a custom topic or domain is created, you must specify the schema that will be used when publishing events.
Event Grid supports multiple schemas for encoding events.
#### System Topics
A **[system topic](https://docs.microsoft.com/azure/event-grid/system-topics)** in Event Grid represents one or more events published by Azure services such as Azure Storage or Azure Event Hubs. For example, a system topic may represent all blob events or only blob creation and blob deletion events published for a specific storage account.
The names of the various event types for the system events published to Azure Event Grid are available in `azure.eventgrid.SystemEventNames`.
For complete list of recognizable system topics, visit [System Topics](https://docs.microsoft.com/azure/event-grid/system-topics).
For more information about the key concepts on Event Grid, see [Concepts in Azure Event Grid][publisher-service-doc].
## EventGridPublisherClient
`EventGridPublisherClient` provides operations to send event data to a resource specified during client initialization.
If you are using Event Grid Basic, regardless of the schema that your topic or domain is configured to use, `EventGridPublisherClient` will be used to publish events to it. Use the `send` method to publish events.
The following formats of events are allowed to be sent to an Event Grid Basic resource:
- A list or a single instance of strongly typed EventGridEvents.
- A dict representation of a serialized EventGridEvent object.
- A list or a single instance of strongly typed CloudEvents.
- A dict representation of a serialized CloudEvent object.
- A dict representation of any Custom Schema.
The following formats of events are allowed to be sent to an Event Grid Namespace resource, when a namespace topic is specified:
* A list of single instance of strongly typed CloudEvents.
* A dict representation of a serialized CloudEvent object.
Please have a look at the [samples](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/eventgrid/azure-eventgrid/samples) for detailed examples.
## Event Grid on Kubernetes with Azure Arc
Event Grid on Kubernetes with Azure Arc is an offering that allows you to run Event Grid on your own Kubernetes cluster. This capability is enabled by the use of Azure Arc enabled Kubernetes. Through Azure Arc enabled Kubernetes, a supported Kubernetes cluster connects to Azure. Once connected, you are able to install Event Grid on it. Learn more about it [here](https://docs.microsoft.com/azure/event-grid/kubernetes/overview).
## Examples
The following sections provide several code snippets covering some of the most common Event Grid tasks, including:
* [Send a Cloud Event](#send-a-cloud-event)
* [Send Multiple Events](#send-multiple-events)
* [Receive and Process Events from Namespace](#receive-and-process-events-from-namespace)
### Send a Cloud Event
This example publishes a Cloud event.
```python
import os
from azure.core.credentials import AzureKeyCredential
from azure.core.messaging import CloudEvent
from azure.eventgrid import EventGridPublisherClient
key = os.environ["EVENTGRID_KEY"]
endpoint = os.environ["EVENTGRID_ENDPOINT"]
topic_name = os.environ["EVENTGRID_TOPIC_NAME"]
event = CloudEvent(
type="Azure.Sdk.Sample",
source="https://egsample.dev/sampleevent",
data={"team": "azure-sdk"}
)
credential = AzureKeyCredential(key)
client = EventGridPublisherClient(endpoint, credential, namespace_topic=topic_name)
client.send(event)
```
### Send Multiple events
It is possible to send events as a batch when sending multiple events to a topic or a domain. This example sends a list of CloudEvents using the send method.
**WARNING:** When sending a list of multiple events at one time, iterating over and sending each event will not result in optimal performance. For best performance, it is highly recommended to send a list of events.
```python
import os
from azure.core.credentials import AzureKeyCredential
from azure.core.messaging import CloudEvent
from azure.eventgrid import EventGridPublisherClient
key = os.environ["EVENTGRID_KEY"]
endpoint = os.environ["EVENTGRID_ENDPOINT"]
topic_name = os.environ["EVENTGRID_TOPIC_NAME"]
event0 = CloudEvent(
type="Azure.Sdk.Sample",
source="https://egsample.dev/sampleevent",
data={"team": "azure-sdk"}
)
event1 = CloudEvent(
type="Azure.Sdk.Sample",
source="https://egsample.dev/sampleevent",
data={"team2": "azure-eventgrid"}
)
events = [event0, event1]
credential = AzureKeyCredential(key)
client = EventGridPublisherClient(endpoint, credential, namespace_topic=topic_name)
client.send(events)
```
### Receive and Process Events from Namespace
Use EventGridConsumerClient's receive function to receive CloudEvents from a Namespace event subscription. Then try to acknowledge, reject, release or renew the locks.
```python
import os
import uuid
import datetime as dt
from azure.core.credentials import AzureKeyCredential
from azure.eventgrid import EventGridConsumerClient
key = os.environ["EVENTGRID_KEY"]
endpoint = os.environ["EVENTGRID_ENDPOINT"]
topic_name = os.environ["EVENTGRID_TOPIC_NAME"]
sub_name = os.environ["EVENTGRID_EVENT_SUBSCRIPTION_NAME"]
credential = AzureKeyCredential(key)
client = EventGridConsumerClient(endpoint, credential, namespace_topic=topic_name, subscription=sub_name)
events = client.receive(max_events=4)
for detail in events.value:
data = detail.event.data
broker_properties = detail.broker_properties
if data == "release":
release_events.append(broker_properties.lock_token)
elif data == "acknowledge":
acknowledge_events.append(broker_properties.lock_token)
else:
reject_events.append(broker_properties.lock_token)
# Renew all Locks
renew_tokens = e.broker_properties.lock_token
renew_result = client.renew_locks(
lock_tokens=renew_tokens,
)
release_result = client.release(
lock_tokens=release_events,
)
ack_result = client.acknowledge(
lock_tokens=acknowledge_events,
)
reject_result = client.reject(
lock_tokens=reject_events,
)
```
## Distributed Tracing with Event Grid
You can use OpenTelemetry for Python as usual with Event Grid since it's compatible with azure-core tracing integration.
Here is an example of using OpenTelemetry to trace sending a CloudEvent.
First, set OpenTelemetry as enabled tracing plugin for Event Grid.
```python
from azure.core.settings import settings
from azure.core.tracing.ext.opentelemetry_span import OpenTelemetrySpan
settings.tracing_implementation = OpenTelemetrySpan
```
Regular open telemetry usage from here. See [OpenTelemetry](https://github.com/open-telemetry/opentelemetry-python) for details.
This example uses a simple console exporter to export the traces. Any exporter can be used here including `azure-monitor-opentelemetry-exporter`, `jaeger`, `zipkin` etc.
```python
from opentelemetry import trace
from opentelemetry.sdk.trace import TracerProvider
from opentelemetry.sdk.trace.export import ConsoleSpanExporter
from opentelemetry.sdk.trace.export import SimpleSpanProcessor # this requires opentelemetry >= 1.0.0
# Simple console exporter
exporter = ConsoleSpanExporter()
trace.set_tracer_provider(TracerProvider())
tracer = trace.get_tracer(__name__)
trace.get_tracer_provider().add_span_processor(
SimpleSpanProcessor(exporter)
)
```
Once the `tracer` and `exporter` are set, please follow the example below to start collecting traces while using the `send` method from the `EventGridClient` to send a CloudEvent object.
```python
import os
from azure.eventgrid import EventGridPublisherClient
from azure.core.messaging import CloudEvent
from azure.core.credentials import AzureKeyCredential
hostname = os.environ['CLOUD_TOPIC_HOSTNAME']
key = AzureKeyCredential(os.environ['CLOUD_ACCESS_KEY'])
cloud_event = CloudEvent(
source = 'demo',
type = 'sdk.demo',
data = {'test': 'hello'},
)
with tracer.start_as_current_span(name="MyApplication"):
client = EventGridPublisherClient(hostname, key)
client.send(cloud_event)
```
## Troubleshooting
- Enable `azure.eventgrid` logger to collect traces from the library.
### General
Event Grid client library will raise exceptions defined in [Azure Core][azure_core_exceptions].
### Logging
This library uses the standard
[logging][python_logging] 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 documentation][azure_core_ref_docs]
describes 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.
#### Additional Namespace Event Grid Scenarios
* Authenticate the client: [sample_namespace_authentication_async.py][python-eg-namespace-authenticate-async]
* Publish to the namespace topic: [sample_publish_cloud_event_async.py][python-eg-namespace-publish-cloud-async]
* Consume and Process from an event subscription: [sample_consume_process_events.py][python-eg-namespace-consume-async]
#### Additional Basic Event Grid Scenarios
* Generate Shared Access Signature: [sample_generate_sas.py][python-eg-generate-sas]
* Authenticate the client: [sample_authentication.py][python-eg-auth] ([async_version][python-eg-auth-async])
* Publish events to a topic using SAS: [sample_publish_events_to_a_topic_using_sas_credential_async.py][python-eg-sample-send-using-sas] ([async_version][python-eg-sample-send-using-sas-async])
* Publish Event Grid Events to a topic: [sample_publish_eg_events_to_a_topic.py][python-eg-sample-eg-event] ([async_version][python-eg-sample-eg-event-async])
* Publish Event Grid Events to a domain topic: [sample_publish_eg_events_to_a_domain_topic.py][python-eg-sample-eg-event-to-domain] ([async_version][python-eg-sample-eg-event-to-domain-async])
* Publish a Cloud Event: [sample_publish_events_using_cloud_events_1.0_schema.py][python-eg-sample-send-cloudevent] ([async_version][python-eg-sample-send-cloudevent-async])
* Publish a Custom Schema: [sample_publish_custom_schema_to_a_topic.py][python-eg-publish-custom-schema] ([async_version][python-eg-publish-custom-schema-async])
The following samples cover publishing and consuming `dict` representations of EventGridEvents and CloudEvents.
* Publish EventGridEvent as dict like representation: [sample_publish_eg_event_using_dict.py][python-eg-sample-send-eg-as-dict] ([async_version][python-eg-sample-send-eg-as-dict-async])
* Publish CloudEvent as dict like representation: [sample_publish_cloud_event_using_dict.py][python-eg-sample-send-cloudevent-as-dict] ([async_version][python-eg-sample-send-cloudevent-as-dict-async])
* Consume a Custom Payload of raw cloudevent data: [sample_consume_custom_payload.py][python-eg-sample-consume-custom-payload]
More samples can be found [here][python-eg-samples].
* More samples related to the send scenario can be seen [here][python-eg-publish-samples].
* To see more samples related to consuming a payload from different messaging services as a typed object, please visit [Consume Samples][python-eg-consume-samples]
### Additional documentation
For more extensive documentation on Azure Event Grid, see the [Event Grid documentation][python-eg-product-docs] 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][cla].
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][code_of_conduct]. For more information see the [Code of Conduct FAQ][coc_faq] or contact [opencode@microsoft.com][coc_contact] with any additional questions or comments.
<!-- LINKS -->
[azure_cli_link]: https://pypi.org/project/azure-cli/
[python-eg-src]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/eventgrid/azure-eventgrid
[python-eg-pypi]: https://pypi.org/project/azure-eventgrid
[python-eg-product-docs]: https://docs.microsoft.com/azure/event-grid/overview
[python-eg-ref-docs]: https://azuresdkdocs.blob.core.windows.net/$web/python/azure-eventgrid/latest/index.html
[publisher-service-doc]: https://docs.microsoft.com/azure/event-grid/concepts
[python-eg-samples]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/eventgrid/azure-eventgrid/samples
[python-eg-changelog]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/eventgrid/azure-eventgrid/CHANGELOG.md
[pip]: https://pypi.org/project/pip/
[azure_portal_create_EG_resource]: https://ms.portal.azure.com/#blade/HubsExtension/BrowseResource/resourceType/Microsoft.EventGrid%2Ftopics
[azure-key-credential]: https://aka.ms/azsdk/python/core/azurekeycredential
[azure_core_exceptions]: https://aka.ms/azsdk/python/core/docs#module-azure.core.exceptions
[python_logging]: https://docs.python.org/3/library/logging.html
[azure_core_ref_docs]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/core/azure-core#configurations
[azure_subscription]: https://azure.microsoft.com/free/
[python-eg-auth]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/basic/sync_samples/sample_authentication.py
[python-eg-generate-sas]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/basic/sync_samples/sample_generate_sas.py
[python-eg-sample-send-using-sas]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/basic/sync_samples/sample_publish_events_to_a_topic_using_sas_credential.py
[python-eg-sample-eg-event]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/basic/sync_samples/sample_publish_eg_events_to_a_topic.py
[python-eg-sample-eg-event-to-domain]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/basic/sync_samples/sample_publish_eg_events_to_a_domain.py
[python-eg-sample-send-cloudevent]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/basic/sync_samples/sample_publish_events_using_cloud_events_1.0_schema.py
[python-eg-publish-custom-schema]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/basic/sync_samples/sample_publish_custom_schema_to_a_topic.py
[python-eg-sample-send-eg-as-dict]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/basic/sync_samples/sample_publish_eg_event_using_dict.py
[python-eg-sample-send-cloudevent-as-dict]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/basic/sync_samples/sample_publish_cloud_event_using_dict.py
[python-eg-auth-async]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/basic/async_samples/sample_authentication_async.py
[python-eg-sample-send-using-sas-async]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/basic/async_samples/sample_publish_events_to_a_topic_using_sas_credential_async.py
[python-eg-sample-eg-event-async]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/basic/async_samples/sample_publish_eg_events_to_a_topic_async.py
[python-eg-sample-eg-event-to-domain-async]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/basic/async_samples/sample_publish_eg_events_to_a_domain_async.py
[python-eg-sample-send-cloudevent-async]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/basic/async_samples/sample_publish_events_using_cloud_events_1.0_schema_async.py
[python-eg-publish-custom-schema-async]:https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/basic/async_samples/sample_publish_custom_schema_to_a_topic_async.py
[python-eg-sample-send-eg-as-dict-async]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/basic/async_samples/sample_publish_eg_event_using_dict_async.py
[python-eg-sample-send-cloudevent-as-dict-async]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/basic/async_samples/sample_publish_cloud_event_using_dict_async.py
[python-eg-publish-samples]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/basic/publish_samples
[python-eg-consume-samples]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/basic/consume_samples
[python-eg-sample-consume-custom-payload]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/basic/sync_samples/sample_consume_custom_payload.py
[python-eg-namespace-authenticate]:https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/namespace/sync_samples/sample_namespace_authentication.py
[python-eg-namespace-publish-cncf]:https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/namespace/sync_samples/sample_publish_cncf_events.py
[python-eg-namespace-publish-cloud]:https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/namespace/sync_samples/sample_publish_cloud_event.py
[python-eg-namespace-consume]:https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/namespace/samples/sync_samples/sample_consume_process_events.py
[python-eg-namespace-authenticate-async]:https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/namespace/async_samples/sample_namespace_authentication_async.py
[python-eg-namespace-publish-cncf-async]:https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/namespace/async_samples/sample_publish_cncf_events_async.py
[python-eg-namespace-publish-cloud-async]:https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/namespace/async_samples/sample_publish_cloud_event_async.py
[python-eg-namespace-consume-async]:https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/namespace/async_samples/sample_consume_process_events_async.py
[cla]: https://cla.microsoft.com
[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/
[coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/
[coc_contact]: mailto:opencode@microsoft.com
Raw data
{
"_id": null,
"home_page": "https://github.com/Azure/azure-sdk-for-python/tree/main/sdk",
"name": "azure-eventgrid",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "azure, azure sdk",
"author": "Microsoft Corporation",
"author_email": "azpysdkhelp@microsoft.com",
"download_url": "https://files.pythonhosted.org/packages/61/4d/3029224304d6f5cfc6bdb3ef278f7249d8ccfecbb4a335f326b9d2009c98/azure_eventgrid-4.21.0.tar.gz",
"platform": null,
"description": "# Azure Event Grid client library for Python\n\nAzure Event Grid is a fully-managed intelligent event routing service that allows for uniform event consumption using a publish-subscribe model.\n\n[Source code][python-eg-src]\n| [Package (PyPI)][python-eg-pypi]\n| [Package (Conda)](https://anaconda.org/microsoft/azure-eventgrid/)\n| [API reference documentation][python-eg-ref-docs]\n| [Product documentation][python-eg-product-docs]\n| [Samples][python-eg-samples]\n| [Changelog][python-eg-changelog]\n\n## _Disclaimer_\n\nThis is a GA release of Azure Event Grid's `EventGridPublisherClient` and `EventGridConsumerClient`. `EventGridPublisherClient` supports `send` for Event Grid Basic and Event Grid Namespaces. `EventGridConsumerClient` supports `receive`, `acknowledge` , `release`, `reject`, and `renew_locks` operations for Event Grid Namespaces. Please refer to the [samples](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/eventgrid/azure-eventgrid/samples) for further information.\n\n## Getting started\n\n### Prerequisites\n* Python 3.8 or later is required to use this package.\n* You must have an [Azure subscription][azure_subscription] and at least one of the following:\n * an Event Grid Namespace resource. To create an Event Grid Namespace resource follow [this tutorial](https://learn.microsoft.com/azure/event-grid/create-view-manage-namespaces).\n * an Event Grid Basic resource. To create an Event Grid Basic resource via the Azure portal follow this [step-by-step tutorial](https://docs.microsoft.com/azure/event-grid/custom-event-quickstart-portal). To create an Event Grid Basic resource via the [Azure CLI](https://docs.microsoft.com/cli/azure) follow this [tutorial](https://docs.microsoft.com/azure/event-grid/custom-event-quickstart)\n\n### Event Grid Resources\n\nAzure Event Grid Namespaces supports both pull and push delivery. Azure Event Grid Basic supports only push delivery.\nMore information on the two resource tiers can be found [here](https://learn.microsoft.com/azure/event-grid/choose-right-tier).\n\n**Note:** Azure Event Grid Namespaces only supports the Cloud Event v1.0 Schema.\n\n### Install the package\nInstall the Azure Event Grid client library for Python with [pip][pip]:\n\n```bash\npip install azure-eventgrid\n```\n\n* An existing Event Grid Basic topic or domain, or Event Grid Namespace topic is required. You can create the resource using [Azure Portal][azure_portal_create_EG_resource] or [Azure CLI][azure_cli_link]\n\nIf you use Azure CLI, replace `<resource-group-name>` and `<resource-name>` with your own unique names.\n\n#### Create an Event Grid Namespace\n\n```\naz eventgrid namespace create --location <location> --resource-group <resource-group-name> --name <resource-name>\n```\n\n#### Create an Event Grid Namespace Topic\n\n```\naz eventgrid namespace create topic --location <location> --resource-group <resource-group-name> --name <resource-name>\n```\n\n### Authenticate the client\nIn order to interact with the Event Grid service, you will need to create an instance of a client.\nAn **endpoint** and **credential** are necessary to instantiate the client object.\n\n\nThe default EventGridPublisherClient created is compatible with an Event Grid Basic Resource. To create an Event Grid Namespace compatible client, specify `namespace_topic=\"YOUR_TOPIC_NAME\"` when instantiating the client.\n\n```python\n# Event Grid Namespace client\nclient = EventGridPublisherClient(endpoint, credential, namespace_topic=YOUR_TOPIC_NAME)\n\n# Event Grid Basic Client\nclient = EventGridPublisherClient(endpoint, credential)\n```\n\nEventGridConsumerClient only supports Event Grid Namespaces.\n```python\n# Event Grid Namespace Client\nclient = EventGridConsumerClient(endpoint, credential, namespace_topic=YOUR_TOPIC_NAME, subscription=YOUR_SUBSCRIPTION_NAME)\n```\n\n#### Using Azure Active Directory (AAD)\n\nAzure Event Grid provides integration with Azure Active Directory (Azure AD) for identity-based authentication of requests. With Azure AD, you can use role-based access control (RBAC) to grant access to your Azure Event Grid resources to users, groups, or applications.\n\nTo send events to a topic or domain with a `TokenCredential`, the authenticated identity should have the \"Event Grid Data Sender\" role assigned.\nTo receive events from a topic event subscription with a `TokenCredential`, the authenticated identity should have the \"Event Grid Data Receiver\" role assigned.\nTo send and receive events to/from a topic with a `TokenCredential`, the authenticated identity should have the \"Event Grid Data Contributor\" role assigned.\n\nMore about RBAC setup can be found [here](https://learn.microsoft.com/azure/role-based-access-control/role-assignments-steps).\n\nWith the `azure-identity` package, you can seamlessly authorize requests in both development and production environments. To learn more about Azure Active Directory, see the [`azure-identity` README](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/identity/azure-identity/README.md).\n\nFor example, you can use `DefaultAzureCredential` to construct a client which will authenticate using Azure Active Directory:\n\n<!-- SNIPPET:sample_authentication.client_auth_with_token_cred -->\n\n```python\nfrom azure.identity import DefaultAzureCredential\nfrom azure.eventgrid import EventGridPublisherClient, EventGridEvent\n\ndefault_az_credential = DefaultAzureCredential()\nendpoint = os.environ[\"EVENTGRID_TOPIC_ENDPOINT\"]\nclient = EventGridPublisherClient(endpoint, default_az_credential)\n```\n\n<!-- END SNIPPET -->\n\n### Looking up the endpoint\n\n#### Event Grid Namespace\nYou can find the Namespace endpoint within the Event Grid Namespace resource on the Azure portal. This will look like:\n`\"<event-grid-namespace-name>.<namespace-location>.eventgrid.azure.net\"`\n\n#### Event Grid Basic\nYou can find the topic endpoint within the Event Grid Topic resource on the Azure portal. This will look like:\n`\"https://<event-grid-topic-name>.<topic-location>.eventgrid.azure.net/api/events\"`\n\n### Create the client with AzureKeyCredential\n\nTo use an Access key as the `credential` parameter,\npass the key as a string into an instance of [AzureKeyCredential][azure-key-credential].\n\n> **Note:** The Access Key may be found in the azure portal in the \"Access Keys\" menu of the Event Grid Topic resource. They may also be obtained via the azure CLI, or the `azure-mgmt-eventgrid` library. A guide for getting access keys can be found [here](https://docs.microsoft.com/azure/event-grid/get-access-keys).\n\n<!-- SNIPPET:sample_authentication.client_auth_with_key_cred -->\n\n```python\nimport os\nfrom azure.eventgrid import EventGridPublisherClient\nfrom azure.core.credentials import AzureKeyCredential\n\ntopic_key = os.environ[\"EVENTGRID_TOPIC_KEY\"]\nendpoint = os.environ[\"EVENTGRID_TOPIC_ENDPOINT\"]\n\ncredential_key = AzureKeyCredential(topic_key)\nclient = EventGridPublisherClient(endpoint, credential_key)\n```\n\n<!-- END SNIPPET -->\n\n> **Note:** A Basic client may also be authenticated via SAS signature, using the `AzureSasCredential`. A sample demonstrating this, is available [here][python-eg-sample-send-using-sas] ([async_version][python-eg-sample-send-using-sas-async]).\n\n> **Note:** The `generate_sas` method can be used to generate a shared access signature. A sample demonstrating this can be seen [here][python-eg-generate-sas].\n\n## Key concepts\n\n### Event Grid Namespace\n\nA **[namespace](https://learn.microsoft.com/azure/event-grid/concepts-event-grid-namespaces#namespaces)** is a management container for other resources. It allows for grouping of related resources in order to manage them under one subscription.\n\n#### Namespace Topic\n\nA **[namespace topic](https://learn.microsoft.com/azure/event-grid/concepts-event-grid-namespaces#namespace-topics)** is a topic that is created within an Event Grid namespace. The client publishes events to an HTTP namespace endpoint specifying a namespace topic where published events are logically contained. A namespace topic only supports the CloudEvent v1.0 schema.\n\n#### Event Subscription\n\nAn **[event subscription](https://learn.microsoft.com/azure/event-grid/concepts-event-grid-namespaces#event-subscriptions)** is a configuration resource associated with a single topic.\n\n\n### Event Grid Basic\n\n#### Topic\nA **[topic](https://docs.microsoft.com/azure/event-grid/concepts#topics)** is a channel within the Event Grid service to send events. The event schema that a topic accepts is decided at topic creation time. If events of a schema type are sent to a topic that requires a different schema type, errors will be raised.\n\n#### Domain\nAn event **[domain](https://docs.microsoft.com/azure/event-grid/event-domains)** is a management tool for large numbers of Event Grid topics related to the same application. They allow you to publish events to thousands of topics. Domains also give you authorization and authentication control over each topic. For more information, visit [Event domain overview](https://docs.microsoft.com/azure/event-grid/event-domains).\n\n#### Event schemas\nAn **[event](https://docs.microsoft.com/azure/event-grid/concepts#events)** is the smallest amount of information that fully describes something that happened in the system. When a custom topic or domain is created, you must specify the schema that will be used when publishing events.\n\nEvent Grid supports multiple schemas for encoding events.\n\n#### System Topics\nA **[system topic](https://docs.microsoft.com/azure/event-grid/system-topics)** in Event Grid represents one or more events published by Azure services such as Azure Storage or Azure Event Hubs. For example, a system topic may represent all blob events or only blob creation and blob deletion events published for a specific storage account.\n\nThe names of the various event types for the system events published to Azure Event Grid are available in `azure.eventgrid.SystemEventNames`.\nFor complete list of recognizable system topics, visit [System Topics](https://docs.microsoft.com/azure/event-grid/system-topics).\n\n For more information about the key concepts on Event Grid, see [Concepts in Azure Event Grid][publisher-service-doc].\n\n## EventGridPublisherClient\n\n`EventGridPublisherClient` provides operations to send event data to a resource specified during client initialization.\n\nIf you are using Event Grid Basic, regardless of the schema that your topic or domain is configured to use, `EventGridPublisherClient` will be used to publish events to it. Use the `send` method to publish events.\n\nThe following formats of events are allowed to be sent to an Event Grid Basic resource:\n- A list or a single instance of strongly typed EventGridEvents.\n- A dict representation of a serialized EventGridEvent object.\n- A list or a single instance of strongly typed CloudEvents.\n- A dict representation of a serialized CloudEvent object.\n\n- A dict representation of any Custom Schema.\n\nThe following formats of events are allowed to be sent to an Event Grid Namespace resource, when a namespace topic is specified:\n\n* A list of single instance of strongly typed CloudEvents.\n* A dict representation of a serialized CloudEvent object.\n\nPlease have a look at the [samples](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/eventgrid/azure-eventgrid/samples) for detailed examples.\n\n## Event Grid on Kubernetes with Azure Arc\n\nEvent Grid on Kubernetes with Azure Arc is an offering that allows you to run Event Grid on your own Kubernetes cluster. This capability is enabled by the use of Azure Arc enabled Kubernetes. Through Azure Arc enabled Kubernetes, a supported Kubernetes cluster connects to Azure. Once connected, you are able to install Event Grid on it. Learn more about it [here](https://docs.microsoft.com/azure/event-grid/kubernetes/overview).\n\n## Examples\n\nThe following sections provide several code snippets covering some of the most common Event Grid tasks, including:\n\n* [Send a Cloud Event](#send-a-cloud-event)\n* [Send Multiple Events](#send-multiple-events)\n* [Receive and Process Events from Namespace](#receive-and-process-events-from-namespace)\n\n### Send a Cloud Event\n\nThis example publishes a Cloud event.\n\n```python\nimport os\nfrom azure.core.credentials import AzureKeyCredential\nfrom azure.core.messaging import CloudEvent\nfrom azure.eventgrid import EventGridPublisherClient\n\nkey = os.environ[\"EVENTGRID_KEY\"]\nendpoint = os.environ[\"EVENTGRID_ENDPOINT\"]\ntopic_name = os.environ[\"EVENTGRID_TOPIC_NAME\"]\n\n\nevent = CloudEvent(\n type=\"Azure.Sdk.Sample\",\n source=\"https://egsample.dev/sampleevent\",\n data={\"team\": \"azure-sdk\"}\n)\n\ncredential = AzureKeyCredential(key)\nclient = EventGridPublisherClient(endpoint, credential, namespace_topic=topic_name)\n\nclient.send(event)\n```\n\n### Send Multiple events\n\nIt is possible to send events as a batch when sending multiple events to a topic or a domain. This example sends a list of CloudEvents using the send method.\n\n**WARNING:** When sending a list of multiple events at one time, iterating over and sending each event will not result in optimal performance. For best performance, it is highly recommended to send a list of events.\n\n```python\nimport os\nfrom azure.core.credentials import AzureKeyCredential\nfrom azure.core.messaging import CloudEvent\nfrom azure.eventgrid import EventGridPublisherClient\n\nkey = os.environ[\"EVENTGRID_KEY\"]\nendpoint = os.environ[\"EVENTGRID_ENDPOINT\"]\ntopic_name = os.environ[\"EVENTGRID_TOPIC_NAME\"]\n\nevent0 = CloudEvent(\n type=\"Azure.Sdk.Sample\",\n source=\"https://egsample.dev/sampleevent\",\n data={\"team\": \"azure-sdk\"}\n)\nevent1 = CloudEvent(\n type=\"Azure.Sdk.Sample\",\n source=\"https://egsample.dev/sampleevent\",\n data={\"team2\": \"azure-eventgrid\"}\n)\n\nevents = [event0, event1]\n\ncredential = AzureKeyCredential(key)\nclient = EventGridPublisherClient(endpoint, credential, namespace_topic=topic_name)\n\nclient.send(events)\n```\n\n### Receive and Process Events from Namespace\n\nUse EventGridConsumerClient's receive function to receive CloudEvents from a Namespace event subscription. Then try to acknowledge, reject, release or renew the locks. \n\n```python\nimport os\nimport uuid\nimport datetime as dt\nfrom azure.core.credentials import AzureKeyCredential\nfrom azure.eventgrid import EventGridConsumerClient\n\nkey = os.environ[\"EVENTGRID_KEY\"]\nendpoint = os.environ[\"EVENTGRID_ENDPOINT\"]\ntopic_name = os.environ[\"EVENTGRID_TOPIC_NAME\"]\nsub_name = os.environ[\"EVENTGRID_EVENT_SUBSCRIPTION_NAME\"]\n\ncredential = AzureKeyCredential(key)\nclient = EventGridConsumerClient(endpoint, credential, namespace_topic=topic_name, subscription=sub_name)\n\nevents = client.receive(max_events=4)\n\nfor detail in events.value:\n data = detail.event.data\n broker_properties = detail.broker_properties\n if data == \"release\":\n release_events.append(broker_properties.lock_token)\n elif data == \"acknowledge\":\n acknowledge_events.append(broker_properties.lock_token)\n else:\n reject_events.append(broker_properties.lock_token)\n\n # Renew all Locks\n renew_tokens = e.broker_properties.lock_token\n renew_result = client.renew_locks(\n lock_tokens=renew_tokens,\n )\n\n\nrelease_result = client.release(\n lock_tokens=release_events,\n)\n\nack_result = client.acknowledge(\n lock_tokens=acknowledge_events,\n)\n\nreject_result = client.reject(\n lock_tokens=reject_events,\n)\n\n```\n\n## Distributed Tracing with Event Grid\n\nYou can use OpenTelemetry for Python as usual with Event Grid since it's compatible with azure-core tracing integration.\n\nHere is an example of using OpenTelemetry to trace sending a CloudEvent.\n\nFirst, set OpenTelemetry as enabled tracing plugin for Event Grid.\n\n```python\nfrom azure.core.settings import settings\nfrom azure.core.tracing.ext.opentelemetry_span import OpenTelemetrySpan\n\nsettings.tracing_implementation = OpenTelemetrySpan\n```\n\nRegular open telemetry usage from here. See [OpenTelemetry](https://github.com/open-telemetry/opentelemetry-python) for details.\nThis example uses a simple console exporter to export the traces. Any exporter can be used here including `azure-monitor-opentelemetry-exporter`, `jaeger`, `zipkin` etc.\n\n```python\nfrom opentelemetry import trace\nfrom opentelemetry.sdk.trace import TracerProvider\nfrom opentelemetry.sdk.trace.export import ConsoleSpanExporter\nfrom opentelemetry.sdk.trace.export import SimpleSpanProcessor # this requires opentelemetry >= 1.0.0\n\n# Simple console exporter\nexporter = ConsoleSpanExporter()\n\ntrace.set_tracer_provider(TracerProvider())\ntracer = trace.get_tracer(__name__)\ntrace.get_tracer_provider().add_span_processor(\n SimpleSpanProcessor(exporter)\n)\n```\n\nOnce the `tracer` and `exporter` are set, please follow the example below to start collecting traces while using the `send` method from the `EventGridClient` to send a CloudEvent object.\n\n```python\nimport os\nfrom azure.eventgrid import EventGridPublisherClient\nfrom azure.core.messaging import CloudEvent\nfrom azure.core.credentials import AzureKeyCredential\n\nhostname = os.environ['CLOUD_TOPIC_HOSTNAME']\nkey = AzureKeyCredential(os.environ['CLOUD_ACCESS_KEY'])\ncloud_event = CloudEvent(\n source = 'demo',\n type = 'sdk.demo',\n data = {'test': 'hello'},\n)\nwith tracer.start_as_current_span(name=\"MyApplication\"):\n client = EventGridPublisherClient(hostname, key)\n client.send(cloud_event)\n```\n\n## Troubleshooting\n\n- Enable `azure.eventgrid` logger to collect traces from the library.\n\n### General\nEvent Grid client library will raise exceptions defined in [Azure Core][azure_core_exceptions].\n\n### Logging\nThis library uses the standard\n[logging][python_logging] library for logging.\nBasic information about HTTP sessions (URLs, headers, etc.) is logged at INFO\nlevel.\n\n### Optional Configuration\n\nOptional keyword arguments can be passed in at the client and per-operation level.\nThe azure-core [reference documentation][azure_core_ref_docs]\ndescribes available configurations for retries, logging, transport protocols, and more.\n\n## Next steps\n\nThe following section provides several code snippets illustrating common patterns used in the Event Grid Python API.\n\n### More sample code\n\nThese code samples show common champion scenario operations with the Azure Event Grid client library.\n\n#### Additional Namespace Event Grid Scenarios\n\n* Authenticate the client: [sample_namespace_authentication_async.py][python-eg-namespace-authenticate-async]\n* Publish to the namespace topic: [sample_publish_cloud_event_async.py][python-eg-namespace-publish-cloud-async]\n* Consume and Process from an event subscription: [sample_consume_process_events.py][python-eg-namespace-consume-async]\n\n\n#### Additional Basic Event Grid Scenarios\n\n* Generate Shared Access Signature: [sample_generate_sas.py][python-eg-generate-sas]\n\n* Authenticate the client: [sample_authentication.py][python-eg-auth] ([async_version][python-eg-auth-async])\n\n* Publish events to a topic using SAS: [sample_publish_events_to_a_topic_using_sas_credential_async.py][python-eg-sample-send-using-sas] ([async_version][python-eg-sample-send-using-sas-async])\n* Publish Event Grid Events to a topic: [sample_publish_eg_events_to_a_topic.py][python-eg-sample-eg-event] ([async_version][python-eg-sample-eg-event-async])\n* Publish Event Grid Events to a domain topic: [sample_publish_eg_events_to_a_domain_topic.py][python-eg-sample-eg-event-to-domain] ([async_version][python-eg-sample-eg-event-to-domain-async])\n* Publish a Cloud Event: [sample_publish_events_using_cloud_events_1.0_schema.py][python-eg-sample-send-cloudevent] ([async_version][python-eg-sample-send-cloudevent-async])\n* Publish a Custom Schema: [sample_publish_custom_schema_to_a_topic.py][python-eg-publish-custom-schema] ([async_version][python-eg-publish-custom-schema-async])\n\nThe following samples cover publishing and consuming `dict` representations of EventGridEvents and CloudEvents.\n* Publish EventGridEvent as dict like representation: [sample_publish_eg_event_using_dict.py][python-eg-sample-send-eg-as-dict] ([async_version][python-eg-sample-send-eg-as-dict-async])\n\n* Publish CloudEvent as dict like representation: [sample_publish_cloud_event_using_dict.py][python-eg-sample-send-cloudevent-as-dict] ([async_version][python-eg-sample-send-cloudevent-as-dict-async])\n\n* Consume a Custom Payload of raw cloudevent data: [sample_consume_custom_payload.py][python-eg-sample-consume-custom-payload]\n\nMore samples can be found [here][python-eg-samples].\n\n* More samples related to the send scenario can be seen [here][python-eg-publish-samples].\n* To see more samples related to consuming a payload from different messaging services as a typed object, please visit [Consume Samples][python-eg-consume-samples]\n\n### Additional documentation\n\nFor more extensive documentation on Azure Event Grid, see the [Event Grid documentation][python-eg-product-docs] on docs.microsoft.com.\n\n## Contributing\nThis 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][cla].\n\nWhen 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.\n\nThis project has adopted the [Microsoft Open Source Code of Conduct][code_of_conduct]. For more information see the [Code of Conduct FAQ][coc_faq] or contact [opencode@microsoft.com][coc_contact] with any additional questions or comments.\n\n<!-- LINKS -->\n\n[azure_cli_link]: https://pypi.org/project/azure-cli/\n[python-eg-src]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/eventgrid/azure-eventgrid\n[python-eg-pypi]: https://pypi.org/project/azure-eventgrid\n[python-eg-product-docs]: https://docs.microsoft.com/azure/event-grid/overview\n[python-eg-ref-docs]: https://azuresdkdocs.blob.core.windows.net/$web/python/azure-eventgrid/latest/index.html\n[publisher-service-doc]: https://docs.microsoft.com/azure/event-grid/concepts\n[python-eg-samples]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/eventgrid/azure-eventgrid/samples\n[python-eg-changelog]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/eventgrid/azure-eventgrid/CHANGELOG.md\n[pip]: https://pypi.org/project/pip/\n\n[azure_portal_create_EG_resource]: https://ms.portal.azure.com/#blade/HubsExtension/BrowseResource/resourceType/Microsoft.EventGrid%2Ftopics\n[azure-key-credential]: https://aka.ms/azsdk/python/core/azurekeycredential\n[azure_core_exceptions]: https://aka.ms/azsdk/python/core/docs#module-azure.core.exceptions\n[python_logging]: https://docs.python.org/3/library/logging.html\n[azure_core_ref_docs]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/core/azure-core#configurations\n[azure_subscription]: https://azure.microsoft.com/free/\n\n[python-eg-auth]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/basic/sync_samples/sample_authentication.py\n[python-eg-generate-sas]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/basic/sync_samples/sample_generate_sas.py\n[python-eg-sample-send-using-sas]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/basic/sync_samples/sample_publish_events_to_a_topic_using_sas_credential.py\n[python-eg-sample-eg-event]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/basic/sync_samples/sample_publish_eg_events_to_a_topic.py\n[python-eg-sample-eg-event-to-domain]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/basic/sync_samples/sample_publish_eg_events_to_a_domain.py\n[python-eg-sample-send-cloudevent]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/basic/sync_samples/sample_publish_events_using_cloud_events_1.0_schema.py\n[python-eg-publish-custom-schema]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/basic/sync_samples/sample_publish_custom_schema_to_a_topic.py\n[python-eg-sample-send-eg-as-dict]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/basic/sync_samples/sample_publish_eg_event_using_dict.py\n[python-eg-sample-send-cloudevent-as-dict]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/basic/sync_samples/sample_publish_cloud_event_using_dict.py\n\n[python-eg-auth-async]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/basic/async_samples/sample_authentication_async.py\n[python-eg-sample-send-using-sas-async]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/basic/async_samples/sample_publish_events_to_a_topic_using_sas_credential_async.py\n[python-eg-sample-eg-event-async]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/basic/async_samples/sample_publish_eg_events_to_a_topic_async.py\n[python-eg-sample-eg-event-to-domain-async]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/basic/async_samples/sample_publish_eg_events_to_a_domain_async.py\n[python-eg-sample-send-cloudevent-async]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/basic/async_samples/sample_publish_events_using_cloud_events_1.0_schema_async.py\n[python-eg-publish-custom-schema-async]:https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/basic/async_samples/sample_publish_custom_schema_to_a_topic_async.py\n[python-eg-sample-send-eg-as-dict-async]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/basic/async_samples/sample_publish_eg_event_using_dict_async.py\n[python-eg-sample-send-cloudevent-as-dict-async]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/basic/async_samples/sample_publish_cloud_event_using_dict_async.py\n\n[python-eg-publish-samples]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/basic/publish_samples\n[python-eg-consume-samples]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/basic/consume_samples\n[python-eg-sample-consume-custom-payload]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/basic/sync_samples/sample_consume_custom_payload.py\n\n\n[python-eg-namespace-authenticate]:https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/namespace/sync_samples/sample_namespace_authentication.py\n[python-eg-namespace-publish-cncf]:https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/namespace/sync_samples/sample_publish_cncf_events.py\n[python-eg-namespace-publish-cloud]:https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/namespace/sync_samples/sample_publish_cloud_event.py\n[python-eg-namespace-consume]:https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/namespace/samples/sync_samples/sample_consume_process_events.py\n\n\n[python-eg-namespace-authenticate-async]:https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/namespace/async_samples/sample_namespace_authentication_async.py\n[python-eg-namespace-publish-cncf-async]:https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/namespace/async_samples/sample_publish_cncf_events_async.py\n[python-eg-namespace-publish-cloud-async]:https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/namespace/async_samples/sample_publish_cloud_event_async.py\n[python-eg-namespace-consume-async]:https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventgrid/azure-eventgrid/samples/namespace/async_samples/sample_consume_process_events_async.py\n\n[cla]: https://cla.microsoft.com\n[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/\n[coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/\n[coc_contact]: mailto:opencode@microsoft.com\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Microsoft Azure Event Grid Client Library for Python",
"version": "4.21.0",
"project_urls": {
"Homepage": "https://github.com/Azure/azure-sdk-for-python/tree/main/sdk"
},
"split_keywords": [
"azure",
" azure sdk"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "d652a287999d73fc2c63a3fb723c5720863d3dfad88b1d834437032821f3c545",
"md5": "65eacc64253fe1cf6bcd563fdca7a899",
"sha256": "1ed6f028ecb03b08918976316d4c1d3a41d0a169a73f9551dff26575ba213b57"
},
"downloads": -1,
"filename": "azure_eventgrid-4.21.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "65eacc64253fe1cf6bcd563fdca7a899",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 128089,
"upload_time": "2024-11-19T17:11:18",
"upload_time_iso_8601": "2024-11-19T17:11:18.815931Z",
"url": "https://files.pythonhosted.org/packages/d6/52/a287999d73fc2c63a3fb723c5720863d3dfad88b1d834437032821f3c545/azure_eventgrid-4.21.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "614d3029224304d6f5cfc6bdb3ef278f7249d8ccfecbb4a335f326b9d2009c98",
"md5": "a4d8ebec8d582f89bb29b62e154520d3",
"sha256": "1c4d7f1cfa9a26b3158cfae5667ee599df30bd767a2aaf64fc231f741953ce01"
},
"downloads": -1,
"filename": "azure_eventgrid-4.21.0.tar.gz",
"has_sig": false,
"md5_digest": "a4d8ebec8d582f89bb29b62e154520d3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 133920,
"upload_time": "2024-11-19T17:11:16",
"upload_time_iso_8601": "2024-11-19T17:11:16.822630Z",
"url": "https://files.pythonhosted.org/packages/61/4d/3029224304d6f5cfc6bdb3ef278f7249d8ccfecbb4a335f326b9d2009c98/azure_eventgrid-4.21.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-19 17:11:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Azure",
"github_project": "azure-sdk-for-python",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "azure-eventgrid"
}
JSON
