domain_event_subscriptions

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

Overview

Name	domain_event_subscriptions
Type	Resource
Id	azure.event_grid.domain_event_subscriptions

Fields

The following fields are returned by SELECT queries:

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.

list

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
get	select	subscriptionId, resourceGroupName, domainName, eventSubscriptionName		Get properties of an event subscription of a domain.
list	select	subscriptionId, resourceGroupName, domainName	$filter, $top	List all event subscriptions that have been created for a specific topic.
create_or_update	insert	subscriptionId, resourceGroupName, domainName, eventSubscriptionName		Asynchronously creates a new event subscription or updates an existing event subscription.
update	update	subscriptionId, resourceGroupName, domainName, eventSubscriptionName		Update an existing event subscription for a topic.
delete	delete	subscriptionId, resourceGroupName, domainName, eventSubscriptionName		Delete an existing event subscription for a domain.

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 domain.
eventSubscriptionName	string	Name of the event subscription to be deleted.
resourceGroupName	string	The name of the resource group within the user's subscription.
subscriptionId	string	Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
$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

get

Get properties of an event subscription of a domain.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.event_grid.domain_event_subscriptions
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND domainName = '{{ domainName }}' -- required
AND eventSubscriptionName = '{{ eventSubscriptionName }}' -- required
;

list

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

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

INSERT examples

create_or_update

Asynchronously creates a new event subscription or updates an existing event subscription.

INSERT INTO azure.event_grid.domain_event_subscriptions (
data__properties,
subscriptionId,
resourceGroupName,
domainName,
eventSubscriptionName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ domainName }}',
'{{ eventSubscriptionName }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

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

UPDATE examples

update

Update an existing event subscription for a topic.

UPDATE azure.event_grid.domain_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 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND domainName = '{{ domainName }}' --required
AND eventSubscriptionName = '{{ eventSubscriptionName }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete an existing event subscription for a domain.

DELETE FROM azure.event_grid.domain_event_subscriptions
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND domainName = '{{ domainName }}' --required
AND eventSubscriptionName = '{{ eventSubscriptionName }}' --required
;