Share via

Bots interface

  • Reference
Package:
@azure/arm-healthbot

Interface representing a Bots.

Methods

beginCreate(string, string, HealthBot, BotsCreateOptionalParams)

Create a new Azure Health Bot.
beginCreateAndWait(string, string, HealthBot, BotsCreateOptionalParams)

Create a new Azure Health Bot.
beginDelete(string, string, BotsDeleteOptionalParams)

Delete a HealthBot.
beginDeleteAndWait(string, string, BotsDeleteOptionalParams)

Delete a HealthBot.
get(string, string, BotsGetOptionalParams)

Get a HealthBot.
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, HealthBotUpdateParameters, BotsUpdateOptionalParams)

Patch a HealthBot.

Method Details

beginCreate(string, string, HealthBot, BotsCreateOptionalParams)

Create a new Azure Health Bot.

function beginCreate(resourceGroupName: string, botName: string, parameters: HealthBot, options?: BotsCreateOptionalParams): Promise<PollerLike<PollOperationState<HealthBot>, HealthBot>>

Parameters

resourceGroupName

string

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

botName

string

The name of the Bot resource.

parameters
HealthBot

The parameters to provide for the created Azure Health Bot.

options
BotsCreateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<HealthBot>, HealthBot>>

beginCreateAndWait(string, string, HealthBot, BotsCreateOptionalParams)

Create a new Azure Health Bot.

function beginCreateAndWait(resourceGroupName: string, botName: string, parameters: HealthBot, options?: BotsCreateOptionalParams): Promise<HealthBot>

Parameters

resourceGroupName

string

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

botName

string

The name of the Bot resource.

parameters
HealthBot

The parameters to provide for the created Azure Health Bot.

options
BotsCreateOptionalParams

The options parameters.

Returns

Promise<HealthBot>

beginDelete(string, string, BotsDeleteOptionalParams)

Delete a HealthBot.

function beginDelete(resourceGroupName: string, botName: string, options?: BotsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

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

botName

string

The name of the Bot resource.

options
BotsDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, BotsDeleteOptionalParams)

Delete a HealthBot.

function beginDeleteAndWait(resourceGroupName: string, botName: string, options?: BotsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

botName

string

The name of the Bot resource.

options
BotsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, BotsGetOptionalParams)

Get a HealthBot.

function get(resourceGroupName: string, botName: string, options?: BotsGetOptionalParams): Promise<HealthBot>

Parameters

resourceGroupName

string

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

botName

string

The name of the Bot resource.

options
BotsGetOptionalParams

The options parameters.

Returns

Promise<HealthBot>

list(BotsListOptionalParams)

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

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

Parameters

options
BotsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<HealthBot, HealthBot[], PageSettings>

listByResourceGroup(string, BotsListByResourceGroupOptionalParams)

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

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

Parameters

resourceGroupName

string

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

options
BotsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<HealthBot, HealthBot[], PageSettings>

update(string, string, HealthBotUpdateParameters, BotsUpdateOptionalParams)

Patch a HealthBot.

function update(resourceGroupName: string, botName: string, parameters: HealthBotUpdateParameters, options?: BotsUpdateOptionalParams): Promise<HealthBot>

Parameters

resourceGroupName

string

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

botName

string

The name of the Bot resource.

parameters
HealthBotUpdateParameters

The parameters to provide for the required Azure Health Bot.

options
BotsUpdateOptionalParams

The options parameters.

Returns

Promise<HealthBot>