channels

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

Overview

Name	channels
Type	Resource
Id	azure.event_grid.channels

Fields

vw_channels

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
channelName	text	field from the properties object
channel_type	text	field from the properties object
expiration_time_if_not_activated_utc	text	field from the properties object
message_for_activation	text	field from the properties object
partnerNamespaceName	text	field from the properties object
partner_destination_info	text	field from the properties object
partner_topic_info	text	field from the properties object
provisioning_state	text	field from the properties object
readiness_state	text	field from the properties object
resourceGroupName	text	field from the properties object
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
type	text	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

channels

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 Channel.
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	channelName, partnerNamespaceName, resourceGroupName, subscriptionId	Get properties of a channel.
list_by_partner_namespace	SELECT	partnerNamespaceName, resourceGroupName, subscriptionId	List all the channels in a partner namespace.
create_or_update	INSERT	channelName, partnerNamespaceName, resourceGroupName, subscriptionId	Synchronously creates or updates a new channel with the specified parameters.
delete	DELETE	channelName, partnerNamespaceName, resourceGroupName, subscriptionId	Delete an existing channel.
update	UPDATE	channelName, partnerNamespaceName, resourceGroupName, subscriptionId	Synchronously updates a channel with the specified parameters.

SELECT examples

List all the channels in a partner namespace.

vw_channels

SELECT
id,
name,
channelName,
channel_type,
expiration_time_if_not_activated_utc,
message_for_activation,
partnerNamespaceName,
partner_destination_info,
partner_topic_info,
provisioning_state,
readiness_state,
resourceGroupName,
subscriptionId,
system_data,
type
FROM azure.event_grid.vw_channels
WHERE partnerNamespaceName = '{{ partnerNamespaceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

channels

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

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.event_grid.channels (
channelName,
partnerNamespaceName,
resourceGroupName,
subscriptionId,
properties
)
SELECT 
'{{ channelName }}',
'{{ partnerNamespaceName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ 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: channelType
          value: string
        - name: partnerTopicInfo
          value:
            - name: azureSubscriptionId
              value: string
            - name: resourceGroupName
              value: string
            - name: name
              value: string
            - name: eventTypeInfo
              value:
                - name: kind
                  value: string
                - name: inlineEventTypes
                  value: object
            - name: source
              value: string
        - name: partnerDestinationInfo
          value:
            - name: azureSubscriptionId
              value: string
            - name: resourceGroupName
              value: string
            - name: name
              value: string
            - name: endpointType
              value: string
            - name: endpointServiceContext
              value: string
            - name: resourceMoveChangeHistory
              value:
                - - name: azureSubscriptionId
                    value: string
                  - name: resourceGroupName
                    value: string
                  - name: changedTimeUtc
                    value: string
        - name: messageForActivation
          value: string
        - name: provisioningState
          value: string
        - name: readinessState
          value: string
        - name: expirationTimeIfNotActivatedUtc
          value: string

UPDATE example

Updates a channels resource.

/*+ update */
UPDATE azure.event_grid.channels
SET 
properties = '{{ properties }}'
WHERE 
channelName = '{{ channelName }}'
AND partnerNamespaceName = '{{ partnerNamespaceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified channels resource.

/*+ delete */
DELETE FROM azure.event_grid.channels
WHERE channelName = '{{ channelName }}'
AND partnerNamespaceName = '{{ partnerNamespaceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';