event_subscriptions

Creates, updates, deletes, gets or lists an event_subscriptions resource.

Overview

Name	event_subscriptions
Type	Resource
Id	azure.event_grid.event_subscriptions

Fields

The following fields are returned by SELECT queries:

list_by_resource

Name	Datatype	Description
id	string	Fully qualified identifier of the resource.
name	string	Name of the resource.
properties	object	Properties of the event subscription.
systemData	object	The system metadata relating to Event Subscription resource.
type	string	Type of the resource.

list_by_domain_topic

Name	Datatype	Description
id	string	Fully qualified identifier of the resource.
name	string	Name of the resource.
properties	object	Properties of the event subscription.
systemData	object	The system metadata relating to Event Subscription resource.
type	string	Type of the resource.

get

Name	Datatype	Description
id	string	Fully qualified identifier of the resource.
name	string	Name of the resource.
properties	object	Properties of the event subscription.
systemData	object	The system metadata relating to Event Subscription resource.
type	string	Type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_resource	select	subscriptionId, resourceGroupName, providerNamespace, resourceTypeName, resourceName	$filter, $top	List all event subscriptions that have been created for a specific resource.
list_by_domain_topic	select	subscriptionId, resourceGroupName, domainName, topicName	$filter, $top	List all event subscriptions that have been created for a specific domain topic.
get	select	scope, eventSubscriptionName		Get properties of an event subscription.
create_or_update	insert	scope, eventSubscriptionName		Asynchronously creates a new event subscription or updates an existing event subscription based on the specified scope.
update	update	scope, eventSubscriptionName		Asynchronously updates an existing event subscription.
delete	delete	scope, eventSubscriptionName		Delete an existing event subscription.

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
domainName	string	Name of the top level domain.
eventSubscriptionName	string	Name of the event subscription to be deleted.
providerNamespace	string	Namespace of the provider of the topic.
resourceGroupName	string	The name of the resource group within the user's subscription.
resourceName	string	Name of the resource.
resourceTypeName	string	Name of the resource type.
scope	string	The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.
subscriptionId	string	Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
topicName	string	Name of the domain topic.
$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'.
$top	integer (int32)	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.

SELECT examples

list_by_resource

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

SELECT
id,
name,
properties,
systemData,
type
FROM azure.event_grid.event_subscriptions
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND providerNamespace = '{{ providerNamespace }}' -- required
AND resourceTypeName = '{{ resourceTypeName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
;

list_by_domain_topic

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

SELECT
id,
name,
properties,
systemData,
type
FROM azure.event_grid.event_subscriptions
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND domainName = '{{ domainName }}' -- required
AND topicName = '{{ topicName }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
;

get

Get properties of an event subscription.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.event_grid.event_subscriptions
WHERE scope = '{{ scope }}' -- required
AND eventSubscriptionName = '{{ eventSubscriptionName }}' -- required
;

INSERT examples

create_or_update

Asynchronously creates a new event subscription or updates an existing event subscription based on the specified scope.

INSERT INTO azure.event_grid.event_subscriptions (
data__properties,
scope,
eventSubscriptionName
)
SELECT 
'{{ properties }}',
'{{ scope }}',
'{{ eventSubscriptionName }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: event_subscriptions
  props:
    - name: scope
      value: string
      description: Required parameter for the event_subscriptions resource.
    - name: eventSubscriptionName
      value: string
      description: Required parameter for the event_subscriptions resource.
    - name: properties
      value: object
      description: |
        Properties of the event subscription.

UPDATE examples

update

Asynchronously updates an existing event subscription.

UPDATE azure.event_grid.event_subscriptions
SET 
data__destination = '{{ destination }}',
data__deliveryWithResourceIdentity = '{{ deliveryWithResourceIdentity }}',
data__filter = '{{ filter }}',
data__labels = '{{ labels }}',
data__expirationTimeUtc = '{{ expirationTimeUtc }}',
data__eventDeliverySchema = '{{ eventDeliverySchema }}',
data__retryPolicy = '{{ retryPolicy }}',
data__deadLetterDestination = '{{ deadLetterDestination }}',
data__deadLetterWithResourceIdentity = '{{ deadLetterWithResourceIdentity }}'
WHERE 
scope = '{{ scope }}' --required
AND eventSubscriptionName = '{{ eventSubscriptionName }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete an existing event subscription.

DELETE FROM azure.event_grid.event_subscriptions
WHERE scope = '{{ scope }}' --required
AND eventSubscriptionName = '{{ eventSubscriptionName }}' --required
;