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

The resource provider should return 200 (OK) to indicate that the operation completed successfully.

Name	Datatype	Description
id	string	Specifies the resource ID.
name	string	Specifies the name of the resource.
etag	string	Entity Tag.
kind	string	Required. Gets or sets the Kind of the resource.
location	string	Specifies the location of the resource.
properties	object	The set of properties specific to bot channel resource
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

list_with_keys

If resource is retrieved successfully, the service should return 200 (OK).

Name	Datatype	Description
changedTime	string	Changed time of the resource
entityTag	string	Entity tag of the resource
properties	object	The set of properties specific to bot channel resource
provisioningState	string	Provisioning state of the resource
resource	object	The set of properties specific to bot channel resource
setting	object	Channel settings

list_by_resource_group

The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code.
The nextLink field is expected to point to the URL the client should use to fetch the next page (per server side paging). This matches the OData guidelines for paged responses here. If a resource provider does not support paging, it should return the same body (JSON object with “value” property) but omit nextLink entirely (or set to null, not empty string) for future compatibility.
The nextLink should be implemented using following query parameters:
· skipToken: opaque token that allows the resource provider to skip resources already enumerated. This value is defined and returned by the RP after first request via nextLink.
· top: the optional client query parameter which defines the maximum number of records to be returned by the server.
Implementation details:
· NextLink may include all the query parameters (specifically OData $filter) used by the client in the first query.
· Server may return less records than requested with nextLink. Returning zero records with NextLink is an acceptable response.
Clients must fetch records until the nextLink is not returned back / null. Clients should never rely on number of returned records to determinate if pagination is completed.

Name	Datatype	Description
id	string	Specifies the resource ID.
name	string	Specifies the name of the resource.
etag	string	Entity Tag.
kind	string	Required. Gets or sets the Kind of the resource.
location	string	Specifies the location of the resource.
properties	object	The set of properties specific to bot channel resource
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

The following methods are available for this resource:

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

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	The name of the Bot resource.
resourceGroupName	string	The name of the Bot resource group in the user subscription.
resourceName	string	The name of the Bot resource.
subscriptionId	string	Azure Subscription ID.

SELECT examples

get

Returns a BotService Channel registration specified by the parameters.

SELECT
id,
name,
etag,
kind,
location,
properties,
sku,
tags,
type,
zones
FROM azure.bot_service.channels
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
AND channelName = '{{ channelName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_with_keys

Lists a Channel registration for a Bot Service including secrets

SELECT
changedTime,
entityTag,
properties,
provisioningState,
resource,
setting
FROM azure.bot_service.channels
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
AND channelName = '{{ channelName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_resource_group

Returns all the Channel registrations of a particular BotService resource

SELECT
id,
name,
etag,
kind,
location,
properties,
sku,
tags,
type,
zones
FROM azure.bot_service.channels
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

Creates a Channel registration for a Bot Service

INSERT INTO azure.bot_service.channels (
data__location,
data__tags,
data__sku,
data__kind,
data__etag,
data__properties,
resourceGroupName,
resourceName,
channelName,
subscriptionId
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ sku }}',
'{{ kind }}',
'{{ etag }}',
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ resourceName }}',
'{{ channelName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
etag,
kind,
location,
properties,
sku,
tags,
type,
zones
;

Manifest

# Description fields are for documentation purposes
- name: channels
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the channels resource.
    - name: resourceName
      value: string
      description: Required parameter for the channels resource.
    - name: channelName
      value: string
      description: Required parameter for the channels resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the channels resource.
    - name: location
      value: string
      description: |
        Specifies the location of the resource.
    - name: tags
      value: object
      description: |
        Contains resource tags defined as key/value pairs.
    - name: sku
      value: object
      description: |
        The SKU of the cognitive services account.
    - name: kind
      value: string
      description: |
        Required. Gets or sets the Kind of the resource.
      valid_values: ['sdk', 'designer', 'bot', 'function', 'azurebot']
    - name: etag
      value: string
      description: |
        Entity Tag.
    - name: properties
      value: object
      description: |
        The set of properties specific to bot channel resource

UPDATE examples

update

Updates a Channel registration for a Bot Service

UPDATE azure.bot_service.channels
SET 
data__location = '{{ location }}',
data__tags = '{{ tags }}',
data__sku = '{{ sku }}',
data__kind = '{{ kind }}',
data__etag = '{{ etag }}',
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceName = '{{ resourceName }}' --required
AND channelName = '{{ channelName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --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 resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceName = '{{ resourceName }}' --required
AND channelName = '{{ channelName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;