event_subscriptions

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

Overview

Name	event_subscriptions
Type	Resource
Id	azure.event_grid.event_subscriptions

Fields

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, scope	Get properties of an event subscription.
list_by_domain_topic	SELECT	domainName, resourceGroupName, subscriptionId, topicName	List all event subscriptions that have been created for a specific domain topic.
list_by_resource	SELECT	providerNamespace, resourceGroupName, resourceName, resourceTypeName, subscriptionId	List all event subscriptions that have been created for a specific resource.
create_or_update	INSERT	eventSubscriptionName, scope	Asynchronously creates a new event subscription or updates an existing event subscription based on the specified scope.
delete	DELETE	eventSubscriptionName, scope	Delete an existing event subscription.
update	UPDATE	eventSubscriptionName, scope	Asynchronously updates an existing event subscription.

SELECT examples

Get properties of an event subscription.

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

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.event_grid.event_subscriptions (
eventSubscriptionName,
scope,
properties
)
SELECT 
'{{ eventSubscriptionName }}',
'{{ scope }}',
'{{ 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 event_subscriptions resource.

/*+ update */
UPDATE azure.event_grid.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 scope = '{{ scope }}';

DELETE example

Deletes the specified event_subscriptions resource.

/*+ delete */
DELETE FROM azure.event_grid.event_subscriptions
WHERE eventSubscriptionName = '{{ eventSubscriptionName }}'
AND scope = '{{ scope }}';