azure.eventgrid package¶

Subpackages¶

class azure.eventgrid.event_grid_client.EventGridClient(credentials)[source]¶

EventGrid Client

Variables: config (EventGridClientConfiguration) – Configuration for client.
Parameters: credentials (None) – Subscription credentials which uniquely identify client subscription.

publish_events(topic_hostname, events, custom_headers=None, raw=False, **operation_config)[source]¶

Publishes a batch of events to an Azure Event Grid topic.

Parameters

topic_hostname (str) – The host name of the topic, e.g. topic1.westus2-1.eventgrid.azure.net
events (list[EventGridEvent]) – An array of events to be published to Event Grid.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

HttpOperationError

class azure.eventgrid.event_grid_client.EventGridClientConfiguration(credentials)[source]¶

Configuration for EventGridClient Note that all parameters used to create this instance are saved as instance attributes.

Parameters: credentials (None) – Subscription credentials which uniquely identify client subscription.

add_user_agent(value)¶

Add value to current user agent with a space.

load(filepath)¶

Load configuration from existing file.

save(filepath)¶

Save current configuration to file.

Parameters: filepath (str) – Path to file where settings will be saved.
Raises: ValueError if supplied filepath cannot be written to.

class azure.eventgrid.EventGridClient(credentials)[source]¶