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

vw_system_topic_event_subscriptions

Name	Datatype	Description
id	text	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	text	The name of the resource
dead_letter_destination	text	field from the properties object
dead_letter_with_resource_identity	text	field from the properties object
delivery_with_resource_identity	text	field from the properties object
destination	text	field from the properties object
eventSubscriptionName	text	field from the properties object
event_delivery_schema	text	field from the properties object
expiration_time_utc	text	field from the properties object
filter	text	field from the properties object
labels	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
retry_policy	text	field from the properties object
subscriptionId	text	field from the properties object
systemTopicName	text	field from the properties object
system_data	text	field from the properties object
topic	text	field from the properties object
type	text	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

system_topic_event_subscriptions

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	object	Properties of the Event Subscription.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

Name	Accessible by	Required Params	Description
get	SELECT	eventSubscriptionName, resourceGroupName, subscriptionId, systemTopicName	Get an event subscription.
list_by_system_topic	SELECT	resourceGroupName, subscriptionId, systemTopicName	List event subscriptions that belong to a specific system topic.
create_or_update	INSERT	eventSubscriptionName, resourceGroupName, subscriptionId, systemTopicName	Asynchronously creates or updates an event subscription with the specified parameters. Existing event subscriptions will be updated with this API.
delete	DELETE	eventSubscriptionName, resourceGroupName, subscriptionId, systemTopicName	Delete an existing event subscription of a system topic.
update	UPDATE	eventSubscriptionName, resourceGroupName, subscriptionId, systemTopicName	Update an existing event subscription of a system topic.

SELECT examples

List event subscriptions that belong to a specific system topic.

vw_system_topic_event_subscriptions

SELECT
id,
name,
dead_letter_destination,
dead_letter_with_resource_identity,
delivery_with_resource_identity,
destination,
eventSubscriptionName,
event_delivery_schema,
expiration_time_utc,
filter,
labels,
provisioning_state,
resourceGroupName,
retry_policy,
subscriptionId,
systemTopicName,
system_data,
topic,
type
FROM azure.event_grid.vw_system_topic_event_subscriptions
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND systemTopicName = '{{ systemTopicName }}';

system_topic_event_subscriptions

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

INSERT example

Use the following StackQL query and manifest file to create a new system_topic_event_subscriptions resource.

All Properties

/*+ create */
INSERT INTO azure.event_grid.system_topic_event_subscriptions (
eventSubscriptionName,
resourceGroupName,
subscriptionId,
systemTopicName,
properties
)
SELECT 
'{{ eventSubscriptionName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ systemTopicName }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: systemData
      value:
        - name: createdBy
          value: string
        - name: createdByType
          value: string
        - name: createdAt
          value: string
        - name: lastModifiedBy
          value: string
        - name: lastModifiedByType
          value: string
        - name: lastModifiedAt
          value: string
    - name: properties
      value:
        - name: topic
          value: string
        - name: provisioningState
          value: string
        - name: destination
          value:
            - name: endpointType
              value: string
        - name: deliveryWithResourceIdentity
          value:
            - name: identity
              value:
                - name: type
                  value: string
                - name: userAssignedIdentity
                  value: string
        - name: filter
          value:
            - name: subjectBeginsWith
              value: string
            - name: subjectEndsWith
              value: string
            - name: includedEventTypes
              value:
                - string
            - name: isSubjectCaseSensitive
              value: boolean
            - name: enableAdvancedFilteringOnArrays
              value: boolean
            - name: advancedFilters
              value:
                - - name: operatorType
                    value: string
                  - name: key
                    value: string
        - name: labels
          value:
            - string
        - name: expirationTimeUtc
          value: string
        - name: eventDeliverySchema
          value: string
        - name: retryPolicy
          value:
            - name: maxDeliveryAttempts
              value: integer
            - name: eventTimeToLiveInMinutes
              value: integer
        - name: deadLetterDestination
          value:
            - name: endpointType
              value: string
        - name: deadLetterWithResourceIdentity
          value: []

UPDATE example

Updates a system_topic_event_subscriptions resource.

/*+ update */
UPDATE azure.event_grid.system_topic_event_subscriptions
SET 
destination = '{{ destination }}',
deliveryWithResourceIdentity = '{{ deliveryWithResourceIdentity }}',
filter = '{{ filter }}',
labels = '{{ labels }}',
expirationTimeUtc = '{{ expirationTimeUtc }}',
eventDeliverySchema = '{{ eventDeliverySchema }}',
retryPolicy = '{{ retryPolicy }}',
deadLetterDestination = '{{ deadLetterDestination }}',
deadLetterWithResourceIdentity = '{{ deadLetterWithResourceIdentity }}'
WHERE 
eventSubscriptionName = '{{ eventSubscriptionName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND systemTopicName = '{{ systemTopicName }}';

DELETE example

Deletes the specified system_topic_event_subscriptions resource.

/*+ delete */
DELETE FROM azure.event_grid.system_topic_event_subscriptions
WHERE eventSubscriptionName = '{{ eventSubscriptionName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND systemTopicName = '{{ systemTopicName }}';