Microsoft.EventGrid eventSubscriptions 2021-12-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.

Bicep

resource symbolicname 'Microsoft.EventGrid/eventSubscriptions@2021-12-01' = {
  scope: resourceSymbolicName or scope
  name: 'string'
  properties: {
    deadLetterDestination: {
      endpointType: 'string'
      // For remaining properties, see DeadLetterDestination objects
    }
    deadLetterWithResourceIdentity: {
      deadLetterDestination: {
        endpointType: 'string'
        // For remaining properties, see DeadLetterDestination objects
      }
      identity: {
        type: 'string'
        userAssignedIdentity: 'string'
      }
    }
    deliveryWithResourceIdentity: {
      destination: {
        endpointType: 'string'
        // For remaining properties, see EventSubscriptionDestination objects
      }
      identity: {
        type: 'string'
        userAssignedIdentity: 'string'
      }
    }
    destination: {
      endpointType: 'string'
      // For remaining properties, see EventSubscriptionDestination objects
    }
    eventDeliverySchema: 'string'
    expirationTimeUtc: 'string'
    filter: {
      advancedFilters: [
        {
          key: 'string'
          operatorType: 'string'
          // For remaining properties, see AdvancedFilter objects
        }
      ]
      enableAdvancedFilteringOnArrays: bool
      includedEventTypes: [
        'string'
      ]
      isSubjectCaseSensitive: bool
      subjectBeginsWith: 'string'
      subjectEndsWith: 'string'
    }
    labels: [
      'string'
    ]
    retryPolicy: {
      eventTimeToLiveInMinutes: int
      maxDeliveryAttempts: int
    }
  }
}

AdvancedFilter objects

Set the operatorType property to specify the type of object.

For BoolEquals, use:

Bicep

{
  operatorType: 'BoolEquals'
  value: bool
}

For IsNotNull, use:

Bicep

{
  operatorType: 'IsNotNull'
}

For IsNullOrUndefined, use:

Bicep

{
  operatorType: 'IsNullOrUndefined'
}

For NumberGreaterThan, use:

Bicep

{
  operatorType: 'NumberGreaterThan'
  value: int
}

For NumberGreaterThanOrEquals, use:

Bicep

{
  operatorType: 'NumberGreaterThanOrEquals'
  value: int
}

For NumberIn, use:

Bicep

{
  operatorType: 'NumberIn'
  values: [
    int
  ]
}

For NumberInRange, use:

Bicep

{
  operatorType: 'NumberInRange'
  values: [
    [
      int
    ]
  ]
}

For NumberLessThan, use:

Bicep

{
  operatorType: 'NumberLessThan'
  value: int
}

For NumberLessThanOrEquals, use:

Bicep

{
  operatorType: 'NumberLessThanOrEquals'
  value: int
}

For NumberNotIn, use:

Bicep

{
  operatorType: 'NumberNotIn'
  values: [
    int
  ]
}

For NumberNotInRange, use:

Bicep

{
  operatorType: 'NumberNotInRange'
  values: [
    [
      int
    ]
  ]
}

For StringBeginsWith, use:

Bicep

{
  operatorType: 'StringBeginsWith'
  values: [
    'string'
  ]
}

For StringContains, use:

Bicep

{
  operatorType: 'StringContains'
  values: [
    'string'
  ]
}

For StringEndsWith, use:

Bicep

{
  operatorType: 'StringEndsWith'
  values: [
    'string'
  ]
}

For StringIn, use:

Bicep

{
  operatorType: 'StringIn'
  values: [
    'string'
  ]
}

For StringNotBeginsWith, use:

Bicep

{
  operatorType: 'StringNotBeginsWith'
  values: [
    'string'
  ]
}

For StringNotContains, use:

Bicep

{
  operatorType: 'StringNotContains'
  values: [
    'string'
  ]
}

For StringNotEndsWith, use:

Bicep

{
  operatorType: 'StringNotEndsWith'
  values: [
    'string'
  ]
}

For StringNotIn, use:

Bicep

{
  operatorType: 'StringNotIn'
  values: [
    'string'
  ]
}

EventSubscriptionDestination objects

Set the endpointType property to specify the type of object.

