EventSubscriptionProperties Class

Properties of the Event Subscription.

Constructor

EventSubscriptionProperties(*args: Any, **kwargs: Any)

Variables

Name Description
topic
str

Name of the topic of the event subscription.

provisioning_state

Provisioning state of the event subscription. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", "Failed", and "AwaitingManualAction".

destination

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

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

Information about the filter for the event subscription.

labels

List of user defined labels.

expiration_time_utc

Expiration time of the event subscription.

event_delivery_schema

The event delivery schema for the event subscription. Known values are: "EventGridSchema", "CustomInputSchema", and "CloudEventSchemaV1_0".

retry_policy

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

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

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.

Attributes

dead_letter_destination

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_destination: _models.DeadLetterDestination | None

dead_letter_with_resource_identity

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.

dead_letter_with_resource_identity: _models.DeadLetterWithResourceIdentity | None

delivery_with_resource_identity

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.

delivery_with_resource_identity: _models.DeliveryWithResourceIdentity | None

destination

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.

destination: _models.EventSubscriptionDestination | None

event_delivery_schema

"EventGridSchema", "CustomInputSchema", and "CloudEventSchemaV1_0".

event_delivery_schema: str | _models.EventDeliverySchema | None

expiration_time_utc

Expiration time of the event subscription.

expiration_time_utc: datetime | None

filter

Information about the filter for the event subscription.

filter: _models.EventSubscriptionFilter | None

labels

List of user defined labels.

labels: list[str] | None

provisioning_state

"Creating", "Updating", "Deleting", "Succeeded", "Canceled", "Failed", and "AwaitingManualAction".

provisioning_state: str | _models.EventSubscriptionProvisioningState | None

retry_policy

The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events.

retry_policy: _models.RetryPolicy | None

topic

Name of the topic of the event subscription.

topic: str | None