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 identifier of the resource.
name	string	Name of the resource.
properties	object	Properties of the Channel.
systemData	object	The system metadata relating to Channel resource.
type	string	Type of the resource.

list_by_partner_namespace

Name	Datatype	Description
id	string	Fully qualified identifier of the resource.
name	string	Name of the resource.
properties	object	Properties of the Channel.
systemData	object	The system metadata relating to Channel 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, partnerNamespaceName, channelName		Get properties of a channel.
list_by_partner_namespace	select	subscriptionId, resourceGroupName, partnerNamespaceName	$filter, $top	List all the channels in a partner namespace.
create_or_update	insert	subscriptionId, resourceGroupName, partnerNamespaceName, channelName		Synchronously creates or updates a new channel with the specified parameters.
update	update	subscriptionId, resourceGroupName, partnerNamespaceName, channelName		Synchronously updates a channel with the specified parameters.
delete	delete	subscriptionId, resourceGroupName, partnerNamespaceName, channelName		Delete an existing 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
channelName	string	Name of the channel.
partnerNamespaceName	string	Name of the partner namespace.
resourceGroupName	string	The name of the resource group within the partners subscription.
subscriptionId	string	Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
$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 properties of a channel.

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

list_by_partner_namespace

List all the channels in a partner namespace.

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

INSERT examples

create_or_update

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

INSERT INTO azure.event_grid.channels (
data__properties,
subscriptionId,
resourceGroupName,
partnerNamespaceName,
channelName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ partnerNamespaceName }}',
'{{ channelName }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: channels
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the channels resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the channels resource.
    - name: partnerNamespaceName
      value: string
      description: Required parameter for the channels resource.
    - name: channelName
      value: string
      description: Required parameter for the channels resource.
    - name: properties
      value: object
      description: |
        Properties of the Channel.

UPDATE examples

update

Synchronously updates a channel with the specified parameters.

UPDATE azure.event_grid.channels
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND partnerNamespaceName = '{{ partnerNamespaceName }}' --required
AND channelName = '{{ channelName }}' --required;

DELETE examples

delete

Delete an existing channel.

DELETE FROM azure.event_grid.channels
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND partnerNamespaceName = '{{ partnerNamespaceName }}' --required
AND channelName = '{{ channelName }}' --required
;