BotsOperations Class

BotsOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

BotsOperations

Constructor

BotsOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

Methods

create	Creates a Bot Service. Bot Service is a resource group wide resource type.
delete	Deletes a Bot Service from the resource group.
get	Returns a BotService specified by the parameters.
get_check_name_availability	Check whether a bot name is available.
list	Returns all the resources of a particular type belonging to a subscription.
list_by_resource_group	Returns all the resources of a particular type belonging to a resource group.
update	Updates a Bot Service.

create

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

async create(resource_group_name: str, resource_name: str, parameters: azure.mgmt.botservice.models._models_py3.Bot, **kwargs: Any) -> azure.mgmt.botservice.models._models_py3.Bot

Parameters

resource_group_name

str

Required

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

resource_name

str

Required

The name of the Bot resource.

parameters

Bot

Required

The parameters to provide for the created bot.

cls

callable

A custom type or function that will be passed the direct response

Returns

Bot, or the result of cls(response)

Return type

Bot

Exceptions

HttpResponseError

delete

Deletes a Bot Service from the resource group.

async delete(resource_group_name: str, resource_name: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

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

resource_name

str

Required

The name of the Bot resource.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

get

Returns a BotService specified by the parameters.

async get(resource_group_name: str, resource_name: str, **kwargs: Any) -> azure.mgmt.botservice.models._models_py3.Bot

Parameters

resource_group_name

str

Required

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

resource_name

str

Required

The name of the Bot resource.

cls

callable

A custom type or function that will be passed the direct response

Returns

Bot, or the result of cls(response)

Return type

Bot

Exceptions

HttpResponseError

get_check_name_availability

Check whether a bot name is available.

async get_check_name_availability(parameters: azure.mgmt.botservice.models._models_py3.CheckNameAvailabilityRequestBody, **kwargs: Any) -> azure.mgmt.botservice.models._models_py3.CheckNameAvailabilityResponseBody

Parameters

parameters

CheckNameAvailabilityRequestBody

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

CheckNameAvailabilityResponseBody, or the result of cls(response)

Return type

CheckNameAvailabilityResponseBody

Exceptions

HttpResponseError

list

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

list(**kwargs: Any) -> AsyncIterable[azure.mgmt.botservice.models._models_py3.BotResponseList]

Parameters

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either BotResponseList or the result of cls(response)

Return type

AsyncItemPaged[BotResponseList]

Exceptions

HttpResponseError

list_by_resource_group

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

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.botservice.models._models_py3.BotResponseList]

Parameters

resource_group_name

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either BotResponseList or the result of cls(response)

Return type

AsyncItemPaged[BotResponseList]

Exceptions

HttpResponseError

update

Updates a Bot Service.

async update(resource_group_name: str, resource_name: str, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, sku: Optional[azure.mgmt.botservice.models._models_py3.Sku] = None, kind: Optional[Union[str, azure.mgmt.botservice.models._azure_bot_service_enums.Kind]] = None, etag: Optional[str] = None, properties: Optional[azure.mgmt.botservice.models._models_py3.BotProperties] = None, **kwargs: Any) -> azure.mgmt.botservice.models._models_py3.Bot

Parameters

resource_group_name

str

Required

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

resource_name

str

Required

The name of the Bot resource.

location

str

default value: None

Specifies the location of the resource.

tags

dict[str, str]

default value: None

Contains resource tags defined as key/value pairs.

sku

Sku

default value: None

Gets or sets the SKU of the resource.

kind

str or Kind

default value: None

Required. Gets or sets the Kind of the resource.

etag

str

default value: None

Entity Tag.

properties

BotProperties

default value: None

The set of properties specific to bot resource.

cls

callable

A custom type or function that will be passed the direct response

Returns

Bot, or the result of cls(response)

Return type

Bot

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.botservice.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\botservice\\models\\__init__.py'>