channels

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

Overview

Name	channels
Type	Resource
Id	azure.bot_service.channels

Fields

vw_channels

Name	Datatype	Description
id	text	Specifies the resource ID.
name	text	Specifies the name of the resource.
channelName	text	field from the properties object
channel_name	text	field from the properties object
etag	text	Entity Tag.
kind	text	Indicates the type of bot service
location	text	Specifies the location of the resource.
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
resourceName	text	field from the properties object
sku	text	The SKU of the cognitive services account.
subscriptionId	text	field from the properties object
tags	text	Contains resource tags defined as key/value pairs.
type	text	Specifies the type of the resource.
zones	text	Entity zones

channels

Name	Datatype	Description
id	string	Specifies the resource ID.
name	string	Specifies the name of the resource.
etag	string	Entity Tag.
kind	string	Indicates the type of bot service
location	string	Specifies the location of the resource.
properties	object	Channel definition
sku	object	The SKU of the cognitive services account.
tags	object	Contains resource tags defined as key/value pairs.
type	string	Specifies the type of the resource.
zones	array	Entity zones

Methods

Name	Accessible by	Required Params	Description
get	SELECT	channelName, resourceGroupName, resourceName, subscriptionId	Returns a BotService Channel registration specified by the parameters.
list_by_resource_group	SELECT	resourceGroupName, resourceName, subscriptionId	Returns all the Channel registrations of a particular BotService resource
list_with_keys	SELECT	channelName, resourceGroupName, resourceName, subscriptionId	Lists a Channel registration for a Bot Service including secrets
create	INSERT	channelName, resourceGroupName, resourceName, subscriptionId	Creates a Channel registration for a Bot Service
delete	DELETE	channelName, resourceGroupName, resourceName, subscriptionId	Deletes a Channel registration from a Bot Service
update	UPDATE	channelName, resourceGroupName, resourceName, subscriptionId	Updates a Channel registration for a Bot Service

SELECT examples

Returns all the Channel registrations of a particular BotService resource

vw_channels

SELECT
id,
name,
channelName,
channel_name,
etag,
kind,
location,
provisioning_state,
resourceGroupName,
resourceName,
sku,
subscriptionId,
tags,
type,
zones
FROM azure.bot_service.vw_channels
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND resourceName = '{{ resourceName }}'
AND subscriptionId = '{{ subscriptionId }}';

channels

SELECT
id,
name,
etag,
kind,
location,
properties,
sku,
tags,
type,
zones
FROM azure.bot_service.channels
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND resourceName = '{{ resourceName }}'
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.bot_service.channels (
channelName,
resourceGroupName,
resourceName,
subscriptionId,
location,
tags,
sku,
kind,
etag,
properties
)
SELECT 
'{{ channelName }}',
'{{ resourceGroupName }}',
'{{ resourceName }}',
'{{ subscriptionId }}',
'{{ location }}',
'{{ tags }}',
'{{ sku }}',
'{{ kind }}',
'{{ etag }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: id
      value: string
    - name: name
      value: string
    - name: location
      value: string
    - name: type
      value: string
    - name: tags
      value: object
    - name: sku
      value:
        - name: name
          value: []
        - name: tier
          value: string
    - name: kind
      value: []
    - name: etag
      value: string
    - name: zones
      value:
        - string
    - name: properties
      value:
        - name: channelName
          value: string
        - name: etag
          value: string
        - name: provisioningState
          value: string
        - name: location
          value: string

UPDATE example

Updates a channels resource.

/*+ update */
UPDATE azure.bot_service.channels
SET 
location = '{{ location }}',
tags = '{{ tags }}',
sku = '{{ sku }}',
kind = '{{ kind }}',
etag = '{{ etag }}',
properties = '{{ properties }}'
WHERE 
channelName = '{{ channelName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND resourceName = '{{ resourceName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified channels resource.

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