Microsoft.EventGrid eventSubscriptions 2019-02-01-preview

Bicep resource definition

The eventSubscriptions resource type is an extension resource, which means you can apply it to another resource.

Use the scope property on this resource to set the scope for this resource. See Set scope on extension resources in Bicep.

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

• Resource groups - See resource group deployment commands
• Subscriptions - See subscription deployment commands

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-02-01-preview' = {
  name: 'string'
  scope: resourceSymbolicName
  properties: {
    deadLetterDestination: {
      endpointType: 'string'
      // For remaining properties, see DeadLetterDestination objects
    }
    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
        }
      ]
      includedEventTypes: [
        'string'
      ]
      isSubjectCaseSensitive: bool
      subjectBeginsWith: 'string'
      subjectEndsWith: 'string'
    }
    labels: [
      'string'
    ]
    retryPolicy: {
      eventTimeToLiveInMinutes: int
      maxDeliveryAttempts: int
    }
  }
}

DeadLetterDestination objects

Set the endpointType property to specify the type of object.

For StorageBlob, use:

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

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 ServiceBusQueue, use:

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

For StorageQueue, use:

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

For WebHook, use:

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

AdvancedFilter objects

Set the operatorType property to specify the type of object.

For BoolEquals, use:

  operatorType: 'BoolEquals'
  value: bool

For NumberGreaterThan, use:

  operatorType: 'NumberGreaterThan'
  value: int

For NumberGreaterThanOrEquals, use:

  operatorType: 'NumberGreaterThanOrEquals'
  value: int

For NumberIn, use:

  operatorType: 'NumberIn'
  values: [
    int
  ]

For NumberLessThan, use:

  operatorType: 'NumberLessThan'
  value: int

For NumberLessThanOrEquals, use:

  operatorType: 'NumberLessThanOrEquals'
  value: int

For NumberNotIn, use:

  operatorType: 'NumberNotIn'
  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 StringNotIn, use:

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

Property values

eventSubscriptions

EventSubscriptionProperties

DeadLetterDestination

StorageBlobDeadLetterDestination

StorageBlobDeadLetterDestinationProperties

EventSubscriptionDestination

EventHubEventSubscriptionDestination

EventHubEventSubscriptionDestinationProperties

HybridConnectionEventSubscriptionDestination

HybridConnectionEventSubscriptionDestinationProperti...

ServiceBusQueueEventSubscriptionDestination

ServiceBusQueueEventSubscriptionDestinationPropertie...

StorageQueueEventSubscriptionDestination

StorageQueueEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestination

WebHookEventSubscriptionDestinationProperties

EventSubscriptionFilter

AdvancedFilter

BoolEqualsAdvancedFilter

NumberGreaterThanAdvancedFilter

NumberGreaterThanOrEqualsAdvancedFilter

NumberInAdvancedFilter

NumberLessThanAdvancedFilter

NumberLessThanOrEqualsAdvancedFilter

NumberNotInAdvancedFilter

StringBeginsWithAdvancedFilter

StringContainsAdvancedFilter

StringEndsWithAdvancedFilter

StringInAdvancedFilter

StringNotInAdvancedFilter

RetryPolicy

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Create Azure Event Grid Custom Topic and Subscription	Creates an Azure Event Grid custom topic and a webhook subscription. Template originally authored by John Downs.
Custom Azure Event Grid Topic/Subscription with CloudEvents	Creates a custom Azure Event Grid topic, a webhook subscription having CloudEvents schema, and a Logic App as an event handler. Template originally authored by Justin Yoo.
Create Event Grid custom topic and event hub handler	Creates an Azure Event Grid custom topic and event hub to handle the events.
Create Event Grid subscription for resource events	Creates Event Grid subscription to either resource group or Azure subscription.
Create Azure Event Grid Custom Topic and Queue Subscription	Creates an Azure Event Grid custom topic and a service bus queue subscription. Template originally authored by Markus Meyer.
Create Azure Event Grid Custom Topic Subscription	Creates an Azure Event Grid custom topic and a service bus topic subscription. Template originally authored by Markus Meyer.

