BotConnectionOperations Class

BotConnectionOperations 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

BotConnectionOperations

Constructor

BotConnectionOperations(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	Register a new Auth Connection for a Bot Service.
delete	Deletes a Connection Setting registration for a Bot Service.
get	Get a Connection Setting registration for a Bot Service.
list_by_bot_service	Returns all the Connection Settings registered to a particular BotService resource.
list_service_providers	Lists the available Service Providers for creating Connection Settings.
list_with_secrets	Get a Connection Setting registration for a Bot Service.
update	Updates a Connection Setting registration for a Bot Service.

create

Register a new Auth Connection for a Bot Service.

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

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.

connection_name

str

Required

The name of the Bot Service Connection Setting resource.

parameters

ConnectionSetting

Required

The parameters to provide for creating the Connection Setting.

cls

callable

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

Returns

ConnectionSetting, or the result of cls(response)

Return type

ConnectionSetting

Exceptions

HttpResponseError

delete

Deletes a Connection Setting registration for a Bot Service.

async delete(resource_group_name: str, resource_name: str, connection_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.

connection_name

str

Required

The name of the Bot Service Connection Setting 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

Get a Connection Setting registration for a Bot Service.

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

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.

connection_name

str

Required

The name of the Bot Service Connection Setting resource.

cls

callable

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

Returns

ConnectionSetting, or the result of cls(response)

Return type

ConnectionSetting

Exceptions

HttpResponseError

list_by_bot_service

Returns all the Connection Settings registered to a particular BotService resource.

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

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

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

Return type

AsyncItemPaged[ConnectionSettingResponseList]

Exceptions

HttpResponseError

list_service_providers

Lists the available Service Providers for creating Connection Settings.

async list_service_providers(**kwargs: Any) -> azure.mgmt.botservice.models._models_py3.ServiceProviderResponseList

Parameters

cls

callable

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

Returns

ServiceProviderResponseList, or the result of cls(response)

Return type

ServiceProviderResponseList

Exceptions

HttpResponseError

list_with_secrets

Get a Connection Setting registration for a Bot Service.

async list_with_secrets(resource_group_name: str, resource_name: str, connection_name: str, **kwargs: Any) -> azure.mgmt.botservice.models._models_py3.ConnectionSetting

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.

connection_name

str

Required

The name of the Bot Service Connection Setting resource.

cls

callable

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

Returns

ConnectionSetting, or the result of cls(response)

Return type

ConnectionSetting

Exceptions

HttpResponseError

update

Updates a Connection Setting registration for a Bot Service.

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

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.

connection_name

str

Required

The name of the Bot Service Connection Setting resource.

parameters

ConnectionSetting

Required

The parameters to provide for updating the Connection Setting.

cls

callable

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

Returns

ConnectionSetting, or the result of cls(response)

Return type

ConnectionSetting

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'>