For AzureFunction, use:

Bicep

{
  endpointType: 'AzureFunction'
  properties: {
    deliveryAttributeMappings: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    maxEventsPerBatch: int
    preferredBatchSizeInKilobytes: int
    resourceId: 'string'
  }
}

For EventHub, use:

Bicep

{
  endpointType: 'EventHub'
  properties: {
    deliveryAttributeMappings: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    resourceId: 'string'
  }
}

For HybridConnection, use:

Bicep

{
  endpointType: 'HybridConnection'
  properties: {
    deliveryAttributeMappings: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    resourceId: 'string'
  }
}

For ServiceBusQueue, use:

Bicep

{
  endpointType: 'ServiceBusQueue'
  properties: {
    deliveryAttributeMappings: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    resourceId: 'string'
  }
}

For ServiceBusTopic, use:

Bicep

{
  endpointType: 'ServiceBusTopic'
  properties: {
    deliveryAttributeMappings: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    resourceId: 'string'
  }
}

For StorageQueue, use:

Bicep

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

For WebHook, use:

Bicep

{
  endpointType: 'WebHook'
  properties: {
    azureActiveDirectoryApplicationIdOrUri: 'string'
    azureActiveDirectoryTenantId: 'string'
    deliveryAttributeMappings: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    endpointUrl: 'string'
    maxEventsPerBatch: int
    preferredBatchSizeInKilobytes: int
  }
}

DeadLetterDestination objects

Set the endpointType property to specify the type of object.

For StorageBlob, use:

Bicep

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

DeliveryAttributeMapping objects

Set the type property to specify the type of object.

For Dynamic, use:

Bicep

{
  properties: {
    sourceField: 'string'
  }
  type: 'Dynamic'
}

For Static, use:

Bicep

{
  properties: {
    isSecret: bool
    value: 'string'
  }
  type: 'Static'
}

Property Values

AdvancedFilter

Name	Description	Value
key	The field/property in the event based on which you want to filter.	string
operatorType	Set to 'BoolEquals' for type BoolEqualsAdvancedFilter. Set to 'IsNotNull' for type IsNotNullAdvancedFilter. Set to 'IsNullOrUndefined' for type IsNullOrUndefinedAdvancedFilter. Set to 'NumberGreaterThan' for type NumberGreaterThanAdvancedFilter. Set to 'NumberGreaterThanOrEquals' for type NumberGreaterThanOrEqualsAdvancedFilter. Set to 'NumberIn' for type NumberInAdvancedFilter. Set to 'NumberInRange' for type NumberInRangeAdvancedFilter. Set to 'NumberLessThan' for type NumberLessThanAdvancedFilter. Set to 'NumberLessThanOrEquals' for type NumberLessThanOrEqualsAdvancedFilter. Set to 'NumberNotIn' for type NumberNotInAdvancedFilter. Set to 'NumberNotInRange' for type NumberNotInRangeAdvancedFilter. Set to 'StringBeginsWith' for type StringBeginsWithAdvancedFilter. Set to 'StringContains' for type StringContainsAdvancedFilter. Set to 'StringEndsWith' for type StringEndsWithAdvancedFilter. Set to 'StringIn' for type StringInAdvancedFilter. Set to 'StringNotBeginsWith' for type StringNotBeginsWithAdvancedFilter. Set to 'StringNotContains' for type StringNotContainsAdvancedFilter. Set to 'StringNotEndsWith' for type StringNotEndsWithAdvancedFilter. Set to 'StringNotIn' for type StringNotInAdvancedFilter.	'BoolEquals' 'IsNotNull' 'IsNullOrUndefined' 'NumberGreaterThan' 'NumberGreaterThanOrEquals' 'NumberIn' 'NumberInRange' 'NumberLessThan' 'NumberLessThanOrEquals' 'NumberNotIn' 'NumberNotInRange' 'StringBeginsWith' 'StringContains' 'StringEndsWith' 'StringIn' 'StringNotBeginsWith' 'StringNotContains' 'StringNotEndsWith' 'StringNotIn' (required)

AzureFunctionEventSubscriptionDestination