ARM template resource definition

The eventSubscriptions resource type is an extension resource, which means you can apply it to another resource.

Use the scope property on this resource to set the scope for this resource. See Set scope on extension resources in ARM templates.

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

• Resource groups - See resource group deployment commands
• Subscriptions - See subscription deployment commands

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 JSON to your template.

{
  "type": "Microsoft.EventGrid/eventSubscriptions",
  "apiVersion": "2019-02-01-preview",
  "name": "string",
  "scope": "string",
  "properties": {
    "deadLetterDestination": {
      "endpointType": "string"
      // For remaining properties, see DeadLetterDestination objects
    },
    "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
        }
      ],
      "includedEventTypes": [ "string" ],
      "isSubjectCaseSensitive": "bool",
      "subjectBeginsWith": "string",
      "subjectEndsWith": "string"
    },
    "labels": [ "string" ],
    "retryPolicy": {
      "eventTimeToLiveInMinutes": "int",
      "maxDeliveryAttempts": "int"
    }
  }
}

DeadLetterDestination objects

Set the endpointType property to specify the type of object.

For StorageBlob, use:

  "endpointType": "StorageBlob",
  "properties": {
    "blobContainerName": "string",
    "resourceId": "string"
  }

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 ServiceBusQueue, use:

  "endpointType": "ServiceBusQueue",
  "properties": {
    "resourceId": "string"
  }

For StorageQueue, use:

  "endpointType": "StorageQueue",
  "properties": {
    "queueName": "string",
    "resourceId": "string"
  }

For WebHook, use:

  "endpointType": "WebHook",
  "properties": {
    "endpointUrl": "string"
  }

AdvancedFilter objects

Set the operatorType property to specify the type of object.

For BoolEquals, use:

  "operatorType": "BoolEquals",
  "value": "bool"

For NumberGreaterThan, use:

  "operatorType": "NumberGreaterThan",
  "value": "int"

For NumberGreaterThanOrEquals, use:

  "operatorType": "NumberGreaterThanOrEquals",
  "value": "int"

For NumberIn, use:

  "operatorType": "NumberIn",
  "values": [ "int" ]

For NumberLessThan, use:

  "operatorType": "NumberLessThan",
  "value": "int"

For NumberLessThanOrEquals, use:

  "operatorType": "NumberLessThanOrEquals",
  "value": "int"

For NumberNotIn, use:

  "operatorType": "NumberNotIn",
  "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 StringNotIn, use:

  "operatorType": "StringNotIn",
  "values": [ "string" ]

Property values

eventSubscriptions

EventSubscriptionProperties

DeadLetterDestination

StorageBlobDeadLetterDestination

StorageBlobDeadLetterDestinationProperties

EventSubscriptionDestination

EventHubEventSubscriptionDestination

EventHubEventSubscriptionDestinationProperties

HybridConnectionEventSubscriptionDestination

HybridConnectionEventSubscriptionDestinationProperti...

ServiceBusQueueEventSubscriptionDestination

ServiceBusQueueEventSubscriptionDestinationPropertie...

StorageQueueEventSubscriptionDestination

StorageQueueEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestination

WebHookEventSubscriptionDestinationProperties

EventSubscriptionFilter

AdvancedFilter

BoolEqualsAdvancedFilter

NumberGreaterThanAdvancedFilter

NumberGreaterThanOrEqualsAdvancedFilter

NumberInAdvancedFilter

NumberLessThanAdvancedFilter

NumberLessThanOrEqualsAdvancedFilter

NumberNotInAdvancedFilter

StringBeginsWithAdvancedFilter

StringContainsAdvancedFilter

StringEndsWithAdvancedFilter

StringInAdvancedFilter

StringNotInAdvancedFilter

