topic_event_subscriptions

Creates, updates, deletes, gets or lists a topic_event_subscriptions resource.

Overview

Name	topic_event_subscriptions
Type	Resource
Id	azure.event_grid.topic_event_subscriptions

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
deadLetterDestination	object	The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering.
deadLetterWithResourceIdentity	object	The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering.
deliveryWithResourceIdentity	object	Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering.
destination	object	Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering.
eventDeliverySchema	string	The event delivery schema for the event subscription. Known values are: "EventGridSchema", "CustomInputSchema", and "CloudEventSchemaV1_0". (EventGridSchema, CustomInputSchema, CloudEventSchemaV1_0)
expirationTimeUtc	string (date-time)	Expiration time of the event subscription.
filter	object	Information about the filter for the event subscription.
labels	array	List of user defined labels.
provisioningState	string	Provisioning state of the event subscription. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", "Failed", and "AwaitingManualAction". (Creating, Updating, Deleting, Succeeded, Canceled, Failed, AwaitingManualAction)
retryPolicy	object	The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
topic	string	Name of the topic of the event subscription.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
deadLetterDestination	object	The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering.
deadLetterWithResourceIdentity	object	The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering.
deliveryWithResourceIdentity	object	Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering.
destination	object	Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering.
eventDeliverySchema	string	The event delivery schema for the event subscription. Known values are: "EventGridSchema", "CustomInputSchema", and "CloudEventSchemaV1_0". (EventGridSchema, CustomInputSchema, CloudEventSchemaV1_0)
expirationTimeUtc	string (date-time)	Expiration time of the event subscription.
filter	object	Information about the filter for the event subscription.
labels	array	List of user defined labels.
provisioningState	string	Provisioning state of the event subscription. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", "Failed", and "AwaitingManualAction". (Creating, Updating, Deleting, Succeeded, Canceled, Failed, AwaitingManualAction)
retryPolicy	object	The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
topic	string	Name of the topic of the event subscription.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, topic_name, event_subscription_name, subscription_id		Get an event subscription of a topic. Get properties of an event subscription of a topic.
list	select	resource_group_name, topic_name, subscription_id	$filter, $top	List all event subscriptions for a specific topic. List all event subscriptions that have been created for a specific topic.
create_or_update	insert	resource_group_name, topic_name, event_subscription_name, subscription_id		Create or update an event subscription to a topic. Asynchronously creates a new event subscription or updates an existing event subscription.
update	update	resource_group_name, topic_name, event_subscription_name, subscription_id		Update an event subscription for a topic. Update an existing event subscription for a topic.
create_or_update	replace	resource_group_name, topic_name, event_subscription_name, subscription_id		Create or update an event subscription to a topic. Asynchronously creates a new event subscription or updates an existing event subscription.
delete	delete	resource_group_name, topic_name, event_subscription_name, subscription_id		Delete an event subscription for a topic. Delete an existing event subscription for a topic.
get_delivery_attributes	exec	resource_group_name, topic_name, event_subscription_name, subscription_id		Get delivery attributes for an event subscription for topic. Get all delivery attributes for an event subscription for topic.
get_full_url	exec	resource_group_name, topic_name, event_subscription_name, subscription_id		Get full URL of an event subscription for topic. Get the full endpoint URL for an event subscription for topic.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
event_subscription_name	string	Name of the event subscription to be found. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
topic_name	string	Name of the topic. Required.
$filter	string	The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. Default value is None.
$top	integer	The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. Default value is None.

SELECT examples

get

Get an event subscription of a topic. Get properties of an event subscription of a topic.

SELECT
id,
name,
deadLetterDestination,
deadLetterWithResourceIdentity,
deliveryWithResourceIdentity,
destination,
eventDeliverySchema,
expirationTimeUtc,
filter,
labels,
provisioningState,
retryPolicy,
systemData,
topic,
type
FROM azure.event_grid.topic_event_subscriptions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND topic_name = '{{ topic_name }}' -- required
AND event_subscription_name = '{{ event_subscription_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List all event subscriptions for a specific topic. List all event subscriptions that have been created for a specific topic.

SELECT
id,
name,
deadLetterDestination,
deadLetterWithResourceIdentity,
deliveryWithResourceIdentity,
destination,
eventDeliverySchema,
expirationTimeUtc,
filter,
labels,
provisioningState,
retryPolicy,
systemData,
topic,
type
FROM azure.event_grid.topic_event_subscriptions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND topic_name = '{{ topic_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

