Microsoft.EventGrid eventSubscriptions 2017-09-15-preview

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@2017-09-15-preview' = {
  scope: resourceSymbolicName or scope
  name: 'string'
  properties: {
    destination: {
      endpointType: 'string'
      // For remaining properties, see EventSubscriptionDestination objects
    }
    filter: {
      includedEventTypes: [
        'string'
      ]
      isSubjectCaseSensitive: bool
      subjectBeginsWith: 'string'
      subjectEndsWith: 'string'
    }
    labels: [
      'string'
    ]
  }
}

EventSubscriptionDestination objects

Set the endpointType property to specify the type of object.

For EventHub, use:

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

For WebHook, use:

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

Property values

EventHubEventSubscriptionDestination

EventHubEventSubscriptionDestinationProperties

EventSubscriptionDestination

EventSubscriptionFilter

EventSubscriptionProperties

Microsoft.EventGrid/eventSubscriptions

WebHookEventSubscriptionDestination

WebHookEventSubscriptionDestinationProperties

Quickstart samples

The following quickstart samples deploy this resource type.

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

{
  "type": "Microsoft.EventGrid/eventSubscriptions",
  "apiVersion": "2017-09-15-preview",
  "name": "string",
  "properties": {
    "destination": {
      "endpointType": "string"
      // For remaining properties, see EventSubscriptionDestination objects
    },
    "filter": {
      "includedEventTypes": [ "string" ],
      "isSubjectCaseSensitive": "bool",
      "subjectBeginsWith": "string",
      "subjectEndsWith": "string"
    },
    "labels": [ "string" ]
  }
}

EventSubscriptionDestination objects

Set the endpointType property to specify the type of object.

For EventHub, use:

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

For WebHook, use:

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

Property values

EventHubEventSubscriptionDestination

EventHubEventSubscriptionDestinationProperties

EventSubscriptionDestination

EventSubscriptionFilter

EventSubscriptionProperties

Microsoft.EventGrid/eventSubscriptions

WebHookEventSubscriptionDestination

WebHookEventSubscriptionDestinationProperties

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
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 and Subscription	Creates an Azure Event Grid custom topic and a webhook subscription. Template originally authored by John Downs.
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.
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.
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.

Terraform (AzAPI provider) 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 Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/eventSubscriptions@2017-09-15-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      destination = {
        endpointType = "string"
        // For remaining properties, see EventSubscriptionDestination objects
      }
      filter = {
        includedEventTypes = [
          "string"
        ]
        isSubjectCaseSensitive = bool
        subjectBeginsWith = "string"
        subjectEndsWith = "string"
      }
      labels = [
        "string"
      ]
    }
  })
}

EventSubscriptionDestination objects

Set the endpointType property to specify the type of object.

For EventHub, use:

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

For WebHook, use:

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

Property values

EventHubEventSubscriptionDestination

EventHubEventSubscriptionDestinationProperties

EventSubscriptionDestination

EventSubscriptionFilter

EventSubscriptionProperties

Microsoft.EventGrid/eventSubscriptions

WebHookEventSubscriptionDestination

WebHookEventSubscriptionDestinationProperties