RetryPolicy

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Create Azure Event Grid Custom Topic and Subscription	Creates an Azure Event Grid custom topic and a webhook subscription. Template originally authored by John Downs.
Custom Azure Event Grid Topic/Subscription with CloudEvents	Creates a custom Azure Event Grid topic, a webhook subscription having CloudEvents schema, and a Logic App as an event handler. Template originally authored by Justin Yoo.
Create Event Grid custom topic and event hub handler	Creates an Azure Event Grid custom topic and event hub to handle the events.
Create Event Grid subscription for resource events	Creates Event Grid subscription to either resource group or Azure subscription.
Create Azure Event Grid Custom Topic and Queue Subscription	Creates an Azure Event Grid custom topic and a service bus queue subscription. Template originally authored by Markus Meyer.
Create Azure Event Grid Custom Topic Subscription	Creates an Azure Event Grid custom topic and a service bus topic subscription. Template originally authored by Markus Meyer.

Terraform (AzAPI provider) resource definition

The eventSubscriptions resource type is an extension resource, which means you can apply it to another resource.

Use the parent_id property on this resource to set the scope for this resource.

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

• Resource groups
• Subscriptions

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 Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/eventSubscriptions@2019-02-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      deadLetterDestination = {
        endpointType = "string"
        // For remaining properties, see DeadLetterDestination objects
      }
      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
          }
        ]
        includedEventTypes = [
          "string"
        ]
        isSubjectCaseSensitive = bool
        subjectBeginsWith = "string"
        subjectEndsWith = "string"
      }
      labels = [
        "string"
      ]
      retryPolicy = {
        eventTimeToLiveInMinutes = int
        maxDeliveryAttempts = int
      }
    }
  })
}

DeadLetterDestination objects

Set the endpointType property to specify the type of object.

For StorageBlob, use:

  endpointType = "StorageBlob"
  properties = {
    blobContainerName = "string"
    resourceId = "string"
  }

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 ServiceBusQueue, use:

  endpointType = "ServiceBusQueue"
  properties = {
    resourceId = "string"
  }

For StorageQueue, use:

  endpointType = "StorageQueue"
  properties = {
    queueName = "string"
    resourceId = "string"
  }

For WebHook, use:

  endpointType = "WebHook"
  properties = {
    endpointUrl = "string"
  }

AdvancedFilter objects

Set the operatorType property to specify the type of object.

For BoolEquals, use:

  operatorType = "BoolEquals"
  value = bool

For NumberGreaterThan, use:

  operatorType = "NumberGreaterThan"
  value = int

For NumberGreaterThanOrEquals, use:

  operatorType = "NumberGreaterThanOrEquals"
  value = int

For NumberIn, use:

  operatorType = "NumberIn"
  values = [
    int
  ]

For NumberLessThan, use:

  operatorType = "NumberLessThan"
  value = int

For NumberLessThanOrEquals, use:

  operatorType = "NumberLessThanOrEquals"
  value = int

For NumberNotIn, use:

  operatorType = "NumberNotIn"
  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 StringNotIn, use:

  operatorType = "StringNotIn"
  values = [
    "string"
  ]

Property values

eventSubscriptions

EventSubscriptionProperties

DeadLetterDestination

StorageBlobDeadLetterDestination

StorageBlobDeadLetterDestinationProperties

EventSubscriptionDestination

EventHubEventSubscriptionDestination

EventHubEventSubscriptionDestinationProperties

HybridConnectionEventSubscriptionDestination

HybridConnectionEventSubscriptionDestinationProperti...

ServiceBusQueueEventSubscriptionDestination

ServiceBusQueueEventSubscriptionDestinationPropertie...

StorageQueueEventSubscriptionDestination

StorageQueueEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestination

WebHookEventSubscriptionDestinationProperties

EventSubscriptionFilter

AdvancedFilter

BoolEqualsAdvancedFilter

NumberGreaterThanAdvancedFilter

NumberGreaterThanOrEqualsAdvancedFilter

NumberInAdvancedFilter

NumberLessThanAdvancedFilter

NumberLessThanOrEqualsAdvancedFilter

NumberNotInAdvancedFilter

StringBeginsWithAdvancedFilter

StringContainsAdvancedFilter

StringEndsWithAdvancedFilter

StringInAdvancedFilter

StringNotInAdvancedFilter

RetryPolicy