ChannelsOperations Class

ChannelsOperations 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

ChannelsOperations

Constructor

ChannelsOperations(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 Channel registration for a Bot Service.
delete	Deletes a Channel registration from a Bot Service.
get	Returns a BotService Channel registration specified by the parameters.
list_by_resource_group	Returns all the Channel registrations of a particular BotService resource.
list_with_keys	Lists a Channel registration for a Bot Service including secrets.
update	Updates a Channel registration for a Bot Service.

create

Creates a Channel registration for a Bot Service.

async create(resource_group_name: str, resource_name: str, channel_name: Union[str, azure.mgmt.botservice.models._azure_bot_service_enums.ChannelName], parameters: azure.mgmt.botservice.models._models_py3.BotChannel, **kwargs: Any) -> azure.mgmt.botservice.models._models_py3.BotChannel

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.

channel_name

str or ChannelName

Required

The name of the Channel resource.

parameters

BotChannel

Required

The parameters to provide for the created bot.

cls

callable

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

Returns

BotChannel, or the result of cls(response)

Return type

BotChannel

Exceptions

HttpResponseError

delete

Deletes a Channel registration from a Bot Service.

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

channel_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 Channel registration specified by the parameters.

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

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.

channel_name

str

Required

The name of the Bot resource.

cls

callable

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

Returns

BotChannel, or the result of cls(response)

Return type

BotChannel

Exceptions

HttpResponseError

list_by_resource_group

Returns all the Channel registrations of a particular BotService resource.

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

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 ChannelResponseList or the result of cls(response)

Return type

AsyncItemPaged[ChannelResponseList]

Exceptions

HttpResponseError

list_with_keys

Lists a Channel registration for a Bot Service including secrets.

async list_with_keys(resource_group_name: str, resource_name: str, channel_name: Union[str, azure.mgmt.botservice.models._azure_bot_service_enums.ChannelName], **kwargs: Any) -> azure.mgmt.botservice.models._models_py3.BotChannel

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.

channel_name

str or ChannelName

Required

The name of the Channel resource.

cls

callable

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

Returns

BotChannel, or the result of cls(response)

Return type

BotChannel

Exceptions

HttpResponseError

update

Updates a Channel registration for a Bot Service.

async update(resource_group_name: str, resource_name: str, channel_name: Union[str, azure.mgmt.botservice.models._azure_bot_service_enums.ChannelName], 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.Channel] = None, **kwargs: Any) -> azure.mgmt.botservice.models._models_py3.BotChannel

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.

channel_name

str or ChannelName

Required

The name of the Channel 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

Channel

default value: None

The set of properties specific to bot channel resource.

cls

callable

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

Returns

BotChannel, or the result of cls(response)

Return type

BotChannel

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