Microsoft.EventGrid eventSubscriptions 2018-01-01
- Latest
- 2024-12-15-preview
- 2024-06-01-preview
- 2023-12-15-preview
- 2023-06-01-preview
- 2022-06-15
- 2021-12-01
- 2021-10-15-preview
- 2021-06-01-preview
- 2020-10-15-preview
- 2020-06-01
- 2020-04-01-preview
- 2020-01-01-preview
- 2019-06-01
- 2019-02-01-preview
- 2019-01-01
- 2018-09-15-preview
- 2018-05-01-preview
- 2018-01-01
- 2017-09-15-preview
- 2017-06-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@2018-01-01' = {
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
| 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 |
|---|---|---|
| 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 'EventHub' for type EventHubEventSubscriptionDestination. Set to 'WebHook' for type WebHookEventSubscriptionDestination. | 'EventHub' 'WebHook' (required) |
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 |
EventSubscriptionProperties
| Name | Description | Value |
|---|---|---|
| destination | Information about the destination where events have to be delivered for the event subscription. | EventSubscriptionDestination |
| filter | Information about the filter for the event subscription. | EventSubscriptionFilter |
| labels | List of user defined labels. | string[] |
Microsoft.EventGrid/eventSubscriptions
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| properties | Properties of the event subscription | EventSubscriptionProperties |
| scope | Use when creating a resource at a scope that is different than the deployment scope. | Set this property to the symbolic name of a resource to apply the extension resource. |
WebHookEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | Type of the endpoint for the event subscription destination | 'WebHook' (required) |
| properties | WebHook Properties of the event subscription destination | WebHookEventSubscriptionDestinationProperties |
WebHookEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| endpointUrl | The URL that represents the endpoint of the destination of an event subscription. | string |
Quickstart samples
The following quickstart samples deploy this resource type.
| Bicep File | 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. |
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": "2018-01-01",
"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
| 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 |
|---|---|---|
| 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 'EventHub' for type EventHubEventSubscriptionDestination. Set to 'WebHook' for type WebHookEventSubscriptionDestination. | 'EventHub' 'WebHook' (required) |
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 |
EventSubscriptionProperties
| Name | Description | Value |
|---|---|---|
| destination | Information about the destination where events have to be delivered for the event subscription. | EventSubscriptionDestination |
| filter | Information about the filter for the event subscription. | EventSubscriptionFilter |
| labels | List of user defined labels. | string[] |
Microsoft.EventGrid/eventSubscriptions
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2018-01-01' |
| name | The resource name | string (required) |
| properties | Properties of the event subscription | EventSubscriptionProperties |
| type | The resource type | 'Microsoft.EventGrid/eventSubscriptions' |
WebHookEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | Type of the endpoint for the event subscription destination | 'WebHook' (required) |
| properties | WebHook Properties of the event subscription destination | WebHookEventSubscriptionDestinationProperties |
WebHookEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| endpointUrl | The URL that represents the endpoint of the destination of an event subscription. | string |
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@2018-01-01"
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
| 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 |
|---|---|---|
| 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 'EventHub' for type EventHubEventSubscriptionDestination. Set to 'WebHook' for type WebHookEventSubscriptionDestination. | 'EventHub' 'WebHook' (required) |
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 |
EventSubscriptionProperties
| Name | Description | Value |
|---|---|---|
| destination | Information about the destination where events have to be delivered for the event subscription. | EventSubscriptionDestination |
| filter | Information about the filter for the event subscription. | EventSubscriptionFilter |
| labels | List of user defined labels. | string[] |
Microsoft.EventGrid/eventSubscriptions
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| parent_id | The ID of the resource to apply this extension resource to. | string (required) |
| properties | Properties of the event subscription | EventSubscriptionProperties |
| type | The resource type | "Microsoft.EventGrid/eventSubscriptions@2018-01-01" |
WebHookEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | Type of the endpoint for the event subscription destination | 'WebHook' (required) |
| properties | WebHook Properties of the event subscription destination | WebHookEventSubscriptionDestinationProperties |
WebHookEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| endpointUrl | The URL that represents the endpoint of the destination of an event subscription. | string |