Microsoft.EventGrid eventSubscriptions 2019-01-01
- Latest
- 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 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-01-01' = {
name: 'string'
scope: resourceSymbolicName
properties: {
deadLetterDestination: {
endpointType: 'string'
// For remaining properties, see DeadLetterDestination objects
}
destination: {
endpointType: 'string'
// For remaining properties, see EventSubscriptionDestination objects
}
filter: {
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 StorageQueue, use:
endpointType: 'StorageQueue'
properties: {
queueName: 'string'
resourceId: 'string'
}
For WebHook, use:
endpointType: 'WebHook'
properties: {
endpointUrl: 'string'
}
Property values
eventSubscriptions
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) Character limit: 3-64 Valid characters: Alphanumerics and hyphens. |
| scope | Use when creating an extension resource at a scope that is different than the deployment scope. | Target resource For Bicep, set this property to the symbolic name of the resource to apply the extension resource. |
| properties | Properties of the event subscription | EventSubscriptionProperties |
EventSubscriptionProperties
| Name | Description | Value |
|---|---|---|
| deadLetterDestination | The DeadLetter destination of the event subscription. | DeadLetterDestination |
| 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[] |
| retryPolicy | The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. | RetryPolicy |
DeadLetterDestination
| Name | Description | Value |
|---|---|---|
| endpointType | Set the object type | StorageBlob (required) |
StorageBlobDeadLetterDestination
| Name | Description | Value |
|---|---|---|
| endpointType | Type of the endpoint for the dead letter destination | 'StorageBlob' (required) |
| properties | The properties of the Storage Blob based deadletter destination | StorageBlobDeadLetterDestinationProperties |
StorageBlobDeadLetterDestinationProperties
| Name | Description | Value |
|---|---|---|
| blobContainerName | The name of the Storage blob container that is the destination of the deadletter events | string |
| resourceId | The Azure Resource ID of the storage account that is the destination of the deadletter events. For example: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/microsoft.Storage/storageAccounts/{StorageAccountName} | string |
EventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | Set the object type | EventHub HybridConnection StorageQueue WebHook (required) |
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 |
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 | HybridConnectionEventSubscriptionDestinationProperti... |
HybridConnectionEventSubscriptionDestinationProperti...
| Name | Description | Value |
|---|---|---|
| resourceId | The Azure Resource ID of an hybrid connection that is the destination of an event subscription. | string |
StorageQueueEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | Type of the endpoint for the event subscription destination | 'StorageQueue' (required) |
| properties | Storage Queue Properties of the event subscription destination | StorageQueueEventSubscriptionDestinationProperties |
StorageQueueEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| queueName | The name of the Storage queue under a storage account that is the destination of an event subscription. | string |
| resourceId | The Azure Resource ID of the storage account that contains the queue that is the destination of an event subscription. | string |
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 |
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 |
RetryPolicy
| Name | Description | Value |
|---|---|---|
| eventTimeToLiveInMinutes | Time To Live (in minutes) for events. | int |
| maxDeliveryAttempts | Maximum number of delivery retry attempts for events. | int |
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-01-01",
"name": "string",
"scope": "string",
"properties": {
"deadLetterDestination": {
"endpointType": "string"
// For remaining properties, see DeadLetterDestination objects
},
"destination": {
"endpointType": "string"
// For remaining properties, see EventSubscriptionDestination objects
},
"filter": {
"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 StorageQueue, use:
"endpointType": "StorageQueue",
"properties": {
"queueName": "string",
"resourceId": "string"
}
For WebHook, use:
"endpointType": "WebHook",
"properties": {
"endpointUrl": "string"
}
Property values
eventSubscriptions
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.EventGrid/eventSubscriptions' |
| apiVersion | The resource api version | '2019-01-01' |
| name | The resource name | string (required) Character limit: 3-64 Valid characters: Alphanumerics and hyphens. |
| scope | Use when creating an extension resource at a scope that is different than the deployment scope. | Target resource For JSON, set the value to the full name of the resource to apply the extension resource to. |
| properties | Properties of the event subscription | EventSubscriptionProperties |
EventSubscriptionProperties
| Name | Description | Value |
|---|---|---|
| deadLetterDestination | The DeadLetter destination of the event subscription. | DeadLetterDestination |
| 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[] |
| retryPolicy | The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. | RetryPolicy |
DeadLetterDestination
| Name | Description | Value |
|---|---|---|
| endpointType | Set the object type | StorageBlob (required) |
StorageBlobDeadLetterDestination
| Name | Description | Value |
|---|---|---|
| endpointType | Type of the endpoint for the dead letter destination | 'StorageBlob' (required) |
| properties | The properties of the Storage Blob based deadletter destination | StorageBlobDeadLetterDestinationProperties |
StorageBlobDeadLetterDestinationProperties
| Name | Description | Value |
|---|---|---|
| blobContainerName | The name of the Storage blob container that is the destination of the deadletter events | string |
| resourceId | The Azure Resource ID of the storage account that is the destination of the deadletter events. For example: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/microsoft.Storage/storageAccounts/{StorageAccountName} | string |
EventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | Set the object type | EventHub HybridConnection StorageQueue WebHook (required) |
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 |
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 | HybridConnectionEventSubscriptionDestinationProperti... |
HybridConnectionEventSubscriptionDestinationProperti...
| Name | Description | Value |
|---|---|---|
| resourceId | The Azure Resource ID of an hybrid connection that is the destination of an event subscription. | string |
StorageQueueEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | Type of the endpoint for the event subscription destination | 'StorageQueue' (required) |
| properties | Storage Queue Properties of the event subscription destination | StorageQueueEventSubscriptionDestinationProperties |
StorageQueueEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| queueName | The name of the Storage queue under a storage account that is the destination of an event subscription. | string |
| resourceId | The Azure Resource ID of the storage account that contains the queue that is the destination of an event subscription. | string |
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 |
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 |
RetryPolicy
| Name | Description | Value |
|---|---|---|
| eventTimeToLiveInMinutes | Time To Live (in minutes) for events. | int |
| maxDeliveryAttempts | Maximum number of delivery retry attempts for events. | int |
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-01-01"
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
}
filter = {
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 StorageQueue, use:
endpointType = "StorageQueue"
properties = {
queueName = "string"
resourceId = "string"
}
For WebHook, use:
endpointType = "WebHook"
properties = {
endpointUrl = "string"
}
Property values
eventSubscriptions
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.EventGrid/eventSubscriptions@2019-01-01" |
| name | The resource name | string (required) Character limit: 3-64 Valid characters: Alphanumerics and hyphens. |
| parent_id | The ID of the resource to apply this extension resource to. | string (required) |
| properties | Properties of the event subscription | EventSubscriptionProperties |
EventSubscriptionProperties
| Name | Description | Value |
|---|---|---|
| deadLetterDestination | The DeadLetter destination of the event subscription. | DeadLetterDestination |
| 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[] |
| retryPolicy | The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. | RetryPolicy |
DeadLetterDestination
| Name | Description | Value |
|---|---|---|
| endpointType | Set the object type | StorageBlob (required) |
StorageBlobDeadLetterDestination
| Name | Description | Value |
|---|---|---|
| endpointType | Type of the endpoint for the dead letter destination | "StorageBlob" (required) |
| properties | The properties of the Storage Blob based deadletter destination | StorageBlobDeadLetterDestinationProperties |
StorageBlobDeadLetterDestinationProperties
| Name | Description | Value |
|---|---|---|
| blobContainerName | The name of the Storage blob container that is the destination of the deadletter events | string |
| resourceId | The Azure Resource ID of the storage account that is the destination of the deadletter events. For example: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/microsoft.Storage/storageAccounts/{StorageAccountName} | string |
EventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | Set the object type | EventHub HybridConnection StorageQueue WebHook (required) |
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 |
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 | HybridConnectionEventSubscriptionDestinationProperti... |
HybridConnectionEventSubscriptionDestinationProperti...
| Name | Description | Value |
|---|---|---|
| resourceId | The Azure Resource ID of an hybrid connection that is the destination of an event subscription. | string |
StorageQueueEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | Type of the endpoint for the event subscription destination | "StorageQueue" (required) |
| properties | Storage Queue Properties of the event subscription destination | StorageQueueEventSubscriptionDestinationProperties |
StorageQueueEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| queueName | The name of the Storage queue under a storage account that is the destination of an event subscription. | string |
| resourceId | The Azure Resource ID of the storage account that contains the queue that is the destination of an event subscription. | string |
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 |
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 |
RetryPolicy
| Name | Description | Value |
|---|---|---|
| eventTimeToLiveInMinutes | Time To Live (in minutes) for events. | int |
| maxDeliveryAttempts | Maximum number of delivery retry attempts for events. | int |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for