azure.mgmt.botservice.operations module¶
-
class
azure.mgmt.botservice.operations.
BotConnectionOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
BotConnectionOperations 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.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
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[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.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
ConnectionSetting, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
delete
(resource_group_name: str, resource_name: str, connection_name: str, **kwargs: Any) → None[source]¶ Deletes a Connection Setting registration for a Bot Service.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, resource_name: str, connection_name: str, **kwargs: Any) → azure.mgmt.botservice.models._models_py3.ConnectionSetting[source]¶ Get a Connection Setting registration for a Bot Service.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
ConnectionSetting, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_bot_service
(resource_group_name: str, resource_name: str, **kwargs: Any) → Iterable[azure.mgmt.botservice.models._models_py3.ConnectionSettingResponseList][source]¶ Returns all the Connection Settings registered to a particular BotService resource.
- Parameters
- Keyword Arguments
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
- Raises
~azure.core.exceptions.HttpResponseError
-
list_service_providers
(**kwargs: Any) → azure.mgmt.botservice.models._models_py3.ServiceProviderResponseList[source]¶ Lists the available Service Providers for creating Connection Settings.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
ServiceProviderResponseList, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_with_secrets
(resource_group_name: str, resource_name: str, connection_name: str, **kwargs: Any) → azure.mgmt.botservice.models._models_py3.ConnectionSetting[source]¶ Get a Connection Setting registration for a Bot Service.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
ConnectionSetting, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
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[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.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
ConnectionSetting, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.botservice.models' from '/mnt/vss/_work/1/s/sdk/botservice/azure-mgmt-botservice/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/botservice/models/__init__.py'>¶
-
class
azure.mgmt.botservice.operations.
BotsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
BotsOperations 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.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
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[source]¶ Creates a Bot Service. Bot Service is a resource group wide resource type.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
Bot, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
delete
(resource_group_name: str, resource_name: str, **kwargs: Any) → None[source]¶ Deletes a Bot Service from the resource group.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, resource_name: str, **kwargs: Any) → azure.mgmt.botservice.models._models_py3.Bot[source]¶ Returns a BotService specified by the parameters.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
Bot, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get_check_name_availability
(parameters: azure.mgmt.botservice.models._models_py3.CheckNameAvailabilityRequestBody, **kwargs: Any) → azure.mgmt.botservice.models._models_py3.CheckNameAvailabilityResponseBody[source]¶ Check whether a bot name is available.
- Parameters
parameters (CheckNameAvailabilityRequestBody) – The request body parameters to provide for the check name availability request.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
CheckNameAvailabilityResponseBody, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(**kwargs: Any) → Iterable[azure.mgmt.botservice.models._models_py3.BotResponseList][source]¶ Returns all the resources of a particular type belonging to a subscription.
- Keyword Arguments
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
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_resource_group
(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.botservice.models._models_py3.BotResponseList][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.
- Keyword Arguments
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
- Raises
~azure.core.exceptions.HttpResponseError
-
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[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.
etag (str) – Entity Tag.
properties (BotProperties) – The set of properties specific to bot resource.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
Bot, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.botservice.models' from '/mnt/vss/_work/1/s/sdk/botservice/azure-mgmt-botservice/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/botservice/models/__init__.py'>¶
-
class
azure.mgmt.botservice.operations.
ChannelsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ChannelsOperations 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.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
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[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.
parameters (BotChannel) – The parameters to provide for the created bot.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
BotChannel, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
delete
(resource_group_name: str, resource_name: str, channel_name: str, **kwargs: Any) → None[source]¶ Deletes a Channel registration from a Bot Service.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, resource_name: str, channel_name: str, **kwargs: Any) → azure.mgmt.botservice.models._models_py3.BotChannel[source]¶ Returns a BotService Channel registration specified by the parameters.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
BotChannel, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_resource_group
(resource_group_name: str, resource_name: str, **kwargs: Any) → Iterable[azure.mgmt.botservice.models._models_py3.ChannelResponseList][source]¶ Returns all the Channel registrations of a particular BotService resource.
- Parameters
- Keyword Arguments
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
- Raises
~azure.core.exceptions.HttpResponseError
-
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.ListChannelWithKeysResponse[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.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
ListChannelWithKeysResponse, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
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[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.
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.
etag (str) – Entity Tag.
properties (Channel) – The set of properties specific to bot channel resource.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
BotChannel, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.botservice.models' from '/mnt/vss/_work/1/s/sdk/botservice/azure-mgmt-botservice/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/botservice/models/__init__.py'>¶
-
class
azure.mgmt.botservice.operations.
DirectLineOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
DirectLineOperations 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.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
regenerate_keys
(resource_group_name: str, resource_name: str, channel_name: Union[str, azure.mgmt.botservice.models._azure_bot_service_enums.RegenerateKeysChannelName], parameters: azure.mgmt.botservice.models._models_py3.SiteInfo, **kwargs: Any) → azure.mgmt.botservice.models._models_py3.BotChannel[source]¶ Regenerates secret keys and returns them for the DirectLine Channel 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.
channel_name (str or RegenerateKeysChannelName) – The name of the Channel resource for which keys are to be regenerated.
parameters (SiteInfo) – The parameters to provide for the created bot.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
BotChannel, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.botservice.models' from '/mnt/vss/_work/1/s/sdk/botservice/azure-mgmt-botservice/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/botservice/models/__init__.py'>¶
-
class
azure.mgmt.botservice.operations.
HostSettingsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
HostSettingsOperations 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.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
get
(**kwargs: Any) → azure.mgmt.botservice.models._models_py3.HostSettingsResponse[source]¶ Get per subscription settings needed to host bot in compute resource such as Azure App Service.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
HostSettingsResponse, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.botservice.models' from '/mnt/vss/_work/1/s/sdk/botservice/azure-mgmt-botservice/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/botservice/models/__init__.py'>¶
-
class
azure.mgmt.botservice.operations.
OperationResultsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
OperationResultsOperations 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.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
begin_get
(operation_result_id: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.botservice.models._models_py3.OperationResultsDescription][source]¶ Get the operation result for a long running operation.
- Parameters
operation_result_id (str) – The ID of the operation result to get.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns either OperationResultsDescription or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.botservice.models' from '/mnt/vss/_work/1/s/sdk/botservice/azure-mgmt-botservice/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/botservice/models/__init__.py'>¶
-
class
azure.mgmt.botservice.operations.
Operations
(client, config, serializer, deserializer)[source]¶ Bases:
object
Operations 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.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
list
(**kwargs: Any) → Iterable[azure.mgmt.botservice.models._models_py3.OperationEntityListResult][source]¶ Lists all the available BotService operations.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either OperationEntityListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.botservice.models' from '/mnt/vss/_work/1/s/sdk/botservice/azure-mgmt-botservice/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/botservice/models/__init__.py'>¶
-
class
azure.mgmt.botservice.operations.
PrivateEndpointConnectionsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
PrivateEndpointConnectionsOperations 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.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
create
(resource_group_name: str, resource_name: str, private_endpoint_connection_name: str, properties: azure.mgmt.botservice.models._models_py3.PrivateEndpointConnection, **kwargs: Any) → azure.mgmt.botservice.models._models_py3.PrivateEndpointConnection[source]¶ Update the state of specified private endpoint connection associated with the Bot.
- 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.
private_endpoint_connection_name (str) – The name of the private endpoint connection associated with the Azure resource.
properties (PrivateEndpointConnection) – The private endpoint connection properties.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
PrivateEndpointConnection, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
delete
(resource_group_name: str, resource_name: str, private_endpoint_connection_name: str, **kwargs: Any) → None[source]¶ Deletes the specified private endpoint connection associated with the Bot.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, resource_name: str, private_endpoint_connection_name: str, **kwargs: Any) → azure.mgmt.botservice.models._models_py3.PrivateEndpointConnection[source]¶ Gets the specified private endpoint connection associated with the Bot.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
PrivateEndpointConnection, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(resource_group_name: str, resource_name: str, **kwargs: Any) → Iterable[azure.mgmt.botservice.models._models_py3.PrivateEndpointConnectionListResult][source]¶ List all the private endpoint connections associated with the Bot.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either PrivateEndpointConnectionListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.botservice.models' from '/mnt/vss/_work/1/s/sdk/botservice/azure-mgmt-botservice/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/botservice/models/__init__.py'>¶
-
class
azure.mgmt.botservice.operations.
PrivateLinkResourcesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
PrivateLinkResourcesOperations 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.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
list_by_bot_resource
(resource_group_name: str, resource_name: str, **kwargs: Any) → azure.mgmt.botservice.models._models_py3.PrivateLinkResourceListResult[source]¶ Gets the private link resources that need to be created for a Bot.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
PrivateLinkResourceListResult, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.botservice.models' from '/mnt/vss/_work/1/s/sdk/botservice/azure-mgmt-botservice/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/botservice/models/__init__.py'>¶