Microsoft.EventGrid eventSubscriptions 2019-01-01

Article
12/09/2024

Bicep resource definition

The eventSubscriptions resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.EventGrid/eventSubscriptions resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.EventGrid/eventSubscriptions@2019-01-01' = {
  scope: resourceSymbolicName or scope
  name: 'string'
  properties: {
    deadLetterDestination: {
      endpointType: 'string'
      // For remaining properties, see DeadLetterDestination objects
    }
    destination: {
      endpointType: 'string'
      // For remaining properties, see EventSubscriptionDestination objects
    }
    filter: {
      includedEventTypes: [
        'string'
      ]
      isSubjectCaseSensitive: bool
      subjectBeginsWith: 'string'
      subjectEndsWith: 'string'
    }
    labels: [
      'string'
    ]
    retryPolicy: {
      eventTimeToLiveInMinutes: int
      maxDeliveryAttempts: int
    }
  }
}

EventSubscriptionDestination objects

Set the endpointType property to specify the type of object.

For EventHub, use:

{
  endpointType: 'EventHub'
  properties: {
    resourceId: 'string'
  }
}

For HybridConnection, use:

{
  endpointType: 'HybridConnection'
  properties: {
    resourceId: 'string'
  }
}

For StorageQueue, use:

{
  endpointType: 'StorageQueue'
  properties: {
    queueName: 'string'
    resourceId: 'string'
  }
}

For WebHook, use:

{
  endpointType: 'WebHook'
  properties: {
    endpointUrl: 'string'
  }
}

DeadLetterDestination objects

Set the endpointType property to specify the type of object.

For StorageBlob, use:

{
  endpointType: 'StorageBlob'
  properties: {
    blobContainerName: 'string'
    resourceId: 'string'
  }
}

Property values

DeadLetterDestination

Name	Description	Value
endpointType	Set to 'StorageBlob' for type StorageBlobDeadLetterDestination.	'StorageBlob' (required)

EventHubEventSubscriptionDestination

Name	Description	Value
endpointType	Type of the endpoint for the event subscription destination	'EventHub' (required)
properties	Event Hub Properties of the event subscription destination	EventHubEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestinationProperties

Name	Description	Value
resourceId	The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription.	string

EventSubscriptionDestination

Name	Description	Value
endpointType	Set to 'EventHub' for type EventHubEventSubscriptionDestination. Set to 'HybridConnection' for type HybridConnectionEventSubscriptionDestination. Set to 'StorageQueue' for type StorageQueueEventSubscriptionDestination. Set to 'WebHook' for type WebHookEventSubscriptionDestination.	'EventHub' 'HybridConnection' 'StorageQueue' 'WebHook' (required)

EventSubscriptionFilter

Name	Description	Value
includedEventTypes	A list of applicable event types that need to be part of the event subscription. If it is desired to subscribe to all event types, the string "all" needs to be specified as an element in this list.	string[]
isSubjectCaseSensitive	Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner.	bool
subjectBeginsWith	An optional string to filter events for an event subscription based on a resource path prefix. The format of this depends on the publisher of the events. Wildcard characters are not supported in this path.	string
subjectEndsWith	An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path.	string

EventSubscriptionProperties

Name	Description	Value
deadLetterDestination	The DeadLetter destination of the event subscription.	DeadLetterDestination
destination	Information about the destination where events have to be delivered for the event subscription.	EventSubscriptionDestination
filter	Information about the filter for the event subscription.	EventSubscriptionFilter
labels	List of user defined labels.	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

HybridConnectionEventSubscriptionDestination

Name	Description	Value
endpointType	Type of the endpoint for the event subscription destination	'HybridConnection' (required)
properties	Hybrid connection Properties of the event subscription destination	HybridConnectionEventSubscriptionDestinationProperties

HybridConnectionEventSubscriptionDestinationProperties

Name	Description	Value
resourceId	The Azure Resource ID of an hybrid connection that is the destination of an event subscription.	string