channels

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

Overview

Name	channels
Type	Resource
Id	azure.event_grid.channels

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
channelType	string	The type of the event channel which represents the direction flow of events. Known values are: "PartnerTopic" and "PartnerDestination". (PartnerTopic, PartnerDestination)
expirationTimeIfNotActivatedUtc	string (date-time)	Expiration time of the channel. If this timer expires while the corresponding partner topic is never activated, the channel and corresponding partner topic are deleted.
messageForActivation	string	Context or helpful message that can be used during the approval process by the subscriber.
partnerDestinationInfo	object	This property should be populated when channelType is PartnerDestination and represents information about the partner destination resource corresponding to the channel.
partnerTopicInfo	object	This property should be populated when channelType is PartnerTopic and represents information about the partner topic resource corresponding to the channel.
provisioningState	string	Provisioning state of the channel. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", "Failed", "IdleDueToMirroredPartnerTopicDeletion", and "IdleDueToMirroredPartnerDestinationDeletion". (Creating, Updating, Deleting, Succeeded, Canceled, Failed, IdleDueToMirroredPartnerTopicDeletion, IdleDueToMirroredPartnerDestinationDeletion)
readinessState	string	The readiness state of the corresponding partner topic. Known values are: "NeverActivated" and "Activated". (NeverActivated, Activated)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_partner_namespace

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
channelType	string	The type of the event channel which represents the direction flow of events. Known values are: "PartnerTopic" and "PartnerDestination". (PartnerTopic, PartnerDestination)
expirationTimeIfNotActivatedUtc	string (date-time)	Expiration time of the channel. If this timer expires while the corresponding partner topic is never activated, the channel and corresponding partner topic are deleted.
messageForActivation	string	Context or helpful message that can be used during the approval process by the subscriber.
partnerDestinationInfo	object	This property should be populated when channelType is PartnerDestination and represents information about the partner destination resource corresponding to the channel.
partnerTopicInfo	object	This property should be populated when channelType is PartnerTopic and represents information about the partner topic resource corresponding to the channel.
provisioningState	string	Provisioning state of the channel. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", "Failed", "IdleDueToMirroredPartnerTopicDeletion", and "IdleDueToMirroredPartnerDestinationDeletion". (Creating, Updating, Deleting, Succeeded, Canceled, Failed, IdleDueToMirroredPartnerTopicDeletion, IdleDueToMirroredPartnerDestinationDeletion)
readinessState	string	The readiness state of the corresponding partner topic. Known values are: "NeverActivated" and "Activated". (NeverActivated, Activated)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, partner_namespace_name, channel_name, subscription_id		Get a channel. Get properties of a channel.
list_by_partner_namespace	select	resource_group_name, partner_namespace_name, subscription_id	$filter, $top	List channels. List all the channels in a partner namespace.
create_or_update	insert	resource_group_name, partner_namespace_name, channel_name, subscription_id		Create or update a channel. Synchronously creates or updates a new channel with the specified parameters.
update	update	resource_group_name, partner_namespace_name, channel_name, subscription_id		Update a Channel. Synchronously updates a channel with the specified parameters.
create_or_update	replace	resource_group_name, partner_namespace_name, channel_name, subscription_id		Create or update a channel. Synchronously creates or updates a new channel with the specified parameters.
delete	delete	resource_group_name, partner_namespace_name, channel_name, subscription_id		Delete a channel. Delete an existing channel.
get_full_url	exec	resource_group_name, partner_namespace_name, channel_name, subscription_id		Get full URL of partner destination channel. Get the full endpoint URL of a partner destination channel.

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
channel_name	string	Name of the channel. Required.
partner_namespace_name	string	Name of the partner namespace. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$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'. Default value is None.
$top	integer	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. Default value is None.

SELECT examples

get

Get a channel. Get properties of a channel.

SELECT
id,
name,
channelType,
expirationTimeIfNotActivatedUtc,
messageForActivation,
partnerDestinationInfo,
partnerTopicInfo,
provisioningState,
readinessState,
systemData,
type
FROM azure.event_grid.channels
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND partner_namespace_name = '{{ partner_namespace_name }}' -- required
AND channel_name = '{{ channel_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_partner_namespace

List channels. List all the channels in a partner namespace.

SELECT
id,
name,
channelType,
expirationTimeIfNotActivatedUtc,
messageForActivation,
partnerDestinationInfo,
partnerTopicInfo,
provisioningState,
readinessState,
systemData,
type
FROM azure.event_grid.channels
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND partner_namespace_name = '{{ partner_namespace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

Create or update a channel. Synchronously creates or updates a new channel with the specified parameters.

INSERT INTO azure.event_grid.channels (
properties,
resource_group_name,
partner_namespace_name,
channel_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ partner_namespace_name }}',
'{{ channel_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: channels
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the channels resource.
  - name: partner_namespace_name
    value: "{{ partner_namespace_name }}"
    description: Required parameter for the channels resource.
  - name: channel_name
    value: "{{ channel_name }}"
    description: Required parameter for the channels resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the channels resource.
  - name: properties
    description: |
      Properties of the Channel.
    value:
      channelType: "{{ channelType }}"
      partnerTopicInfo:
        azureSubscriptionId: "{{ azureSubscriptionId }}"
        resourceGroupName: "{{ resourceGroupName }}"
        name: "{{ name }}"
        eventTypeInfo:
          kind: "{{ kind }}"
          inlineEventTypes: "{{ inlineEventTypes }}"
        source: "{{ source }}"
      partnerDestinationInfo:
        azureSubscriptionId: "{{ azureSubscriptionId }}"
        resourceGroupName: "{{ resourceGroupName }}"
        name: "{{ name }}"
        endpointType: "{{ endpointType }}"
        endpointServiceContext: "{{ endpointServiceContext }}"
        resourceMoveChangeHistory:
          - azureSubscriptionId: "{{ azureSubscriptionId }}"
            resourceGroupName: "{{ resourceGroupName }}"
            changedTimeUtc: "{{ changedTimeUtc }}"
      messageForActivation: "{{ messageForActivation }}"
      provisioningState: "{{ provisioningState }}"
      readinessState: "{{ readinessState }}"
      expirationTimeIfNotActivatedUtc: "{{ expirationTimeIfNotActivatedUtc }}"

UPDATE examples

update

Update a Channel. Synchronously updates a channel with the specified parameters.

UPDATE azure.event_grid.channels
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND partner_namespace_name = '{{ partner_namespace_name }}' --required
AND channel_name = '{{ channel_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required;

REPLACE examples

create_or_update

Create or update a channel. Synchronously creates or updates a new channel with the specified parameters.

REPLACE azure.event_grid.channels
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND partner_namespace_name = '{{ partner_namespace_name }}' --required
AND channel_name = '{{ channel_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a channel. Delete an existing channel.

DELETE FROM azure.event_grid.channels
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND partner_namespace_name = '{{ partner_namespace_name }}' --required
AND channel_name = '{{ channel_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

get_full_url

Get full URL of partner destination channel. Get the full endpoint URL of a partner destination channel.

EXEC azure.event_grid.channels.get_full_url 
@resource_group_name='{{ resource_group_name }}' --required, 
@partner_namespace_name='{{ partner_namespace_name }}' --required, 
@channel_name='{{ channel_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;