azure.mgmt.botservice.operations module

class azure.mgmt.botservice.operations.BotsOperations(client, config, serializer, deserializer)[source]

Bases: object

BotsOperations operations.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Version of the API to be used with the client request. Constant value: “2018-07-12”.

create(resource_group_name, resource_name, parameters, custom_headers=None, raw=False, **operation_config)[source]

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

Parameters

  • resource_group_name (str) – The name of the Bot resource group in the user subscription.

  • resource_name (str) – The name of the Bot resource.

  • parameters (Bot) – The parameters to provide for the created bot.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

Bot or ClientRawResponse if raw=true

Return type

Bot or ClientRawResponse

Raises

ErrorException

delete(resource_group_name, resource_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes a Bot Service from the resource group. .

Parameters

  • resource_group_name (str) – The name of the Bot resource group in the user subscription.

  • resource_name (str) – The name of the Bot resource.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

ErrorException

get(resource_group_name, resource_name, custom_headers=None, raw=False, **operation_config)[source]

Returns a BotService specified by the parameters.

Parameters

  • resource_group_name (str) – The name of the Bot resource group in the user subscription.

  • resource_name (str) – The name of the Bot resource.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

Bot or ClientRawResponse if raw=true

Return type

Bot or ClientRawResponse

Raises

ErrorException

get_check_name_availability(name=None, type=None, custom_headers=None, raw=False, **operation_config)[source]

Check whether a bot name is available.

Parameters

  • name (str) – the name of the bot for which availability needs to be checked.

  • type (str) – the type of the bot for which availability needs to be checked

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

CheckNameAvailabilityResponseBody or ClientRawResponse if raw=true

Return type

CheckNameAvailabilityResponseBody or ClientRawResponse

Raises

ErrorException

list(custom_headers=None, raw=False, **operation_config)[source]

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

Parameters

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of Bot

Return type

BotPaged[Bot]

Raises

ErrorException

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]

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

Parameters

  • resource_group_name (str) – The name of the Bot resource group in the user subscription.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of Bot

Return type

BotPaged[Bot]

Raises

ErrorException

update(resource_group_name, resource_name, location=None, tags=None, sku=None, kind=None, etag=None, properties=None, custom_headers=None, raw=False, **operation_config)[source]

Updates a Bot Service.

Parameters

  • resource_group_name (str) – The name of the Bot resource group in the user subscription.

  • resource_name (str) – The name of the Bot resource.

  • location (str) – Specifies the location of the resource.

  • tags (dict[str, str]) – Contains resource tags defined as key/value pairs.

  • sku (Sku) – Gets or sets the SKU of the resource.

  • kind (str or Kind) – Required. Gets or sets the Kind of the resource. Possible values include: ‘sdk’, ‘designer’, ‘bot’, ‘function’

  • etag (str) – Entity Tag

  • properties (BotProperties) – The set of properties specific to bot resource

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

Bot or ClientRawResponse if raw=true

Return type

Bot or ClientRawResponse

Raises

ErrorException

models = <module 'azure.mgmt.botservice.models' from '/home/vsts/work/1/s/sdk/botservice/azure-mgmt-botservice/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/botservice/models/__init__.py'>
class azure.mgmt.botservice.operations.ChannelsOperations(client, config, serializer, deserializer)[source]

Bases: object

ChannelsOperations operations.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Version of the API to be used with the client request. Constant value: “2018-07-12”.

create(resource_group_name, resource_name, channel_name, parameters, custom_headers=None, raw=False, **operation_config)[source]

Creates a Channel registration for a Bot Service.

Parameters

  • resource_group_name (str) – The name of the Bot resource group in the user subscription.

  • resource_name (str) – The name of the Bot resource.

  • channel_name (str or ChannelName) – The name of the Channel resource. Possible values include: ‘FacebookChannel’, ‘EmailChannel’, ‘KikChannel’, ‘TelegramChannel’, ‘SlackChannel’, ‘MsTeamsChannel’, ‘SkypeChannel’, ‘WebChatChannel’, ‘DirectLineChannel’, ‘SmsChannel’

  • parameters (BotChannel) – The parameters to provide for the created bot.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

BotChannel or ClientRawResponse if raw=true

Return type

BotChannel or ClientRawResponse

Raises

ErrorException

