EventSubscription interface

Package:

@azure/arm-eventgrid

Event Subscription.

Extends

Resource

Properties

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.
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.
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.
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.
eventDeliverySchema	The event delivery schema for the event subscription.
expirationTimeUtc	Expiration time of the event subscription.
filter	Information about the filter for the event subscription.
labels	List of user defined labels.
provisioningState	Provisioning state of the event subscription. NOTE: This property will not be serialized. It can only be populated by the server.
retryPolicy	The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events.
systemData	The system metadata relating to Event Subscription resource. NOTE: This property will not be serialized. It can only be populated by the server.
topic	Name of the topic of the event subscription. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id	Fully qualified identifier of the resource. NOTE: This property will not be serialized. It can only be populated by the server.
name	Name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.
type	Type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

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.

deadLetterDestination?: DeadLetterDestinationUnion

Property Value

DeadLetterDestinationUnion

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.

deadLetterWithResourceIdentity?: DeadLetterWithResourceIdentity

Property Value

DeadLetterWithResourceIdentity

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.

deliveryWithResourceIdentity?: DeliveryWithResourceIdentity

Property Value

DeliveryWithResourceIdentity

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?: EventSubscriptionDestinationUnion

Property Value

EventSubscriptionDestinationUnion

eventDeliverySchema

The event delivery schema for the event subscription.

eventDeliverySchema?: string

Property Value

string

expirationTimeUtc

Expiration time of the event subscription.

expirationTimeUtc?: Date

Property Value

Date

filter

Information about the filter for the event subscription.

filter?: EventSubscriptionFilter

Property Value

EventSubscriptionFilter

labels

List of user defined labels.

labels?: string[]

Property Value

string[]

provisioningState

Provisioning state of the event subscription. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

retryPolicy

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

retryPolicy?: RetryPolicy

Property Value

RetryPolicy

systemData

The system metadata relating to Event Subscription resource. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

topic

Name of the topic of the event subscription. NOTE: This property will not be serialized. It can only be populated by the server.

topic?: string

Property Value

string

Inherited Property Details

id

Fully qualified identifier of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From Resource.id

name

Name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From Resource.name

type

Type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From Resource.type