Microsoft.EventGrid namespaces/topics/eventSubscriptions 2024-12-15-preview

Article
12/09/2024

Bicep resource definition

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

Resource groups - See resource group deployment commands

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

Resource format

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

resource symbolicname 'Microsoft.EventGrid/namespaces/topics/eventSubscriptions@2024-12-15-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    deliveryConfiguration: {
      deliveryMode: 'string'
      push: {
        deadLetterDestinationWithResourceIdentity: {
          deadLetterDestination: {
            endpointType: 'string'
            // For remaining properties, see DeadLetterDestination objects
          }
          identity: {
            federatedIdentityCredentialInfo: {
              federatedClientId: 'string'
            }
            type: 'string'
            userAssignedIdentity: 'string'
          }
        }
        deliveryWithResourceIdentity: {
          destination: {
            endpointType: 'string'
            // For remaining properties, see EventSubscriptionDestination objects
          }
          identity: {
            federatedIdentityCredentialInfo: {
              federatedClientId: 'string'
            }
            type: 'string'
            userAssignedIdentity: 'string'
          }
        }
        destination: {
          endpointType: 'string'
          // For remaining properties, see EventSubscriptionDestination objects
        }
        eventTimeToLive: 'string'
        maxDeliveryCount: int
      }
      queue: {
        deadLetterDestinationWithResourceIdentity: {
          deadLetterDestination: {
            endpointType: 'string'
            // For remaining properties, see DeadLetterDestination objects
          }
          identity: {
            federatedIdentityCredentialInfo: {
              federatedClientId: 'string'
            }
            type: 'string'
            userAssignedIdentity: 'string'
          }
        }
        eventTimeToLive: 'string'
        maxDeliveryCount: int
        receiveLockDurationInSeconds: int
      }
    }
    eventDeliverySchema: 'string'
    expirationTimeUtc: 'string'
    filtersConfiguration: {
      filters: [
        {
          key: 'string'
          operatorType: 'string'
          // For remaining properties, see Filter objects
        }
      ]
      includedEventTypes: [
        'string'
      ]
    }
    tags: {
      {customized property}: 'string'
    }
  }
}

Filter objects

Set the operatorType property to specify the type of object.

For BoolEquals, use:

{
  operatorType: 'BoolEquals'
  value: bool
}

For IsNotNull, use:

{
  operatorType: 'IsNotNull'
}

For IsNullOrUndefined, use:

{
  operatorType: 'IsNullOrUndefined'
}

For NumberGreaterThan, use:

{
  operatorType: 'NumberGreaterThan'
  value: int
}

For NumberGreaterThanOrEquals, use:

{
  operatorType: 'NumberGreaterThanOrEquals'
  value: int
}

For NumberIn, use:

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

For NumberInRange, use:

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

For NumberLessThan, use:

{
  operatorType: 'NumberLessThan'
  value: int
}

For NumberLessThanOrEquals, use:

{
  operatorType: 'NumberLessThanOrEquals'
  value: int
}

For NumberNotIn, use:

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

For NumberNotInRange, use:

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

For StringBeginsWith, use:

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

For StringContains, use:

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

For StringEndsWith, use:

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

For StringIn, use:

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

For StringNotBeginsWith, use:

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

For StringNotContains, use:

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

For StringNotEndsWith, use:

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

For StringNotIn, use:

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

EventSubscriptionDestination objects

Set the endpointType property to specify the type of object.

For AzureFunction, use:

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

For EventHub, use:

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

For HybridConnection, use:

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

For MonitorAlert, use:

{
  endpointType: 'MonitorAlert'
  properties: {
    actionGroups: [
      'string'
    ]
    description: 'string'
    severity: 'string'
  }
}

For NamespaceTopic, use:

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

For PartnerDestination, use:

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

For ServiceBusQueue, use:

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

For ServiceBusTopic, use:

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

For StorageQueue, use:

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

