Channels interface

Package:

@azure/arm-botservice

Interface representing a Channels.

Methods

create(string, string, ChannelName, BotChannel, ChannelsCreateOptionalParams)	Creates a Channel registration for a Bot Service
delete(string, string, string, ChannelsDeleteOptionalParams)	Deletes a Channel registration from a Bot Service
get(string, string, string, ChannelsGetOptionalParams)	Returns a BotService Channel registration specified by the parameters.
listByResourceGroup(string, string, ChannelsListByResourceGroupOptionalParams)	Returns all the Channel registrations of a particular BotService resource
listWithKeys(string, string, ChannelName, ChannelsListWithKeysOptionalParams)	Lists a Channel registration for a Bot Service including secrets
update(string, string, ChannelName, ChannelsUpdateOptionalParams)	Updates a Channel registration for a Bot Service

Method Details

create(string, string, ChannelName, BotChannel, ChannelsCreateOptionalParams)

Creates a Channel registration for a Bot Service

function create(resourceGroupName: string, resourceName: string, channelName: ChannelName, parameters: BotChannel, options?: ChannelsCreateOptionalParams): Promise<BotChannel>

Parameters

resourceGroupName

string

The name of the Bot resource group in the user subscription.

resourceName

string

The name of the Bot resource.

channelName

ChannelName

The name of the Channel resource.

parameters

BotChannel

The parameters to provide for the created bot.

options

ChannelsCreateOptionalParams

The options parameters.

Returns

Promise<BotChannel>

delete(string, string, string, ChannelsDeleteOptionalParams)

Deletes a Channel registration from a Bot Service

function delete(resourceGroupName: string, resourceName: string, channelName: string, options?: ChannelsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the Bot resource group in the user subscription.

resourceName

string

The name of the Bot resource.

channelName

string

The name of the Bot resource.

options

ChannelsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, ChannelsGetOptionalParams)

Returns a BotService Channel registration specified by the parameters.

function get(resourceGroupName: string, resourceName: string, channelName: string, options?: ChannelsGetOptionalParams): Promise<BotChannel>

Parameters

resourceGroupName

string

The name of the Bot resource group in the user subscription.

resourceName

string

The name of the Bot resource.

channelName

string

The name of the Bot resource.

options

ChannelsGetOptionalParams

The options parameters.

Returns

Promise<BotChannel>

listByResourceGroup(string, string, ChannelsListByResourceGroupOptionalParams)

Returns all the Channel registrations of a particular BotService resource

function listByResourceGroup(resourceGroupName: string, resourceName: string, options?: ChannelsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<BotChannel, BotChannel[], PageSettings>

Parameters

resourceGroupName

string

The name of the Bot resource group in the user subscription.

resourceName

string

The name of the Bot resource.

options

ChannelsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<BotChannel, BotChannel[], PageSettings>

listWithKeys(string, string, ChannelName, ChannelsListWithKeysOptionalParams)

Lists a Channel registration for a Bot Service including secrets

function listWithKeys(resourceGroupName: string, resourceName: string, channelName: ChannelName, options?: ChannelsListWithKeysOptionalParams): Promise<ListChannelWithKeysResponse>

Parameters

resourceGroupName

string

The name of the Bot resource group in the user subscription.

resourceName

string

The name of the Bot resource.

channelName

ChannelName

The name of the Channel resource.

options

ChannelsListWithKeysOptionalParams

The options parameters.

Returns

Promise<ListChannelWithKeysResponse>

update(string, string, ChannelName, ChannelsUpdateOptionalParams)

Updates a Channel registration for a Bot Service

function update(resourceGroupName: string, resourceName: string, channelName: ChannelName, options?: ChannelsUpdateOptionalParams): Promise<BotChannel>

Parameters

resourceGroupName

string

The name of the Bot resource group in the user subscription.

resourceName

string

The name of the Bot resource.

channelName

ChannelName

The name of the Channel resource.

options

ChannelsUpdateOptionalParams

The options parameters.

Returns

Promise<BotChannel>