Create or update an event subscription to a topic. Asynchronously creates a new event subscription or updates an existing event subscription.

INSERT INTO azure.event_grid.topic_event_subscriptions (
properties,
resource_group_name,
topic_name,
event_subscription_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ topic_name }}',
'{{ event_subscription_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: topic_event_subscriptions
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the topic_event_subscriptions resource.
  - name: topic_name
    value: "{{ topic_name }}"
    description: Required parameter for the topic_event_subscriptions resource.
  - name: event_subscription_name
    value: "{{ event_subscription_name }}"
    description: Required parameter for the topic_event_subscriptions resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the topic_event_subscriptions resource.
  - name: properties
    description: |
      Properties of the event subscription.
    value:
      topic: "{{ topic }}"
      provisioningState: "{{ provisioningState }}"
      destination:
        endpointType: "{{ endpointType }}"
      deliveryWithResourceIdentity:
        identity:
          type: "{{ type }}"
          userAssignedIdentity: "{{ userAssignedIdentity }}"
          federatedIdentityCredentialInfo:
            federatedClientId: "{{ federatedClientId }}"
        destination:
          endpointType: "{{ endpointType }}"
      filter:
        subjectBeginsWith: "{{ subjectBeginsWith }}"
        subjectEndsWith: "{{ subjectEndsWith }}"
        includedEventTypes:
          - "{{ includedEventTypes }}"
        isSubjectCaseSensitive: {{ isSubjectCaseSensitive }}
        enableAdvancedFilteringOnArrays: {{ enableAdvancedFilteringOnArrays }}
        advancedFilters:
          - operatorType: "{{ operatorType }}"
            key: "{{ key }}"
      labels:
        - "{{ labels }}"
      expirationTimeUtc: "{{ expirationTimeUtc }}"
      eventDeliverySchema: "{{ eventDeliverySchema }}"
      retryPolicy:
        maxDeliveryAttempts: {{ maxDeliveryAttempts }}
        eventTimeToLiveInMinutes: {{ eventTimeToLiveInMinutes }}
      deadLetterDestination:
        endpointType: "{{ endpointType }}"
      deadLetterWithResourceIdentity:
        identity:
          type: "{{ type }}"
          userAssignedIdentity: "{{ userAssignedIdentity }}"
          federatedIdentityCredentialInfo:
            federatedClientId: "{{ federatedClientId }}"
        deadLetterDestination:
          endpointType: "{{ endpointType }}"

UPDATE examples

update

Update an event subscription for a topic. Update an existing event subscription for a topic.

UPDATE azure.event_grid.topic_event_subscriptions
SET 
destination = '{{ destination }}',
deliveryWithResourceIdentity = '{{ deliveryWithResourceIdentity }}',
filter = '{{ filter }}',
labels = '{{ labels }}',
expirationTimeUtc = '{{ expirationTimeUtc }}',
eventDeliverySchema = '{{ eventDeliverySchema }}',
retryPolicy = '{{ retryPolicy }}',
deadLetterDestination = '{{ deadLetterDestination }}',
deadLetterWithResourceIdentity = '{{ deadLetterWithResourceIdentity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND topic_name = '{{ topic_name }}' --required
AND event_subscription_name = '{{ event_subscription_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update

Create or update an event subscription to a topic. Asynchronously creates a new event subscription or updates an existing event subscription.

REPLACE azure.event_grid.topic_event_subscriptions
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND topic_name = '{{ topic_name }}' --required
AND event_subscription_name = '{{ event_subscription_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete an event subscription for a topic. Delete an existing event subscription for a topic.

DELETE FROM azure.event_grid.topic_event_subscriptions
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND topic_name = '{{ topic_name }}' --required
AND event_subscription_name = '{{ event_subscription_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

get_delivery_attributes

Get delivery attributes for an event subscription for topic. Get all delivery attributes for an event subscription for topic.

EXEC azure.event_grid.topic_event_subscriptions.get_delivery_attributes 
@resource_group_name='{{ resource_group_name }}' --required, 
@topic_name='{{ topic_name }}' --required, 
@event_subscription_name='{{ event_subscription_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_full_url

Get full URL of an event subscription for topic. Get the full endpoint URL for an event subscription for topic.

EXEC azure.event_grid.topic_event_subscriptions.get_full_url 
@resource_group_name='{{ resource_group_name }}' --required, 
@topic_name='{{ topic_name }}' --required, 
@event_subscription_name='{{ event_subscription_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;