For WebHook, use:

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

DeadLetterDestination objects

Set the endpointType property to specify the type of object.

For StorageBlob, use:

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

DeliveryAttributeMapping objects

Set the type property to specify the type of object.

For Dynamic, use:

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

For Static, use:

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

Property Values

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

BoolEqualsFilter

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 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)

DeliveryConfiguration

Name	Description	Value
deliveryMode	Delivery mode of the event subscription.	'Push' 'Queue'
push	This property should be populated when deliveryMode is push and represents information about the push subscription.	PushInfo
queue	This property should be populated when deliveryMode is queue and represents information about the queue subscription.	QueueInfo

DeliveryWithResourceIdentity

Name	Description	Value
destination	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.	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 'MonitorAlert' for type MonitorAlertEventSubscriptionDestination. Set to 'NamespaceTopic' for type NamespaceTopicEventSubscriptionDestination. Set to 'PartnerDestination' for type PartnerEventSubscriptionDestination. 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' 'MonitorAlert' 'NamespaceTopic' 'PartnerDestination' 'ServiceBusQueue' 'ServiceBusTopic' 'StorageQueue' 'WebHook' (required)

EventSubscriptionIdentity

Name	Description	Value
federatedIdentityCredentialInfo	The details of the Federated Identity Credential (FIC) used with the resource delivery.	FederatedIdentityCredentialInfo
type	The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'.	'SystemAssigned' 'UserAssigned'
userAssignedIdentity	The user identity associated with the resource.	string

FederatedIdentityCredentialInfo

Name	Description	Value
federatedClientId	The Multi-Tenant AAD Application where the Federated Identity Credential (FIC) is associated with.	string Constraints: Min length = 36 Max length = 36 Pattern = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$` (required)

Filter

Name	Description	Value
key	The field/property in the event based on which you want to filter.	string
operatorType	Set to 'BoolEquals' for type BoolEqualsFilter. Set to 'IsNotNull' for type IsNotNullFilter. Set to 'IsNullOrUndefined' for type IsNullOrUndefinedFilter. Set to 'NumberGreaterThan' for type NumberGreaterThanFilter. Set to 'NumberGreaterThanOrEquals' for type NumberGreaterThanOrEqualsFilter. Set to 'NumberIn' for type NumberInFilter. Set to 'NumberInRange' for type NumberInRangeFilter. Set to 'NumberLessThan' for type NumberLessThanFilter. Set to 'NumberLessThanOrEquals' for type NumberLessThanOrEqualsFilter. Set to 'NumberNotIn' for type NumberNotInFilter. Set to 'NumberNotInRange' for type NumberNotInRangeFilter. Set to 'StringBeginsWith' for type StringBeginsWithFilter. Set to 'StringContains' for type StringContainsFilter. Set to 'StringEndsWith' for type StringEndsWithFilter. Set to 'StringIn' for type StringInFilter. Set to 'StringNotBeginsWith' for type StringNotBeginsWithFilter. Set to 'StringNotContains' for type StringNotContainsFilter. Set to 'StringNotEndsWith' for type StringNotEndsWithFilter. Set to 'StringNotIn' for type StringNotInFilter.	'BoolEquals' 'IsNotNull' 'IsNullOrUndefined' 'NumberGreaterThan' 'NumberGreaterThanOrEquals' 'NumberIn' 'NumberInRange' 'NumberLessThan' 'NumberLessThanOrEquals' 'NumberNotIn' 'NumberNotInRange' 'StringBeginsWith' 'StringContains' 'StringEndsWith' 'StringIn' 'StringNotBeginsWith' 'StringNotContains' 'StringNotEndsWith' 'StringNotIn' (required)

FiltersConfiguration

Name	Description	Value
filters	An array of filters that are used for filtering event subscriptions.	Filter[]
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[]

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

IsNotNullFilter

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

IsNullOrUndefinedFilter

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