Partager via


Bots interface

Interface representing a Bots.

Methods

create(string, string, Bot, BotsCreateOptionalParams)

Creates a Bot Service. Bot Service is a resource group wide resource type.

delete(string, string, BotsDeleteOptionalParams)

Deletes a Bot Service from the resource group.

get(string, string, BotsGetOptionalParams)

Returns a BotService specified by the parameters.

getCheckNameAvailability(CheckNameAvailabilityRequestBody, BotsGetCheckNameAvailabilityOptionalParams)

Check whether a bot name is available.

list(BotsListOptionalParams)

Returns all the resources of a particular type belonging to a subscription.

listByResourceGroup(string, BotsListByResourceGroupOptionalParams)

Returns all the resources of a particular type belonging to a resource group

update(string, string, BotsUpdateOptionalParams)

Updates a Bot Service

Method Details

create(string, string, Bot, BotsCreateOptionalParams)

Creates a Bot Service. Bot Service is a resource group wide resource type.

function create(resourceGroupName: string, resourceName: string, parameters: Bot, options?: BotsCreateOptionalParams): Promise<Bot>

Parameters

resourceGroupName

string

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

resourceName

string

The name of the Bot resource.

parameters
Bot

The parameters to provide for the created bot.

options
BotsCreateOptionalParams

The options parameters.

Returns

Promise<Bot>

delete(string, string, BotsDeleteOptionalParams)

Deletes a Bot Service from the resource group.

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

Parameters

resourceGroupName

string

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

resourceName

string

The name of the Bot resource.

options
BotsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, BotsGetOptionalParams)

Returns a BotService specified by the parameters.

function get(resourceGroupName: string, resourceName: string, options?: BotsGetOptionalParams): Promise<Bot>

Parameters

resourceGroupName

string

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

resourceName

string

The name of the Bot resource.

options
BotsGetOptionalParams

The options parameters.

Returns

Promise<Bot>

getCheckNameAvailability(CheckNameAvailabilityRequestBody, BotsGetCheckNameAvailabilityOptionalParams)

Check whether a bot name is available.

function getCheckNameAvailability(parameters: CheckNameAvailabilityRequestBody, options?: BotsGetCheckNameAvailabilityOptionalParams): Promise<CheckNameAvailabilityResponseBody>

Parameters

parameters
CheckNameAvailabilityRequestBody

The request body parameters to provide for the check name availability request

options
BotsGetCheckNameAvailabilityOptionalParams

The options parameters.

Returns

list(BotsListOptionalParams)

Returns all the resources of a particular type belonging to a subscription.

function list(options?: BotsListOptionalParams): PagedAsyncIterableIterator<Bot, Bot[], PageSettings>

Parameters

options
BotsListOptionalParams

The options parameters.

Returns

listByResourceGroup(string, BotsListByResourceGroupOptionalParams)

Returns all the resources of a particular type belonging to a resource group

function listByResourceGroup(resourceGroupName: string, options?: BotsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Bot, Bot[], PageSettings>

Parameters

resourceGroupName

string

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

options
BotsListByResourceGroupOptionalParams

The options parameters.

Returns

update(string, string, BotsUpdateOptionalParams)

Updates a Bot Service

function update(resourceGroupName: string, resourceName: string, options?: BotsUpdateOptionalParams): Promise<Bot>

Parameters

resourceGroupName

string

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

resourceName

string

The name of the Bot resource.

options
BotsUpdateOptionalParams

The options parameters.

Returns

Promise<Bot>