azure.mgmt.botservice.operations module¶

class azure.mgmt.botservice.operations.BotConnectionOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AzureBotService’s bot_connection attribute.

create(resource_group_name: str, resource_name: str, connection_name: str, parameters: _models.ConnectionSetting, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ConnectionSetting[source]¶

create(resource_group_name: str, resource_name: str, connection_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ConnectionSetting

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. Required.
resource_name (str) – The name of the Bot resource. Required.
connection_name (str) – The name of the Bot Service Connection Setting resource. Required.
parameters (ConnectionSetting or IO) – The parameters to provide for creating the Connection Setting. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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

Raises

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

resource_group_name (str) – The name of the Bot resource group in the user subscription. Required.
resource_name (str) – The name of the Bot resource. Required.
connection_name (str) – The name of the Bot Service Connection Setting resource. Required.

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

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

resource_group_name (str) – The name of the Bot resource group in the user subscription. Required.
resource_name (str) – The name of the Bot resource. Required.
connection_name (str) – The name of the Bot Service Connection Setting resource. Required.

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

ConnectionSetting

Raises

HttpResponseError –

list_by_bot_service(resource_group_name: str, resource_name: str, **kwargs: Any) → Iterable[azure.mgmt.botservice.models._models_py3.ConnectionSetting][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. Required.
resource_name (str) – The name of the Bot resource. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[ConnectionSetting]

Raises

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: ServiceProviderResponseList
Raises: 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

resource_group_name (str) – The name of the Bot resource group in the user subscription. Required.
resource_name (str) – The name of the Bot resource. Required.
connection_name (str) – The name of the Bot Service Connection Setting resource. Required.

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

ConnectionSetting

Raises

HttpResponseError –

update(resource_group_name: str, resource_name: str, connection_name: str, parameters: _models.ConnectionSetting, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ConnectionSetting[source]¶

update(resource_group_name: str, resource_name: str, connection_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ConnectionSetting

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. Required.
resource_name (str) – The name of the Bot resource. Required.
connection_name (str) – The name of the Bot Service Connection Setting resource. Required.
parameters (ConnectionSetting or IO) – The parameters to provide for updating the Connection Setting. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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

Raises

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(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AzureBotService’s bots attribute.

create(resource_group_name: str, resource_name: str, parameters: _models.Bot, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Bot[source]¶

create(resource_group_name: str, resource_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Bot

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. Required.
resource_name (str) – The name of the Bot resource. Required.
parameters (Bot or IO) – The parameters to provide for the created bot. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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

HttpResponseError –

delete(resource_group_name: str, resource_name: str, **kwargs: Any) → None [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. Required.
resource_name (str) – The name of the Bot resource. Required.

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

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

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

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

HttpResponseError –

get_check_name_availability(parameters: _models.CheckNameAvailabilityRequestBody, *, content_type: str = "'application/json'", **kwargs: Any) → _models.CheckNameAvailabilityResponseBody[source]¶

get_check_name_availability(parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.CheckNameAvailabilityResponseBody

Check whether a bot name is available.

Parameters

parameters (CheckNameAvailabilityRequestBody or IO) – The request body parameters to provide for the check name availability request. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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

Raises

HttpResponseError –

list(**kwargs: Any) → Iterable[azure.mgmt.botservice.models._models_py3.Bot][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 Bot or the result of cls(response)
Return type: ItemPaged[Bot]
Raises: HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.botservice.models._models_py3.Bot][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. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either Bot or the result of cls(response)
Return type: ItemPaged[Bot]
Raises: 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. Required.
resource_name (str) – The name of the Bot resource. Required.
location (str) – Specifies the location of the resource. Default value is None.
tags (dict[str, str]) – Contains resource tags defined as key/value pairs. Default value is None.
sku (Sku) – Gets or sets the SKU of the resource. Default value is None.
kind (str or Kind) – Required. Gets or sets the Kind of the resource. Known values are: “sdk”, “designer”, “bot”, “function”, and “azurebot”. Default value is None.
etag (str) – Entity Tag. Default value is None.
properties (BotProperties) – The set of properties specific to bot resource. Default value is None.

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

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(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AzureBotService’s channels attribute.

create(resource_group_name: str, resource_name: str, channel_name: Union[str, _models.ChannelName], parameters: _models.BotChannel, *, content_type: str = "'application/json'", **kwargs: Any) → _models.BotChannel[source]¶

create(resource_group_name: str, resource_name: str, channel_name: Union[str, _models.ChannelName], parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.BotChannel

Creates a Channel registration for a Bot Service.

Parameters

resource_group_name (str) – The name of the Bot resource group in the user subscription. Required.
resource_name (str) – The name of the Bot resource. Required.
channel_name (str or ChannelName) – The name of the Channel resource. Known values are: “AlexaChannel”, “FacebookChannel”, “EmailChannel”, “KikChannel”, “TelegramChannel”, “SlackChannel”, “MsTeamsChannel”, “SkypeChannel”, “WebChatChannel”, “DirectLineChannel”, “SmsChannel”, “LineChannel”, “DirectLineSpeechChannel”, “OutlookChannel”, “Omnichannel”, “TelephonyChannel”, “AcsChatChannel”, “SearchAssistant”, and “M365Extensions”. Required.
parameters (BotChannel or IO) – The parameters to provide for the created bot. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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

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

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

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

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

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

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

HttpResponseError –

list_by_resource_group(resource_group_name: str, resource_name: str, **kwargs: Any) → Iterable[azure.mgmt.botservice.models._models_py3.BotChannel][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. Required.
resource_name (str) – The name of the Bot resource. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[BotChannel]

Raises

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. Required.
resource_name (str) – The name of the Bot resource. Required.
channel_name (str or ChannelName) – The name of the Channel resource. Known values are: “AlexaChannel”, “FacebookChannel”, “EmailChannel”, “KikChannel”, “TelegramChannel”, “SlackChannel”, “MsTeamsChannel”, “SkypeChannel”, “WebChatChannel”, “DirectLineChannel”, “SmsChannel”, “LineChannel”, “DirectLineSpeechChannel”, “OutlookChannel”, “Omnichannel”, “TelephonyChannel”, “AcsChatChannel”, “SearchAssistant”, and “M365Extensions”. Required.

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

ListChannelWithKeysResponse

Raises

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. Required.
resource_name (str) – The name of the Bot resource. Required.
channel_name (str or ChannelName) – The name of the Channel resource. Known values are: “AlexaChannel”, “FacebookChannel”, “EmailChannel”, “KikChannel”, “TelegramChannel”, “SlackChannel”, “MsTeamsChannel”, “SkypeChannel”, “WebChatChannel”, “DirectLineChannel”, “SmsChannel”, “LineChannel”, “DirectLineSpeechChannel”, “OutlookChannel”, “Omnichannel”, “TelephonyChannel”, “AcsChatChannel”, “SearchAssistant”, and “M365Extensions”. Required.
location (str) – Specifies the location of the resource. Default value is None.
tags (dict[str, str]) – Contains resource tags defined as key/value pairs. Default value is None.
sku (Sku) – Gets or sets the SKU of the resource. Default value is None.
kind (str or Kind) – Required. Gets or sets the Kind of the resource. Known values are: “sdk”, “designer”, “bot”, “function”, and “azurebot”. Default value is None.
etag (str) – Entity Tag. Default value is None.
properties (Channel) – The set of properties specific to bot channel resource. Default value is None.

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

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(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AzureBotService’s direct_line attribute.

regenerate_keys(resource_group_name: str, resource_name: str, channel_name: Union[str, _models.RegenerateKeysChannelName], parameters: _models.SiteInfo, *, content_type: str = "'application/json'", **kwargs: Any) → _models.BotChannel[source]¶

regenerate_keys(resource_group_name: str, resource_name: str, channel_name: Union[str, _models.RegenerateKeysChannelName], parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.BotChannel

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. Required.
resource_name (str) – The name of the Bot resource. Required.
channel_name (str or RegenerateKeysChannelName) – The name of the Channel resource for which keys are to be regenerated. Known values are: “WebChatChannel” and “DirectLineChannel”. Required.
parameters (SiteInfo or IO) – The parameters to provide for the created bot. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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

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.EmailOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AzureBotService’s email attribute.

create_sign_in_url(resource_group_name: str, resource_name: str, **kwargs: Any) → azure.mgmt.botservice.models._models_py3.CreateEmailSignInUrlResponse[source]¶

Creates an email channel sign in url for a Bot Service.

Parameters

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

CreateEmailSignInUrlResponse or the result of cls(response)

Return type

CreateEmailSignInUrlResponse

Raises

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(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AzureBotService’s host_settings attribute.

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: HostSettingsResponse
Raises: 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(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AzureBotService’s operation_results attribute.

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. Required.

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

LROPoller[OperationResultsDescription]

Raises

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(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AzureBotService’s operations attribute.

list(**kwargs: Any) → Iterable[azure.mgmt.botservice.models._models_py3.OperationEntity][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 OperationEntity or the result of cls(response)
Return type: ItemPaged[OperationEntity]
Raises: 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(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AzureBotService’s private_endpoint_connections attribute.

create(resource_group_name: str, resource_name: str, private_endpoint_connection_name: str, properties: _models.PrivateEndpointConnection, *, content_type: str = "'application/json'", **kwargs: Any) → _models.PrivateEndpointConnection[source]¶

create(resource_group_name: str, resource_name: str, private_endpoint_connection_name: str, properties: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.PrivateEndpointConnection

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. Required.
resource_name (str) – The name of the Bot resource. Required.
private_endpoint_connection_name (str) – The name of the private endpoint connection associated with the Azure resource. Required.
properties (PrivateEndpointConnection or IO) – The private endpoint connection properties. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

PrivateEndpointConnection or the result of cls(response)

Return type

PrivateEndpointConnection

Raises

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

resource_group_name (str) – The name of the Bot resource group in the user subscription. Required.
resource_name (str) – The name of the Bot resource. Required.
private_endpoint_connection_name (str) – The name of the private endpoint connection associated with the Azure resource. Required.

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

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

resource_group_name (str) – The name of the Bot resource group in the user subscription. Required.
resource_name (str) – The name of the Bot resource. Required.
private_endpoint_connection_name (str) – The name of the private endpoint connection associated with the Azure resource. Required.

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

PrivateEndpointConnection

Raises

HttpResponseError –

list(resource_group_name: str, resource_name: str, **kwargs: Any) → Iterable[azure.mgmt.botservice.models._models_py3.PrivateEndpointConnection][source]¶

List all the private endpoint connections associated with the Bot.

Parameters

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[PrivateEndpointConnection]

Raises

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(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AzureBotService’s private_link_resources attribute.

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

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

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

PrivateLinkResourceListResult

Raises

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.QnAMakerEndpointKeysOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AzureBotService’s qn_amaker_endpoint_keys attribute.

get(parameters: _models.QnAMakerEndpointKeysRequestBody, *, content_type: str = "'application/json'", **kwargs: Any) → _models.QnAMakerEndpointKeysResponse[source]¶

get(parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.QnAMakerEndpointKeysResponse

Lists the QnA Maker endpoint keys.

Parameters

parameters (QnAMakerEndpointKeysRequestBody or IO) – The request body parameters to provide for the check name availability request. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

QnAMakerEndpointKeysResponse or the result of cls(response)

Return type

QnAMakerEndpointKeysResponse

Raises

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