system_topic_event_subscriptions

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

Overview

Name	system_topic_event_subscriptions
Type	Resource
Id	azure.event_grid.system_topic_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_by_system_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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, systemTopicName, eventSubscriptionName		Get an event subscription.
list_by_system_topic	select	subscriptionId, resourceGroupName, systemTopicName	$filter, $top	List event subscriptions that belong to a specific system topic.
create_or_update	insert	subscriptionId, resourceGroupName, systemTopicName, eventSubscriptionName		Asynchronously creates or updates an event subscription with the specified parameters. Existing event subscriptions will be updated with this API.
update	update	subscriptionId, resourceGroupName, systemTopicName, eventSubscriptionName		Update an existing event subscription of a system topic.
delete	delete	subscriptionId, resourceGroupName, systemTopicName, eventSubscriptionName		Delete an existing event subscription of a system 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
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.
systemTopicName	string	Name of the system 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

get

Get an event subscription.

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

list_by_system_topic

List event subscriptions that belong to a specific system topic.

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

INSERT examples

create_or_update

Asynchronously creates or updates an event subscription with the specified parameters. Existing event subscriptions will be updated with this API.

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

Manifest

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

UPDATE examples

update

Update an existing event subscription of a system topic.

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

DELETE examples

delete

Delete an existing event subscription of a system topic.

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