channels

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

Overview

Name	channels
Type	Resource
Id	azure.bot_service.channels

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Specifies the resource ID.
name	string	Specifies the name of the resource.
channelName	string	The channel name. Required.
etag	string	Entity Tag.
kind	string	Required. Gets or sets the Kind of the resource. Known values are: "sdk", "designer", "bot", "function", and "azurebot".
location	string	Specifies the location of the resource.
provisioningState	string	Provisioning state of the resource.
sku	object	Gets or sets the SKU of the resource.
tags	object	Contains resource tags defined as key/value pairs.
type	string	Specifies the type of the resource.
zones	array	Entity zones.

list_by_resource_group

Name	Datatype	Description
id	string	Specifies the resource ID.
name	string	Specifies the name of the resource.
channelName	string	The channel name. Required.
etag	string	Entity Tag.
kind	string	Required. Gets or sets the Kind of the resource. Known values are: "sdk", "designer", "bot", "function", and "azurebot".
location	string	Specifies the location of the resource.
provisioningState	string	Provisioning state of the resource.
sku	object	Gets or sets the SKU of the resource.
tags	object	Contains resource tags defined as key/value pairs.
type	string	Specifies the type of the resource.
zones	array	Entity zones.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, resource_name, channel_name, subscription_id		Returns a BotService Channel registration specified by the parameters.
list_by_resource_group	select	resource_group_name, resource_name, subscription_id		Returns all the Channel registrations of a particular BotService resource.
create	insert	resource_group_name, resource_name, channel_name, subscription_id		Creates a Channel registration for a Bot Service.
update	update	resource_group_name, resource_name, channel_name, subscription_id, name		Updates a Channel registration for a Bot Service.
delete	delete	resource_group_name, resource_name, channel_name, subscription_id		Deletes a Channel registration from a Bot Service.
list_with_keys	exec	resource_group_name, resource_name, channel_name, subscription_id		Lists a Channel registration for a Bot Service including secrets.

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	The name of the Channel resource. Known values are: "AlexaChannel", "FacebookChannel", "EmailChannel", "KikChannel", "TelegramChannel", "SlackChannel", "MsTeamsChannel", "SkypeChannel", "WebChatChannel", "DirectLineChannel", "SmsChannel", "LineChannel", "DirectLineSpeechChannel", "OutlookChannel", "Omnichannel", "TelephonyChannel", "AcsChatChannel", "SearchAssistant", and "M365Extensions". Required.
resource_group_name	string	The name of the Bot resource group in the user subscription. Required.
resource_name	string	The name of the Bot resource. Required.
subscription_id	string

SELECT examples

get

Returns a BotService Channel registration specified by the parameters.

SELECT
id,
name,
channelName,
etag,
kind,
location,
provisioningState,
sku,
tags,
type,
zones
FROM azure.bot_service.channels
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND channel_name = '{{ channel_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Returns all the Channel registrations of a particular BotService resource.

SELECT
id,
name,
channelName,
etag,
kind,
location,
provisioningState,
sku,
tags,
type,
zones
FROM azure.bot_service.channels
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates a Channel registration for a Bot Service.

INSERT INTO azure.bot_service.channels (
location,
tags,
sku,
kind,
etag,
properties,
resource_group_name,
resource_name,
channel_name,
subscription_id
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ sku }}',
'{{ kind }}',
'{{ etag }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ resource_name }}',
'{{ channel_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
kind,
location,
properties,
sku,
tags,
type,
zones
;

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: resource_name
    value: "{{ resource_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: location
    value: "{{ location }}"
    description: |
      Specifies the location of the resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Contains resource tags defined as key/value pairs.
  - name: sku
    description: |
      Gets or sets the SKU of the resource.
    value:
      name: "{{ name }}"
      tier: "{{ tier }}"
  - name: kind
    value: "{{ kind }}"
    description: |
      Required. Gets or sets the Kind of the resource. Known values are: "sdk", "designer", "bot", "function", and "azurebot".
  - name: etag
    value: "{{ etag }}"
    description: |
      Entity Tag.
  - name: properties
    description: |
      The set of properties specific to bot channel resource.
    value:
      channelName: "{{ channelName }}"
      etag: "{{ etag }}"
      provisioningState: "{{ provisioningState }}"
      location: "{{ location }}"

UPDATE examples

update

Updates a Channel registration for a Bot Service.

UPDATE azure.bot_service.channels
SET 
name = '{{ name }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND channel_name = '{{ channel_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND name = '{{ name }}' --required
RETURNING
id,
name,
etag,
kind,
location,
properties,
sku,
tags,
type,
zones;

DELETE examples

delete

Deletes a Channel registration from a Bot Service.

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

Lifecycle Methods

list_with_keys

Lists a Channel registration for a Bot Service including secrets.

EXEC azure.bot_service.channels.list_with_keys 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@channel_name='{{ channel_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;