Name	Description	Value
endpointType	Type of the endpoint for the event subscription destination.	'AzureFunction' (required)
properties	Azure Function Properties of the event subscription destination.	AzureFunctionEventSubscriptionDestinationProperties

AzureFunctionEventSubscriptionDestinationProperties

Name	Description	Value
deliveryAttributeMappings	Delivery attribute details.	DeliveryAttributeMapping[]
maxEventsPerBatch	Maximum number of events per batch.	int
preferredBatchSizeInKilobytes	Preferred batch size in Kilobytes.	int
resourceId	The Azure Resource Id that represents the endpoint of the Azure Function destination of an event subscription.	string

BoolEqualsAdvancedFilter

Name	Description	Value
operatorType	The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others.	'BoolEquals' (required)
value	The boolean filter value.	bool

DeadLetterDestination

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

DeadLetterWithResourceIdentity

Name	Description	Value
deadLetterDestination	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.	DeadLetterDestination
identity	The identity to use when dead-lettering events.	EventSubscriptionIdentity

DeliveryAttributeMapping

Name	Description	Value
name	Name of the delivery attribute or header.	string
type	Set to 'Dynamic' for type DynamicDeliveryAttributeMapping. Set to 'Static' for type StaticDeliveryAttributeMapping.	'Dynamic' 'Static' (required)

DeliveryWithResourceIdentity

Name	Description	Value
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.	EventSubscriptionDestination
identity	The identity to use when delivering events.	EventSubscriptionIdentity

DynamicDeliveryAttributeMapping

Name	Description	Value
properties	Properties of dynamic delivery attribute mapping.	DynamicDeliveryAttributeMappingProperties
type	Type of the delivery attribute or header name.	'Dynamic' (required)

DynamicDeliveryAttributeMappingProperties

Name	Description	Value
sourceField	JSON path in the event which contains attribute value.	string

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
deliveryAttributeMappings	Delivery attribute details.	DeliveryAttributeMapping[]
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 'AzureFunction' for type AzureFunctionEventSubscriptionDestination. Set to 'EventHub' for type EventHubEventSubscriptionDestination. Set to 'HybridConnection' for type HybridConnectionEventSubscriptionDestination. Set to 'ServiceBusQueue' for type ServiceBusQueueEventSubscriptionDestination. Set to 'ServiceBusTopic' for type ServiceBusTopicEventSubscriptionDestination. Set to 'StorageQueue' for type StorageQueueEventSubscriptionDestination. Set to 'WebHook' for type WebHookEventSubscriptionDestination.	'AzureFunction' 'EventHub' 'HybridConnection' 'ServiceBusQueue' 'ServiceBusTopic' 'StorageQueue' 'WebHook' (required)

EventSubscriptionFilter

Name	Description	Value
advancedFilters	An array of advanced filters that are used for filtering event subscriptions.	AdvancedFilter[]
enableAdvancedFilteringOnArrays	Allows advanced filters to be evaluated against an array of values instead of expecting a singular value.	bool
includedEventTypes	A list of applicable event types that need to be part of the event subscription. If it is desired to subscribe to all default event types, set the IncludedEventTypes to null.	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

EventSubscriptionIdentity

Name	Description	Value
type	The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity.	'SystemAssigned' 'UserAssigned'
userAssignedIdentity	The user identity associated with the resource.	string

EventSubscriptionProperties

Name	Description	Value
deadLetterDestination	The DeadLetter destination of the event subscription.	DeadLetterDestination
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
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
destination	Information about the destination where events have to be delivered for the event subscription.	EventSubscriptionDestination
eventDeliverySchema	The event delivery schema for the event subscription.	'CloudEventSchemaV1_0' 'CustomInputSchema' 'EventGridSchema'
expirationTimeUtc	Expiration time of the event subscription.	string
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
deliveryAttributeMappings	Delivery attribute details.	DeliveryAttributeMapping[]
resourceId	The Azure Resource ID of an hybrid connection that is the destination of an event subscription.	string

IsNotNullAdvancedFilter

Name	Description	Value
operatorType	The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others.	'IsNotNull' (required)

IsNullOrUndefinedAdvancedFilter

Name	Description	Value
operatorType	The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others.	'IsNullOrUndefined' (required)