delete(resource_group_name, resource_name, channel_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes a Channel registration from a Bot Service.

Parameters

  • resource_group_name (str) – The name of the Bot resource group in the user subscription.

  • resource_name (str) – The name of the Bot resource.

  • channel_name (str) – The name of the Bot resource.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

ErrorException

get(resource_group_name, resource_name, channel_name, custom_headers=None, raw=False, **operation_config)[source]

Returns a BotService Channel registration specified by the parameters.

Parameters

  • resource_group_name (str) – The name of the Bot resource group in the user subscription.

  • resource_name (str) – The name of the Bot resource.

  • channel_name (str) – The name of the Bot resource.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

BotChannel or ClientRawResponse if raw=true

Return type

BotChannel or ClientRawResponse

Raises

ErrorException

list_by_resource_group(resource_group_name, resource_name, custom_headers=None, raw=False, **operation_config)[source]

Returns all the Channel registrations of a particular BotService resource.

Parameters

  • resource_group_name (str) – The name of the Bot resource group in the user subscription.

  • resource_name (str) – The name of the Bot resource.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of BotChannel

Return type

BotChannelPaged[BotChannel]

Raises

ErrorException

list_with_keys(resource_group_name, resource_name, channel_name, custom_headers=None, raw=False, **operation_config)[source]

Lists a Channel registration for a Bot Service including secrets.

Parameters

  • resource_group_name (str) – The name of the Bot resource group in the user subscription.

  • resource_name (str) – The name of the Bot resource.

  • channel_name (str or ChannelName) – The name of the Channel resource. Possible values include: ‘FacebookChannel’, ‘EmailChannel’, ‘KikChannel’, ‘TelegramChannel’, ‘SlackChannel’, ‘MsTeamsChannel’, ‘SkypeChannel’, ‘WebChatChannel’, ‘DirectLineChannel’, ‘SmsChannel’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

BotChannel or ClientRawResponse if raw=true

Return type

BotChannel or ClientRawResponse

Raises

ErrorException

update(resource_group_name, resource_name, channel_name, location=None, tags=None, sku=None, kind=None, etag=None, properties=None, custom_headers=None, raw=False, **operation_config)[source]

Updates a Channel registration for a Bot Service.

Parameters

  • resource_group_name (str) – The name of the Bot resource group in the user subscription.

  • resource_name (str) – The name of the Bot resource.

  • channel_name (str or ChannelName) – The name of the Channel resource. Possible values include: ‘FacebookChannel’, ‘EmailChannel’, ‘KikChannel’, ‘TelegramChannel’, ‘SlackChannel’, ‘MsTeamsChannel’, ‘SkypeChannel’, ‘WebChatChannel’, ‘DirectLineChannel’, ‘SmsChannel’

  • location (str) – Specifies the location of the resource.

  • tags (dict[str, str]) – Contains resource tags defined as key/value pairs.

  • sku (Sku) – Gets or sets the SKU of the resource.

  • kind (str or Kind) – Required. Gets or sets the Kind of the resource. Possible values include: ‘sdk’, ‘designer’, ‘bot’, ‘function’

  • etag (str) – Entity Tag

  • properties (Channel) – The set of properties specific to bot channel resource

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

BotChannel or ClientRawResponse if raw=true

Return type

BotChannel or ClientRawResponse

Raises

ErrorException

models = <module 'azure.mgmt.botservice.models' from '/home/vsts/work/1/s/sdk/botservice/azure-mgmt-botservice/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/botservice/models/__init__.py'>
class azure.mgmt.botservice.operations.Operations(client, config, serializer, deserializer)[source]

Bases: object

Operations operations.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Version of the API to be used with the client request. Constant value: “2018-07-12”.

list(custom_headers=None, raw=False, **operation_config)[source]

Lists all the available BotService operations.

Parameters

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of OperationEntity

Return type

OperationEntityPaged[OperationEntity]

Raises

CloudError

models = <module 'azure.mgmt.botservice.models' from '/home/vsts/work/1/s/sdk/botservice/azure-mgmt-botservice/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/botservice/models/__init__.py'>
class azure.mgmt.botservice.operations.BotConnectionOperations(client, config, serializer, deserializer)[source]

Bases: object

BotConnectionOperations operations.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Version of the API to be used with the client request. Constant value: “2018-07-12”.

create(resource_group_name, resource_name, connection_name, parameters, custom_headers=None, raw=False, **operation_config)[source]

Register a new Auth Connection for a Bot Service.

Parameters

  • resource_group_name (str) – The name of the Bot resource group in the user subscription.

  • resource_name (str) – The name of the Bot resource.

  • connection_name (str) – The name of the Bot Service Connection Setting resource

  • parameters (ConnectionSetting) – The parameters to provide for creating the Connection Setting.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

ConnectionSetting or ClientRawResponse if raw=true

Return type

ConnectionSetting or ClientRawResponse

Raises

ErrorException

delete(resource_group_name, resource_name, connection_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes a Connection Setting registration for a Bot Service.

Parameters

  • resource_group_name (str) – The name of the Bot resource group in the user subscription.

  • resource_name (str) – The name of the Bot resource.

  • connection_name (str) – The name of the Bot Service Connection Setting resource

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

ErrorException

get(resource_group_name, resource_name, connection_name, custom_headers=None, raw=False, **operation_config)[source]

Get a Connection Setting registration for a Bot Service.

Parameters

  • resource_group_name (str) – The name of the Bot resource group in the user subscription.

  • resource_name (str) – The name of the Bot resource.

  • connection_name (str) – The name of the Bot Service Connection Setting resource

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

ConnectionSetting or ClientRawResponse if raw=true

Return type

ConnectionSetting or ClientRawResponse

Raises

ErrorException

list_by_bot_service(resource_group_name, resource_name, custom_headers=None, raw=False, **operation_config)[source]

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

Parameters

  • resource_group_name (str) – The name of the Bot resource group in the user subscription.

  • resource_name (str) – The name of the Bot resource.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of ConnectionSetting

Return type

ConnectionSettingPaged[ConnectionSetting]

Raises

ErrorException

list_service_providers(custom_headers=None, raw=False, **operation_config)[source]

Lists the available Service Providers for creating Connection Settings.

Parameters

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

ServiceProviderResponseList or ClientRawResponse if raw=true

Return type

ServiceProviderResponseList or ClientRawResponse

Raises

ErrorException

list_with_secrets(resource_group_name, resource_name, connection_name, custom_headers=None, raw=False, **operation_config)[source]

Get a Connection Setting registration for a Bot Service.

Parameters

  • resource_group_name (str) – The name of the Bot resource group in the user subscription.

  • resource_name (str) – The name of the Bot resource.

  • connection_name (str) – The name of the Bot Service Connection Setting resource

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

ConnectionSetting or ClientRawResponse if raw=true

Return type

ConnectionSetting or ClientRawResponse

Raises

ErrorException

update(resource_group_name, resource_name, connection_name, parameters, custom_headers=None, raw=False, **operation_config)[source]

Updates a Connection Setting registration for a Bot Service.

Parameters

  • resource_group_name (str) – The name of the Bot resource group in the user subscription.

  • resource_name (str) – The name of the Bot resource.

  • connection_name (str) – The name of the Bot Service Connection Setting resource

  • parameters (ConnectionSetting) – The parameters to provide for updating the Connection Setting.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

ConnectionSetting or ClientRawResponse if raw=true

Return type

ConnectionSetting or ClientRawResponse

Raises

ErrorException

models = <module 'azure.mgmt.botservice.models' from '/home/vsts/work/1/s/sdk/botservice/azure-mgmt-botservice/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/botservice/models/__init__.py'>
class azure.mgmt.botservice.operations.EnterpriseChannelsOperations(client, config, serializer, deserializer)[source]

Bases: object

EnterpriseChannelsOperations operations.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Version of the API to be used with the client request. Constant value: “2018-07-12”.

check_name_availability(name=None, custom_headers=None, raw=False, **operation_config)[source]

Check whether an Enterprise Channel name is available.

Parameters

  • name (str) – The name of the Enterprise Channel for which availability needs to be checked.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

EnterpriseChannelCheckNameAvailabilityResponse or ClientRawResponse if raw=true

Return type

EnterpriseChannelCheckNameAvailabilityResponse or ClientRawResponse

Raises

ErrorException

create(resource_group_name, resource_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Creates an Enterprise Channel.

Parameters

  • resource_group_name (str) – The name of the Bot resource group in the user subscription.

  • resource_name (str) – The name of the Bot resource.

  • parameters (EnterpriseChannel) – The parameters to provide for the new Enterprise Channel.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns EnterpriseChannel or ClientRawResponse<EnterpriseChannel> if raw==True

Return type

AzureOperationPoller[EnterpriseChannel] or AzureOperationPoller[ClientRawResponse[EnterpriseChannel]]

Raises

ErrorException

delete(resource_group_name, resource_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Deletes an Enterprise Channel from the resource group.

Parameters

  • resource_group_name (str) – The name of the Bot resource group in the user subscription.

  • resource_name (str) – The name of the Bot resource.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

ErrorException

get(resource_group_name, resource_name, custom_headers=None, raw=False, **operation_config)[source]

Returns an Enterprise Channel specified by the parameters.

Parameters

  • resource_group_name (str) – The name of the Bot resource group in the user subscription.

  • resource_name (str) – The name of the Bot resource.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

EnterpriseChannel or ClientRawResponse if raw=true

Return type

EnterpriseChannel or ClientRawResponse

Raises

ErrorException

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]

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

Parameters

  • resource_group_name (str) – The name of the Bot resource group in the user subscription.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of EnterpriseChannel

Return type

EnterpriseChannelPaged[EnterpriseChannel]

Raises

ErrorException

update(resource_group_name, resource_name, location=None, tags=None, sku=None, kind=None, etag=None, properties=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Updates an Enterprise Channel.

Parameters

  • resource_group_name (str) – The name of the Bot resource group in the user subscription.

  • resource_name (str) – The name of the Bot resource.

  • location (str) – Specifies the location of the resource.

  • tags (dict[str, str]) – Contains resource tags defined as key/value pairs.

  • sku (Sku) – Gets or sets the SKU of the resource.

  • kind (str or Kind) – Required. Gets or sets the Kind of the resource. Possible values include: ‘sdk’, ‘designer’, ‘bot’, ‘function’

  • etag (str) – Entity Tag

  • properties (EnterpriseChannelProperties) – The set of properties specific to an Enterprise Channel resource.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns EnterpriseChannel or ClientRawResponse<EnterpriseChannel> if raw==True

Return type

AzureOperationPoller[EnterpriseChannel] or AzureOperationPoller[ClientRawResponse[EnterpriseChannel]]

Raises

ErrorException

models = <module 'azure.mgmt.botservice.models' from '/home/vsts/work/1/s/sdk/botservice/azure-mgmt-botservice/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/botservice/models/__init__.py'>