Skip to content

AzureeventgridClient

Attributes

EventSchema module-attribute 

EventSchema = List[Dict[str, Any]]

TRIGGER_OPERATIONS module-attribute 

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'CreateSubscription': {'operation_id': 'CreateSubscription', 'path': '/{connectionId}/subscriptions/{subscriptionId}/providers/{resourceType}/resource/eventSubscriptions', 'method': 'post', 'required_parameters': ['subscriptionId', 'resourceType', 'body'], 'callback_payload_type': None}}

Classes

SubscriptionListResult dataclass 

SubscriptionListResult(value: Optional[List[Subscription]] = None)

Response for List subscriptions

Attributes

value class-attribute instance-attribute 
value: Optional[List[Subscription]] = None

The subscriptions available to the user.

TopicTypesResponse dataclass 

TopicTypesResponse(value: Optional[List[Dict[str, Any]]] = None)

Response for TopicTypes_List

EventRequest dataclass 

EventRequest(properties: Optional[Dict[str, Any]] = None)

Definition: EventRequest

EventTypesResponse dataclass 

EventTypesResponse(value: Optional[List[Dict[str, Any]]] = None)

Definition: EventTypesResponse

ResourceNameResponse dataclass 

ResourceNameResponse(value: Optional[List[Dict[str, Any]]] = None)

Definition: ResourceNameResponse

Subscription dataclass 

Subscription(id: Optional[str] = None, subscription_id: Optional[str] = None, display_name: Optional[str] = None)

Definition: Subscription

Attributes

id class-attribute instance-attribute 
id: Optional[str] = None

The fully qualified Id. For example, /subscriptions/00000000-0000-0000-0000-000000000000.

subscription_id class-attribute instance-attribute 
subscription_id: Optional[str] = field(default=None, metadata={'wire_name': 'subscriptionId'})

The subscription Id.

display_name class-attribute instance-attribute 
display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

The subscription display name.

AzureeventgridClient 

AzureeventgridClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

Bases: ConnectorClientBase

Typed client for azureeventgrid connector.

Initialize a AzureeventgridClient.

Parameters:

Name Type Description Default
connection_runtime_url str

The connection runtime URL from Azure Portal.

 required
token_provider Optional[TokenProvider]

Optional token provider. Defaults to ManagedIdentityTokenProvider.

 None
options Optional[ConnectorClientOptions]

Optional connector client options.

 None

Methods:

subscriptions_list_async async 
subscriptions_list_async() -> dict[str, Any] | None

List subscriptions

Gets a list of all the subscriptions to which the principal has access.

topic_types_list_async async 
topic_types_list_async() -> dict[str, Any] | None

TopicTypes_List