eventgrid Package

Reference

Packages

aio

Classes

EventGridEvent

Properties of an event published to an Event Grid topic using the EventGrid Schema.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

EventGridPublisherClient

EventGridPublisherClient publishes events to an EventGrid topic or domain. It can be used to publish either an EventGridEvent, a CloudEvent or a Custom Schema.

Enums

SystemEventNames

This enum represents the names of the various event types for the system events published to Azure Event Grid. To check the list of recognizable system topics, visit https://docs.microsoft.com/azure/event-grid/system-topics.

Functions

generate_sas

Helper method to generate shared access signature given hostname, key, and expiration date. :param str endpoint: The topic endpoint to send the events to.

Similar to .-1.eventgrid.azure.net

generate_sas(endpoint: str, shared_access_key: str, expiration_date_utc: datetime, **kwargs: Any) -> str

Parameters

shared_access_key: str

Required

The shared access key to be used for generating the token

expiration_date_utc: datetime

Required

The expiration datetime in UTC for the signature.

api_version: str

The API Version to include in the signature. If not provided, the default API version will be used.

Return type

str