BotConnection interface

Package:

@azure/arm-botservice

Interface representing a BotConnection.

Methods

create(string, string, string, ConnectionSetting, BotConnectionCreateOptionalParams)	Register a new Auth Connection for a Bot Service
delete(string, string, string, BotConnectionDeleteOptionalParams)	Deletes a Connection Setting registration for a Bot Service
get(string, string, string, BotConnectionGetOptionalParams)	Get a Connection Setting registration for a Bot Service
listByBotService(string, string, BotConnectionListByBotServiceOptionalParams)	Returns all the Connection Settings registered to a particular BotService resource
listServiceProviders(BotConnectionListServiceProvidersOptionalParams)	Lists the available Service Providers for creating Connection Settings
listWithSecrets(string, string, string, BotConnectionListWithSecretsOptionalParams)	Get a Connection Setting registration for a Bot Service
update(string, string, string, ConnectionSetting, BotConnectionUpdateOptionalParams)	Updates a Connection Setting registration for a Bot Service

Method Details

create(string, string, string, ConnectionSetting, BotConnectionCreateOptionalParams)

Register a new Auth Connection for a Bot Service

function create(resourceGroupName: string, resourceName: string, connectionName: string, parameters: ConnectionSetting, options?: BotConnectionCreateOptionalParams): Promise<ConnectionSetting>

Parameters

resourceGroupName

string

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

resourceName

string

The name of the Bot resource.

connectionName

string

The name of the Bot Service Connection Setting resource.

parameters

ConnectionSetting

The parameters to provide for creating the Connection Setting.

options

BotConnectionCreateOptionalParams

The options parameters.

Returns

Promise<ConnectionSetting>

delete(string, string, string, BotConnectionDeleteOptionalParams)

Deletes a Connection Setting registration for a Bot Service

function delete(resourceGroupName: string, resourceName: string, connectionName: string, options?: BotConnectionDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

resourceName

string

The name of the Bot resource.

connectionName

string

The name of the Bot Service Connection Setting resource.

options

BotConnectionDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, BotConnectionGetOptionalParams)

Get a Connection Setting registration for a Bot Service

function get(resourceGroupName: string, resourceName: string, connectionName: string, options?: BotConnectionGetOptionalParams): Promise<ConnectionSetting>

Parameters

resourceGroupName

string

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

resourceName

string

The name of the Bot resource.

connectionName

string

The name of the Bot Service Connection Setting resource.

options

BotConnectionGetOptionalParams

The options parameters.

Returns

Promise<ConnectionSetting>

listByBotService(string, string, BotConnectionListByBotServiceOptionalParams)

Returns all the Connection Settings registered to a particular BotService resource

function listByBotService(resourceGroupName: string, resourceName: string, options?: BotConnectionListByBotServiceOptionalParams): PagedAsyncIterableIterator<ConnectionSetting, ConnectionSetting[], PageSettings>

Parameters

resourceGroupName

string

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

resourceName

string

The name of the Bot resource.

options

BotConnectionListByBotServiceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ConnectionSetting, ConnectionSetting[], PageSettings>

listServiceProviders(BotConnectionListServiceProvidersOptionalParams)

Lists the available Service Providers for creating Connection Settings

function listServiceProviders(options?: BotConnectionListServiceProvidersOptionalParams): Promise<ServiceProviderResponseList>

Parameters

options

BotConnectionListServiceProvidersOptionalParams

The options parameters.

Returns

Promise<ServiceProviderResponseList>

listWithSecrets(string, string, string, BotConnectionListWithSecretsOptionalParams)

Get a Connection Setting registration for a Bot Service

function listWithSecrets(resourceGroupName: string, resourceName: string, connectionName: string, options?: BotConnectionListWithSecretsOptionalParams): Promise<ConnectionSetting>

Parameters

resourceGroupName

string

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

resourceName

string

The name of the Bot resource.

connectionName

string

The name of the Bot Service Connection Setting resource.

options

BotConnectionListWithSecretsOptionalParams

The options parameters.

Returns

Promise<ConnectionSetting>

update(string, string, string, ConnectionSetting, BotConnectionUpdateOptionalParams)

Updates a Connection Setting registration for a Bot Service

function update(resourceGroupName: string, resourceName: string, connectionName: string, parameters: ConnectionSetting, options?: BotConnectionUpdateOptionalParams): Promise<ConnectionSetting>

Parameters

resourceGroupName

string

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

resourceName

string

The name of the Bot resource.

connectionName

string

The name of the Bot Service Connection Setting resource.

parameters

ConnectionSetting

The parameters to provide for updating the Connection Setting.

options

BotConnectionUpdateOptionalParams

The options parameters.

Returns

Promise<ConnectionSetting>