Microsoft.EventGrid eventSubscriptions 2017-06-15-preview

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.

Template format

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

resource symbolicname 'Microsoft.EventGrid/eventSubscriptions@2017-06-15-preview' = {
  name: 'string'
  scope: scopeObject
  properties: {
    destination: {
      endpointType: 'WebHook'
      properties: {
        endpointUrl: 'string'
      }
    }
    filter: {
      includedEventTypes: [ 'string' ]
      isSubjectCaseSensitive: bool
      subjectBeginsWith: 'string'
      subjectEndsWith: 'string'
    }
    labels: [ 'string' ]
  }
}

Property values

eventSubscriptions

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.EventGrid/eventSubscriptions'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2017-06-15-preview'
name The resource name string (required)
scope Use when creating an extension resource at a scope that is different than the deployment scope.

For Bicep, set this property to the symbolic name of the resource to apply the extension resource to. See Set scope for extension resources in Bicep.

For JSON, set the value to the full name of the resource to apply the extension resource to. See Setting scope on extension resources in ARM templates.
scopeObject
properties Properties of the Event Subscription EventSubscriptionProperties

EventSubscriptionProperties

Name Description Value
destination Information about the destination for an event subscription EventSubscriptionDestination
filter Filter for the Event Subscription EventSubscriptionFilter
labels List of user defined labels. string[]

EventSubscriptionDestination

Name Description Value
endpointType Type of the endpoint for the event subscription destination 'WebHook'
properties Properties of the event subscription destination EventSubscriptionDestinationProperties

EventSubscriptionDestinationProperties

Name Description Value
endpointUrl The URL that represents the endpoint of the destination of an event subscription. string

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

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create Azure Event Grid Custom Topic and Subscription

Deploy to Azure
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

Deploy to Azure
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.

Deploy to Azure
Creates an Azure Event Grid custom topic and event hub to handle the events.
Create Event Grid subscription for resource events

Deploy to Azure
Creates Event Grid subscription to either resource group or Azure subscription.
Create Azure Event Grid Custom Topic and Subscription

Deploy to Azure
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

Deploy to Azure
Creates an Azure Event Grid custom topic and a service bus topic subscription. Template originally authored by Markus Meyer.