EventSubscription Class

Reference

Event Subscription.

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

Inheritance: azure.mgmt.eventgrid.models._models_py3.Resource

EventSubscription

Constructor

EventSubscription(*, destination: EventSubscriptionDestination | None = None, delivery_with_resource_identity: DeliveryWithResourceIdentity | None = None, filter: EventSubscriptionFilter | None = None, labels: List[str] | None = None, expiration_time_utc: datetime | None = None, event_delivery_schema: str | EventDeliverySchema | None = None, retry_policy: RetryPolicy | None = None, dead_letter_destination: DeadLetterDestination | None = None, dead_letter_with_resource_identity: DeadLetterWithResourceIdentity | None = None, **kwargs)

Keyword-Only Parameters

Name	Description
destination	EventSubscriptionDestination Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering.
delivery_with_resource_identity	DeliveryWithResourceIdentity Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering.
filter	EventSubscriptionFilter Information about the filter for the event subscription.
labels	list[str] List of user defined labels.
expiration_time_utc	datetime Expiration time of the event subscription.
event_delivery_schema	str or EventDeliverySchema The event delivery schema for the event subscription. Possible values include: "EventGridSchema", "CustomInputSchema", "CloudEventSchemaV1_0".
retry_policy	RetryPolicy The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events.
dead_letter_destination	DeadLetterDestination The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering.
dead_letter_with_resource_identity	DeadLetterWithResourceIdentity The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering.

Variables

Name	Description
id	str Fully qualified identifier of the resource.
name	str Name of the resource.
type	str Type of the resource.
system_data	SystemData The system metadata relating to Event Subscription resource.
topic	str Name of the topic of the event subscription.
provisioning_state	str or EventSubscriptionProvisioningState Provisioning state of the event subscription. Possible values include: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", "Failed", "AwaitingManualAction".
destination	EventSubscriptionDestination Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering.
delivery_with_resource_identity	DeliveryWithResourceIdentity Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering.
filter	EventSubscriptionFilter Information about the filter for the event subscription.
labels	list[str] List of user defined labels.
expiration_time_utc	datetime Expiration time of the event subscription.
event_delivery_schema	str or EventDeliverySchema The event delivery schema for the event subscription. Possible values include: "EventGridSchema", "CustomInputSchema", "CloudEventSchemaV1_0".
retry_policy	RetryPolicy The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events.
dead_letter_destination	DeadLetterDestination The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering.
dead_letter_with_resource_identity	DeadLetterWithResourceIdentity The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering.

Share via

EventSubscription Class

Constructor

Keyword-Only Parameters

Variables

Additional resources