azure.mgmt.botservice.models module¶
-
class
azure.mgmt.botservice.models.
AlexaChannel
(*, etag: Optional[str] = None, location: Optional[str] = 'global', properties: Optional[azure.mgmt.botservice.models._models_py3.AlexaChannelProperties] = None, **kwargs)[source]¶ Bases:
azure.mgmt.botservice.models._models_py3.Channel
Alexa channel definition.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
channel_name (str) – Required. The channel name.Constant filled by server.
etag (str) – Entity Tag of the resource.
provisioning_state (str) – Provisioning state of the resource.
location (str) – Specifies the location of the resource.
properties (AlexaChannelProperties) – The set of properties specific to Alexa channel resource.
- Keyword Arguments
etag (str) – Entity Tag of the resource.
location (str) – Specifies the location of the resource.
properties (AlexaChannelProperties) – The set of properties specific to Alexa channel resource.
-
class
azure.mgmt.botservice.models.
AlexaChannelProperties
(*, alexa_skill_id: str, is_enabled: bool, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The parameters to provide for the Alexa channel.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
- Keyword Arguments
-
class
azure.mgmt.botservice.models.
Bot
(*, 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)[source]¶ Bases:
azure.mgmt.botservice.models._models_py3.Resource
Bot resource definition.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
name (str) – Specifies the name of the resource.
location (str) – Specifies the location of the resource.
tags (dict[str, str]) – A set of tags. 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”, “azurebot”.
etag (str) – Entity Tag.
properties (BotProperties) – The set of properties specific to bot resource.
- Keyword Arguments
location (str) – Specifies the location of the resource.
tags (dict[str, str]) – A set of tags. 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”, “azurebot”.
etag (str) – Entity Tag.
properties (BotProperties) – The set of properties specific to bot resource.
-
class
azure.mgmt.botservice.models.
BotChannel
(*, 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)[source]¶ Bases:
azure.mgmt.botservice.models._models_py3.Resource
Bot channel resource definition.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
name (str) – Specifies the name of the resource.
location (str) – Specifies the location of the resource.
tags (dict[str, str]) – A set of tags. 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”, “azurebot”.
etag (str) – Entity Tag.
properties (Channel) – The set of properties specific to bot channel resource.
- Keyword Arguments
location (str) – Specifies the location of the resource.
tags (dict[str, str]) – A set of tags. 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”, “azurebot”.
etag (str) – Entity Tag.
properties (Channel) – The set of properties specific to bot channel resource.
-
class
azure.mgmt.botservice.models.
BotProperties
(*, display_name: str, endpoint: str, msa_app_id: str, description: Optional[str] = None, icon_url: Optional[str] = None, all_settings: Optional[Dict[str, str]] = None, parameters: Optional[Dict[str, str]] = None, manifest_url: Optional[str] = None, msa_app_type: Optional[Union[str, azure.mgmt.botservice.models._azure_bot_service_enums.MsaAppType]] = None, msa_app_tenant_id: Optional[str] = None, msa_app_msi_resource_id: Optional[str] = None, developer_app_insight_key: Optional[str] = None, developer_app_insights_api_key: Optional[str] = None, developer_app_insights_application_id: Optional[str] = None, luis_app_ids: Optional[List[str]] = None, luis_key: Optional[str] = None, is_cmek_enabled: Optional[bool] = None, cmek_key_vault_url: Optional[str] = None, public_network_access: Optional[Union[str, azure.mgmt.botservice.models._azure_bot_service_enums.PublicNetworkAccess]] = 'Enabled', is_streaming_supported: Optional[bool] = False, disable_local_auth: Optional[bool] = None, schema_transformation_version: Optional[str] = None, storage_resource_id: Optional[str] = None, open_with_hint: Optional[str] = None, app_password_hint: Optional[str] = None, publishing_credentials: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The parameters to provide for the Bot.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
display_name (str) – Required. The Name of the bot.
description (str) – The description of the bot.
icon_url (str) – The Icon Url of the bot.
endpoint (str) – Required. The bot’s endpoint.
endpoint_version (str) – The bot’s endpoint version.
all_settings (dict[str, str]) – Contains resource all settings defined as key/value pairs.
parameters (dict[str, str]) – Contains resource parameters defined as key/value pairs.
manifest_url (str) – The bot’s manifest url.
msa_app_type (str or MsaAppType) – Microsoft App Type for the bot. Possible values include: “UserAssignedMSI”, “SingleTenant”, “MultiTenant”.
msa_app_id (str) – Required. Microsoft App Id for the bot.
msa_app_tenant_id (str) – Microsoft App Tenant Id for the bot.
msa_app_msi_resource_id (str) – Microsoft App Managed Identity Resource Id for the bot.
configured_channels (list[str]) – Collection of channels for which the bot is configured.
enabled_channels (list[str]) – Collection of channels for which the bot is enabled.
developer_app_insight_key (str) – The Application Insights key.
developer_app_insights_api_key (str) – The Application Insights Api Key.
developer_app_insights_application_id (str) – The Application Insights App Id.
luis_key (str) – The LUIS Key.
is_cmek_enabled (bool) – Whether Cmek is enabled.
cmek_key_vault_url (str) – The CMK Url.
cmek_encryption_status (str) – The CMK encryption status.
public_network_access (str or PublicNetworkAccess) – Whether the bot is in an isolated network. Possible values include: “Enabled”, “Disabled”. Default value: “Enabled”.
is_streaming_supported (bool) – Whether the bot is streaming supported.
is_developer_app_insights_api_key_set (bool) – Whether the bot is developerAppInsightsApiKey set.
migration_token (str) – Token used to migrate non Azure bot to azure subscription.
disable_local_auth (bool) – Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
schema_transformation_version (str) – The channel schema transformation version for the bot.
storage_resource_id (str) – The storage resourceId for the bot.
private_endpoint_connections (list[PrivateEndpointConnection]) – List of Private Endpoint Connections configured for the bot.
open_with_hint (str) – The hint to browser (e.g. protocol handler) on how to open the bot for authoring.
app_password_hint (str) – The hint (e.g. keyVault secret resourceId) on how to fetch the app secret.
provisioning_state (str) – Provisioning state of the resource.
publishing_credentials (str) – Publishing credentials of the resource.
- Keyword Arguments
display_name (str) – Required. The Name of the bot.
description (str) – The description of the bot.
icon_url (str) – The Icon Url of the bot.
endpoint (str) – Required. The bot’s endpoint.
all_settings (dict[str, str]) – Contains resource all settings defined as key/value pairs.
parameters (dict[str, str]) – Contains resource parameters defined as key/value pairs.
manifest_url (str) – The bot’s manifest url.
msa_app_type (str or MsaAppType) – Microsoft App Type for the bot. Possible values include: “UserAssignedMSI”, “SingleTenant”, “MultiTenant”.
msa_app_id (str) – Required. Microsoft App Id for the bot.
msa_app_tenant_id (str) – Microsoft App Tenant Id for the bot.
msa_app_msi_resource_id (str) – Microsoft App Managed Identity Resource Id for the bot.
developer_app_insight_key (str) – The Application Insights key.
developer_app_insights_api_key (str) – The Application Insights Api Key.
developer_app_insights_application_id (str) – The Application Insights App Id.
luis_key (str) – The LUIS Key.
is_cmek_enabled (bool) – Whether Cmek is enabled.
cmek_key_vault_url (str) – The CMK Url.
public_network_access (str or PublicNetworkAccess) – Whether the bot is in an isolated network. Possible values include: “Enabled”, “Disabled”. Default value: “Enabled”.
is_streaming_supported (bool) – Whether the bot is streaming supported.
disable_local_auth (bool) – Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
schema_transformation_version (str) – The channel schema transformation version for the bot.
storage_resource_id (str) – The storage resourceId for the bot.
open_with_hint (str) – The hint to browser (e.g. protocol handler) on how to open the bot for authoring.
app_password_hint (str) – The hint (e.g. keyVault secret resourceId) on how to fetch the app secret.
publishing_credentials (str) – Publishing credentials of the resource.
-
class
azure.mgmt.botservice.models.
BotResponseList
(*, next_link: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The list of bot service operation response.
Variables are only populated by the server, and will be ignored when sending a request.
-
class
azure.mgmt.botservice.models.
Channel
(*, etag: Optional[str] = None, location: Optional[str] = 'global', **kwargs)[source]¶ Bases:
msrest.serialization.Model
Channel definition.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: AlexaChannel, DirectLineChannel, DirectLineSpeechChannel, EmailChannel, FacebookChannel, KikChannel, LineChannel, MsTeamsChannel, SkypeChannel, SlackChannel, SmsChannel, TelegramChannel, WebChatChannel.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
- Keyword Arguments
-
class
azure.mgmt.botservice.models.
ChannelName
(value)[source]¶ -
An enumeration.
-
ALEXA_CHANNEL
= 'AlexaChannel'¶
-
DIRECT_LINE_CHANNEL
= 'DirectLineChannel'¶
-
DIRECT_LINE_SPEECH_CHANNEL
= 'DirectLineSpeechChannel'¶
-
EMAIL_CHANNEL
= 'EmailChannel'¶
-
FACEBOOK_CHANNEL
= 'FacebookChannel'¶
-
KIK_CHANNEL
= 'KikChannel'¶
-
LINE_CHANNEL
= 'LineChannel'¶
-
MS_TEAMS_CHANNEL
= 'MsTeamsChannel'¶
-
OUTLOOK_CHANNEL
= 'OutlookChannel'¶
-
SKYPE_CHANNEL
= 'SkypeChannel'¶
-
SLACK_CHANNEL
= 'SlackChannel'¶
-
SMS_CHANNEL
= 'SmsChannel'¶
-
TELEGRAM_CHANNEL
= 'TelegramChannel'¶
-
WEB_CHAT_CHANNEL
= 'WebChatChannel'¶
-
-
class
azure.mgmt.botservice.models.
ChannelResponseList
(*, next_link: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The list of bot service channel operation response.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
next_link (str) – The link used to get the next page of bot service channel resources.
value (list[BotChannel]) – Gets the list of bot service channel results and their properties.
- Keyword Arguments
next_link (str) – The link used to get the next page of bot service channel resources.
-
class
azure.mgmt.botservice.models.
ChannelSettings
(*, extension_key1: Optional[str] = None, extension_key2: Optional[str] = None, sites: Optional[List[azure.mgmt.botservice.models._models_py3.Site]] = None, channel_id: Optional[str] = None, channel_display_name: Optional[str] = None, bot_id: Optional[str] = None, bot_icon_url: Optional[str] = None, is_enabled: Optional[bool] = None, disable_local_auth: Optional[bool] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Channel settings definition.
- Variables
extension_key1 (str) – The extensionKey1.
extension_key2 (str) – The extensionKey2.
channel_id (str) – The channel id.
channel_display_name (str) – The channel display name.
bot_id (str) – The bot id.
bot_icon_url (str) – The bot icon url.
is_enabled (bool) – Whether this channel is enabled for the bot.
disable_local_auth (bool) – Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
- Keyword Arguments
extension_key1 (str) – The extensionKey1.
extension_key2 (str) – The extensionKey2.
channel_id (str) – The channel id.
channel_display_name (str) – The channel display name.
bot_id (str) – The bot id.
bot_icon_url (str) – The bot icon url.
is_enabled (bool) – Whether this channel is enabled for the bot.
disable_local_auth (bool) – Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
-
class
azure.mgmt.botservice.models.
CheckNameAvailabilityRequestBody
(*, name: Optional[str] = None, type: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The request body for a request to Bot Service Management to check availability of a bot name.
- Variables
- Keyword Arguments
-
class
azure.mgmt.botservice.models.
CheckNameAvailabilityResponseBody
(*, valid: Optional[bool] = None, message: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The response body returned for a request to Bot Service Management to check availability of a bot name.
- Variables
- Keyword Arguments
-
class
azure.mgmt.botservice.models.
ConnectionItemName
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
The display name of a connection Item Setting registered with the Bot.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
name (str) – Connection Item name that has been added in the API.
-
class
azure.mgmt.botservice.models.
ConnectionSetting
(*, 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.ConnectionSettingProperties] = None, **kwargs)[source]¶ Bases:
azure.mgmt.botservice.models._models_py3.Resource
Bot channel resource definition.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
name (str) – Specifies the name of the resource.
location (str) – Specifies the location of the resource.
tags (dict[str, str]) – A set of tags. 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”, “azurebot”.
etag (str) – Entity Tag.
properties (ConnectionSettingProperties) – The set of properties specific to bot channel resource.
- Keyword Arguments
location (str) – Specifies the location of the resource.
tags (dict[str, str]) – A set of tags. 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”, “azurebot”.
etag (str) – Entity Tag.
properties (ConnectionSettingProperties) – The set of properties specific to bot channel resource.
-
class
azure.mgmt.botservice.models.
ConnectionSettingParameter
(*, key: Optional[str] = None, value: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Extra Parameter in a Connection Setting Properties to indicate service provider specific properties.
-
class
azure.mgmt.botservice.models.
ConnectionSettingProperties
(*, id: Optional[str] = None, name: Optional[str] = None, client_id: Optional[str] = None, client_secret: Optional[str] = None, scopes: Optional[str] = None, service_provider_id: Optional[str] = None, service_provider_display_name: Optional[str] = None, parameters: Optional[List[azure.mgmt.botservice.models._models_py3.ConnectionSettingParameter]] = None, provisioning_state: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Properties for a Connection Setting Item.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
name (str) – Name associated with the Connection Setting.
client_id (str) – Client Id associated with the Connection Setting.
setting_id (str) – Setting Id set by the service for the Connection Setting.
client_secret (str) – Client Secret associated with the Connection Setting.
scopes (str) – Scopes associated with the Connection Setting.
service_provider_id (str) – Service Provider Id associated with the Connection Setting.
service_provider_display_name (str) – Service Provider Display Name associated with the Connection Setting.
parameters (list[ConnectionSettingParameter]) – Service Provider Parameters associated with the Connection Setting.
provisioning_state (str) – Provisioning state of the resource.
- Keyword Arguments
id (str) – Id associated with the Connection Setting.
name (str) – Name associated with the Connection Setting.
client_id (str) – Client Id associated with the Connection Setting.
client_secret (str) – Client Secret associated with the Connection Setting.
scopes (str) – Scopes associated with the Connection Setting.
service_provider_id (str) – Service Provider Id associated with the Connection Setting.
service_provider_display_name (str) – Service Provider Display Name associated with the Connection Setting.
parameters (list[ConnectionSettingParameter]) – Service Provider Parameters associated with the Connection Setting.
provisioning_state (str) – Provisioning state of the resource.
-
class
azure.mgmt.botservice.models.
ConnectionSettingResponseList
(*, next_link: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The list of bot service connection settings response.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
next_link (str) – The link used to get the next page of bot service connection setting resources.
value (list[ConnectionSetting]) – Gets the list of bot service connection settings and their properties.
- Keyword Arguments
next_link (str) – The link used to get the next page of bot service connection setting resources.
-
class
azure.mgmt.botservice.models.
DirectLineChannel
(*, etag: Optional[str] = None, location: Optional[str] = 'global', properties: Optional[azure.mgmt.botservice.models._models_py3.DirectLineChannelProperties] = None, **kwargs)[source]¶ Bases:
azure.mgmt.botservice.models._models_py3.Channel
Direct Line channel definition.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
channel_name (str) – Required. The channel name.Constant filled by server.
etag (str) – Entity Tag of the resource.
provisioning_state (str) – Provisioning state of the resource.
location (str) – Specifies the location of the resource.
properties (DirectLineChannelProperties) – The set of properties specific to Direct Line channel resource.
- Keyword Arguments
etag (str) – Entity Tag of the resource.
location (str) – Specifies the location of the resource.
properties (DirectLineChannelProperties) – The set of properties specific to Direct Line channel resource.
-
class
azure.mgmt.botservice.models.
DirectLineChannelProperties
(*, sites: Optional[List[azure.mgmt.botservice.models._models_py3.DirectLineSite]] = None, direct_line_embed_code: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The parameters to provide for the Direct Line channel.
- Variables
sites (list[DirectLineSite]) – The list of Direct Line sites.
direct_line_embed_code (str) – Direct Line embed code of the resource.
- Keyword Arguments
sites (list[DirectLineSite]) – The list of Direct Line sites.
direct_line_embed_code (str) – Direct Line embed code of the resource.
-
class
azure.mgmt.botservice.models.
DirectLineSite
(*, site_name: str, is_enabled: bool, is_v1_enabled: bool, is_v3_enabled: bool, is_secure_site_enabled: Optional[bool] = None, is_block_user_upload_enabled: Optional[bool] = None, trusted_origins: Optional[List[str]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
A site for the Direct Line channel.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
site_id (str) – Site Id.
site_name (str) – Required. Site name.
key (str) – Primary key. Value only returned through POST to the action Channel List API, otherwise empty.
key2 (str) – Secondary key. Value only returned through POST to the action Channel List API, otherwise empty.
is_enabled (bool) – Required. Whether this site is enabled for DirectLine channel.
is_v1_enabled (bool) – Required. Whether this site is enabled for Bot Framework V1 protocol.
is_v3_enabled (bool) – Required. Whether this site is enabled for Bot Framework V1 protocol.
is_secure_site_enabled (bool) – Whether this site is enabled for authentication with Bot Framework.
is_block_user_upload_enabled (bool) – Whether this site is enabled for block user upload.
trusted_origins (list[str]) – List of Trusted Origin URLs for this site. This field is applicable only if isSecureSiteEnabled is True.
- Keyword Arguments
site_name (str) – Required. Site name.
is_enabled (bool) – Required. Whether this site is enabled for DirectLine channel.
is_v1_enabled (bool) – Required. Whether this site is enabled for Bot Framework V1 protocol.
is_v3_enabled (bool) – Required. Whether this site is enabled for Bot Framework V1 protocol.
is_secure_site_enabled (bool) – Whether this site is enabled for authentication with Bot Framework.
is_block_user_upload_enabled (bool) – Whether this site is enabled for block user upload.
trusted_origins (list[str]) – List of Trusted Origin URLs for this site. This field is applicable only if isSecureSiteEnabled is True.
-
class
azure.mgmt.botservice.models.
DirectLineSpeechChannel
(*, etag: Optional[str] = None, location: Optional[str] = 'global', properties: Optional[azure.mgmt.botservice.models._models_py3.DirectLineSpeechChannelProperties] = None, **kwargs)[source]¶ Bases:
azure.mgmt.botservice.models._models_py3.Channel
DirectLine Speech channel definition.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
channel_name (str) – Required. The channel name.Constant filled by server.
etag (str) – Entity Tag of the resource.
provisioning_state (str) – Provisioning state of the resource.
location (str) – Specifies the location of the resource.
properties (DirectLineSpeechChannelProperties) – The set of properties specific to DirectLine Speech channel resource.
- Keyword Arguments
etag (str) – Entity Tag of the resource.
location (str) – Specifies the location of the resource.
properties (DirectLineSpeechChannelProperties) – The set of properties specific to DirectLine Speech channel resource.
-
class
azure.mgmt.botservice.models.
DirectLineSpeechChannelProperties
(*, cognitive_service_region: str, cognitive_service_subscription_key: str, is_enabled: Optional[bool] = None, custom_voice_deployment_id: Optional[str] = None, custom_speech_model_id: Optional[str] = None, is_default_bot_for_cog_svc_account: Optional[bool] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The parameters to provide for the DirectLine Speech channel.
All required parameters must be populated in order to send to Azure.
- Variables
cognitive_service_region (str) – Required. The cognitive service region with this channel registration.
cognitive_service_subscription_key (str) – Required. The cognitive service subscription key to use with this channel registration.
is_enabled (bool) – Whether this channel is enabled or not.
custom_voice_deployment_id (str) – Custom speech model id (optional).
custom_speech_model_id (str) – Custom voice deployment id (optional).
is_default_bot_for_cog_svc_account (bool) – Make this a default bot for chosen cognitive service account.
- Keyword Arguments
cognitive_service_region (str) – Required. The cognitive service region with this channel registration.
cognitive_service_subscription_key (str) – Required. The cognitive service subscription key to use with this channel registration.
is_enabled (bool) – Whether this channel is enabled or not.
custom_voice_deployment_id (str) – Custom speech model id (optional).
custom_speech_model_id (str) – Custom voice deployment id (optional).
is_default_bot_for_cog_svc_account (bool) – Make this a default bot for chosen cognitive service account.
-
class
azure.mgmt.botservice.models.
EmailChannel
(*, etag: Optional[str] = None, location: Optional[str] = 'global', properties: Optional[azure.mgmt.botservice.models._models_py3.EmailChannelProperties] = None, **kwargs)[source]¶ Bases:
azure.mgmt.botservice.models._models_py3.Channel
Email channel definition.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
channel_name (str) – Required. The channel name.Constant filled by server.
etag (str) – Entity Tag of the resource.
provisioning_state (str) – Provisioning state of the resource.
location (str) – Specifies the location of the resource.
properties (EmailChannelProperties) – The set of properties specific to email channel resource.
- Keyword Arguments
etag (str) – Entity Tag of the resource.
location (str) – Specifies the location of the resource.
properties (EmailChannelProperties) – The set of properties specific to email channel resource.
-
class
azure.mgmt.botservice.models.
EmailChannelProperties
(*, email_address: str, is_enabled: bool, password: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The parameters to provide for the Email channel.
All required parameters must be populated in order to send to Azure.
- Variables
- Keyword Arguments
-
class
azure.mgmt.botservice.models.
Error
(*, error: Optional[azure.mgmt.botservice.models._models_py3.ErrorBody] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Bot Service error object.
-
class
azure.mgmt.botservice.models.
ErrorBody
(*, code: str, message: str, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Bot Service error body.
All required parameters must be populated in order to send to Azure.
-
class
azure.mgmt.botservice.models.
FacebookChannel
(*, etag: Optional[str] = None, location: Optional[str] = 'global', properties: Optional[azure.mgmt.botservice.models._models_py3.FacebookChannelProperties] = None, **kwargs)[source]¶ Bases:
azure.mgmt.botservice.models._models_py3.Channel
Facebook channel definition.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
channel_name (str) – Required. The channel name.Constant filled by server.
etag (str) – Entity Tag of the resource.
provisioning_state (str) – Provisioning state of the resource.
location (str) – Specifies the location of the resource.
properties (FacebookChannelProperties) – The set of properties specific to bot facebook channel.
- Keyword Arguments
etag (str) – Entity Tag of the resource.
location (str) – Specifies the location of the resource.
properties (FacebookChannelProperties) – The set of properties specific to bot facebook channel.
-
class
azure.mgmt.botservice.models.
FacebookChannelProperties
(*, app_id: str, is_enabled: bool, pages: Optional[List[azure.mgmt.botservice.models._models_py3.FacebookPage]] = None, app_secret: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The parameters to provide for the Facebook channel.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
verify_token (str) – Verify token. Value only returned through POST to the action Channel List API, otherwise empty.
pages (list[FacebookPage]) – The list of Facebook pages.
app_id (str) – Required. Facebook application id.
app_secret (str) – Facebook application secret. Value only returned through POST to the action Channel List API, otherwise empty.
callback_url (str) – Callback Url.
is_enabled (bool) – Required. Whether this channel is enabled for the bot.
- Keyword Arguments
pages (list[FacebookPage]) – The list of Facebook pages.
app_id (str) – Required. Facebook application id.
app_secret (str) – Facebook application secret. Value only returned through POST to the action Channel List API, otherwise empty.
is_enabled (bool) – Required. Whether this channel is enabled for the bot.
-
class
azure.mgmt.botservice.models.
FacebookPage
(*, id: str, access_token: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
A Facebook page for Facebook channel registration.
All required parameters must be populated in order to send to Azure.
- Variables
- Keyword Arguments
-
class
azure.mgmt.botservice.models.
HostSettingsResponse
(*, o_auth_url: Optional[str] = None, to_bot_from_channel_open_id_metadata_url: Optional[str] = None, to_bot_from_channel_token_issuer: Optional[str] = None, to_bot_from_emulator_open_id_metadata_url: Optional[str] = None, to_channel_from_bot_login_url: Optional[str] = None, to_channel_from_bot_o_auth_scope: Optional[str] = None, validate_authority: Optional[bool] = None, bot_open_id_metadata: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The response body returned for a request to Bot Service Management to check per subscription hostSettings.
- Variables
o_auth_url (str) – For in-conversation bot user authentication.
to_bot_from_channel_open_id_metadata_url (str) – For verifying incoming tokens from the channels.
to_bot_from_channel_token_issuer (str) – For verifying incoming tokens from the channels.
to_bot_from_emulator_open_id_metadata_url (str) – For verifying incoming tokens from bot emulator.
to_channel_from_bot_login_url (str) – For getting access token to channels from bot host.
to_channel_from_bot_o_auth_scope (str) – For getting access token to channels from bot host.
validate_authority (bool) – Per cloud OAuth setting on whether authority is validated.
bot_open_id_metadata (str) – Same as toBotFromChannelOpenIdMetadataUrl, used by SDK < v4.12.
- Keyword Arguments
o_auth_url (str) – For in-conversation bot user authentication.
to_bot_from_channel_open_id_metadata_url (str) – For verifying incoming tokens from the channels.
to_bot_from_channel_token_issuer (str) – For verifying incoming tokens from the channels.
to_bot_from_emulator_open_id_metadata_url (str) – For verifying incoming tokens from bot emulator.
to_channel_from_bot_login_url (str) – For getting access token to channels from bot host.
to_channel_from_bot_o_auth_scope (str) – For getting access token to channels from bot host.
validate_authority (bool) – Per cloud OAuth setting on whether authority is validated.
bot_open_id_metadata (str) – Same as toBotFromChannelOpenIdMetadataUrl, used by SDK < v4.12.
-
class
azure.mgmt.botservice.models.
Key
(value)[source]¶ -
Determines which key is to be regenerated
-
KEY1
= 'key1'¶
-
KEY2
= 'key2'¶
-
-
class
azure.mgmt.botservice.models.
KikChannel
(*, etag: Optional[str] = None, location: Optional[str] = 'global', properties: Optional[azure.mgmt.botservice.models._models_py3.KikChannelProperties] = None, **kwargs)[source]¶ Bases:
azure.mgmt.botservice.models._models_py3.Channel
Kik channel definition.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
channel_name (str) – Required. The channel name.Constant filled by server.
etag (str) – Entity Tag of the resource.
provisioning_state (str) – Provisioning state of the resource.
location (str) – Specifies the location of the resource.
properties (KikChannelProperties) – The set of properties specific to Kik channel resource.
- Keyword Arguments
etag (str) – Entity Tag of the resource.
location (str) – Specifies the location of the resource.
properties (KikChannelProperties) – The set of properties specific to Kik channel resource.
-
class
azure.mgmt.botservice.models.
KikChannelProperties
(*, user_name: str, is_enabled: bool, api_key: Optional[str] = None, is_validated: Optional[bool] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The parameters to provide for the Kik channel.
All required parameters must be populated in order to send to Azure.
- Variables
user_name (str) – Required. The Kik user name.
api_key (str) – Kik API key. Value only returned through POST to the action Channel List API, otherwise empty.
is_validated (bool) – Whether this channel is validated for the bot.
is_enabled (bool) – Required. Whether this channel is enabled for the bot.
- Keyword Arguments
user_name (str) – Required. The Kik user name.
api_key (str) – Kik API key. Value only returned through POST to the action Channel List API, otherwise empty.
is_validated (bool) – Whether this channel is validated for the bot.
is_enabled (bool) – Required. Whether this channel is enabled for the bot.
-
class
azure.mgmt.botservice.models.
Kind
(value)[source]¶ -
Indicates the type of bot service
-
AZUREBOT
= 'azurebot'¶
-
BOT
= 'bot'¶
-
DESIGNER
= 'designer'¶
-
FUNCTION
= 'function'¶
-
SDK
= 'sdk'¶
-
-
class
azure.mgmt.botservice.models.
LineChannel
(*, etag: Optional[str] = None, location: Optional[str] = 'global', properties: Optional[azure.mgmt.botservice.models._models_py3.LineChannelProperties] = None, **kwargs)[source]¶ Bases:
azure.mgmt.botservice.models._models_py3.Channel
Line channel definition.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
channel_name (str) – Required. The channel name.Constant filled by server.
etag (str) – Entity Tag of the resource.
provisioning_state (str) – Provisioning state of the resource.
location (str) – Specifies the location of the resource.
properties (LineChannelProperties) – The set of properties specific to line channel resource.
- Keyword Arguments
etag (str) – Entity Tag of the resource.
location (str) – Specifies the location of the resource.
properties (LineChannelProperties) – The set of properties specific to line channel resource.
-
class
azure.mgmt.botservice.models.
LineChannelProperties
(*, line_registrations: List[azure.mgmt.botservice.models._models_py3.LineRegistration], **kwargs)[source]¶ Bases:
msrest.serialization.Model
The parameters to provide for the Line channel.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
line_registrations (list[LineRegistration]) – Required. The list of line channel registrations.
callback_url (str) – Callback Url to enter in line registration.
is_validated (bool) – Whether this channel is validated for the bot.
- Keyword Arguments
line_registrations (list[LineRegistration]) – Required. The list of line channel registrations.
-
class
azure.mgmt.botservice.models.
LineRegistration
(*, channel_secret: Optional[str] = None, channel_access_token: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The properties corresponding to a line channel registration.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
- Keyword Arguments
-
class
azure.mgmt.botservice.models.
ListChannelWithKeysResponse
(*, 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, resource: Optional[azure.mgmt.botservice.models._models_py3.Channel] = None, setting: Optional[azure.mgmt.botservice.models._models_py3.ChannelSettings] = None, provisioning_state: Optional[str] = None, entity_tag: Optional[str] = None, changed_time: Optional[str] = None, **kwargs)[source]¶ Bases:
azure.mgmt.botservice.models._models_py3.BotChannel
The ARM channel of list channel with keys operation response.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
name (str) – Specifies the name of the resource.
location (str) – Specifies the location of the resource.
tags (dict[str, str]) – A set of tags. 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”, “azurebot”.
etag (str) – Entity Tag.
properties (Channel) – The set of properties specific to bot channel resource.
resource (Channel) – The set of properties specific to bot channel resource.
setting (ChannelSettings) – Channel settings.
provisioning_state (str) – Provisioning state of the resource.
entity_tag (str) – Entity tag of the resource.
changed_time (str) – Changed time of the resource.
- Keyword Arguments
location (str) – Specifies the location of the resource.
tags (dict[str, str]) – A set of tags. 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”, “azurebot”.
etag (str) – Entity Tag.
properties (Channel) – The set of properties specific to bot channel resource.
resource (Channel) – The set of properties specific to bot channel resource.
setting (ChannelSettings) – Channel settings.
provisioning_state (str) – Provisioning state of the resource.
entity_tag (str) – Entity tag of the resource.
changed_time (str) – Changed time of the resource.
-
class
azure.mgmt.botservice.models.
MsTeamsChannel
(*, etag: Optional[str] = None, location: Optional[str] = 'global', properties: Optional[azure.mgmt.botservice.models._models_py3.MsTeamsChannelProperties] = None, **kwargs)[source]¶ Bases:
azure.mgmt.botservice.models._models_py3.Channel
Microsoft Teams channel definition.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
channel_name (str) – Required. The channel name.Constant filled by server.
etag (str) – Entity Tag of the resource.
provisioning_state (str) – Provisioning state of the resource.
location (str) – Specifies the location of the resource.
properties (MsTeamsChannelProperties) – The set of properties specific to Microsoft Teams channel resource.
- Keyword Arguments
etag (str) – Entity Tag of the resource.
location (str) – Specifies the location of the resource.
properties (MsTeamsChannelProperties) – The set of properties specific to Microsoft Teams channel resource.
-
class
azure.mgmt.botservice.models.
MsTeamsChannelProperties
(*, is_enabled: bool, enable_calling: Optional[bool] = None, calling_web_hook: Optional[str] = None, incoming_call_route: Optional[str] = None, deployment_environment: Optional[str] = None, accepted_terms: Optional[bool] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The parameters to provide for the Microsoft Teams channel.
All required parameters must be populated in order to send to Azure.
- Variables
enable_calling (bool) – Enable calling for Microsoft Teams channel.
calling_web_hook (str) – Webhook for Microsoft Teams channel calls.
is_enabled (bool) – Required. Whether this channel is enabled for the bot.
incoming_call_route (str) – Webhook for Microsoft Teams channel calls.
deployment_environment (str) – Deployment environment for Microsoft Teams channel calls.
accepted_terms (bool) – Whether this channel accepted terms.
- Keyword Arguments
enable_calling (bool) – Enable calling for Microsoft Teams channel.
calling_web_hook (str) – Webhook for Microsoft Teams channel calls.
is_enabled (bool) – Required. Whether this channel is enabled for the bot.
incoming_call_route (str) – Webhook for Microsoft Teams channel calls.
deployment_environment (str) – Deployment environment for Microsoft Teams channel calls.
accepted_terms (bool) – Whether this channel accepted terms.
-
class
azure.mgmt.botservice.models.
MsaAppType
(value)[source]¶ -
Microsoft App Type for the bot
-
MULTI_TENANT
= 'MultiTenant'¶
-
SINGLE_TENANT
= 'SingleTenant'¶
-
USER_ASSIGNED_MSI
= 'UserAssignedMSI'¶
-
-
class
azure.mgmt.botservice.models.
OperationDisplayInfo
(*, description: Optional[str] = None, operation: Optional[str] = None, provider: Optional[str] = None, resource: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The operation supported by Bot Service Management.
- Variables
- Keyword Arguments
-
class
azure.mgmt.botservice.models.
OperationEntity
(*, name: Optional[str] = None, display: Optional[azure.mgmt.botservice.models._models_py3.OperationDisplayInfo] = None, origin: Optional[str] = None, properties: Optional[Any] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The operations supported by Bot Service Management.
- Variables
name (str) – Operation name: {provider}/{resource}/{operation}.
display (OperationDisplayInfo) – The operation supported by Bot Service Management.
origin (str) – The origin of the operation.
properties (any) – Additional properties.
- Keyword Arguments
name (str) – Operation name: {provider}/{resource}/{operation}.
display (OperationDisplayInfo) – The operation supported by Bot Service Management.
origin (str) – The origin of the operation.
properties (any) – Additional properties.
-
class
azure.mgmt.botservice.models.
OperationEntityListResult
(*, next_link: Optional[str] = None, value: Optional[List[azure.mgmt.botservice.models._models_py3.OperationEntity]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The list of bot service operation response.
- Variables
next_link (str) – The link used to get the next page of operations.
value (list[OperationEntity]) – The list of operations.
- Keyword Arguments
next_link (str) – The link used to get the next page of operations.
value (list[OperationEntity]) – The list of operations.
-
class
azure.mgmt.botservice.models.
OperationResultStatus
(value)[source]¶ -
The status of the operation being performed.
-
CANCELED
= 'Canceled'¶
-
FAILED
= 'Failed'¶
-
REQUESTED
= 'Requested'¶
-
RUNNING
= 'Running'¶
-
SUCCEEDED
= 'Succeeded'¶
-
-
class
azure.mgmt.botservice.models.
OperationResultsDescription
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
The properties indicating the operation result of an operation on a service.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
name (str) – The name of the operation result.
status (str or OperationResultStatus) – The status of the operation being performed. Possible values include: “Canceled”, “Succeeded”, “Failed”, “Requested”, “Running”.
start_time (datetime) – The time that the operation was started.
-
class
azure.mgmt.botservice.models.
PrivateEndpoint
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
The Private Endpoint resource.
Variables are only populated by the server, and will be ignored when sending a request.
-
class
azure.mgmt.botservice.models.
PrivateEndpointConnection
(*, private_endpoint: Optional[azure.mgmt.botservice.models._models_py3.PrivateEndpoint] = None, private_link_service_connection_state: Optional[azure.mgmt.botservice.models._models_py3.PrivateLinkServiceConnectionState] = None, **kwargs)[source]¶ Bases:
azure.mgmt.botservice.models._models_py3.PrivateLinkResourceBase
The Private Endpoint Connection resource.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
private_endpoint (PrivateEndpoint) – The resource of private end point.
private_link_service_connection_state (PrivateLinkServiceConnectionState) – A collection of information about the state of the connection between service consumer and provider.
provisioning_state (str or PrivateEndpointConnectionProvisioningState) – The provisioning state of the private endpoint connection resource. Possible values include: “Succeeded”, “Creating”, “Deleting”, “Failed”.
- Keyword Arguments
private_endpoint (PrivateEndpoint) – The resource of private end point.
private_link_service_connection_state (PrivateLinkServiceConnectionState) – A collection of information about the state of the connection between service consumer and provider.
-
class
azure.mgmt.botservice.models.
PrivateEndpointConnectionListResult
(*, value: Optional[List[azure.mgmt.botservice.models._models_py3.PrivateEndpointConnection]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
List of private endpoint connection associated with the specified storage account.
- Variables
value (list[PrivateEndpointConnection]) – Array of private endpoint connections.
- Keyword Arguments
value (list[PrivateEndpointConnection]) – Array of private endpoint connections.
-
class
azure.mgmt.botservice.models.
PrivateEndpointConnectionProvisioningState
(value)[source]¶ -
The current provisioning state.
-
CREATING
= 'Creating'¶
-
DELETING
= 'Deleting'¶
-
FAILED
= 'Failed'¶
-
SUCCEEDED
= 'Succeeded'¶
-
-
class
azure.mgmt.botservice.models.
PrivateEndpointServiceConnectionStatus
(value)[source]¶ -
The private endpoint connection status.
-
APPROVED
= 'Approved'¶
-
PENDING
= 'Pending'¶
-
REJECTED
= 'Rejected'¶
-
-
class
azure.mgmt.botservice.models.
PrivateLinkResource
(*, required_zone_names: Optional[List[str]] = None, **kwargs)[source]¶ Bases:
azure.mgmt.botservice.models._models_py3.PrivateLinkResourceBase
A private link resource.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
group_id (str) – The private link resource group id.
required_members (list[str]) – The private link resource required member names.
required_zone_names (list[str]) – The private link resource Private link DNS zone name.
- Keyword Arguments
required_zone_names (list[str]) – The private link resource Private link DNS zone name.
-
class
azure.mgmt.botservice.models.
PrivateLinkResourceBase
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
Common fields that are returned in the response for all BotService Private Link Resources.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
-
class
azure.mgmt.botservice.models.
PrivateLinkResourceListResult
(*, value: Optional[List[azure.mgmt.botservice.models._models_py3.PrivateLinkResource]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
A list of private link resources.
- Variables
value (list[PrivateLinkResource]) – Array of private link resources.
- Keyword Arguments
value (list[PrivateLinkResource]) – Array of private link resources.
-
class
azure.mgmt.botservice.models.
PrivateLinkServiceConnectionState
(*, status: Optional[Union[str, azure.mgmt.botservice.models._azure_bot_service_enums.PrivateEndpointServiceConnectionStatus]] = None, description: Optional[str] = None, actions_required: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
A collection of information about the state of the connection between service consumer and provider.
- Variables
status (str or PrivateEndpointServiceConnectionStatus) – Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. Possible values include: “Pending”, “Approved”, “Rejected”.
description (str) – The reason for approval/rejection of the connection.
actions_required (str) – A message indicating if changes on the service provider require any updates on the consumer.
- Keyword Arguments
status (str or PrivateEndpointServiceConnectionStatus) – Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. Possible values include: “Pending”, “Approved”, “Rejected”.
description (str) – The reason for approval/rejection of the connection.
actions_required (str) – A message indicating if changes on the service provider require any updates on the consumer.
-
class
azure.mgmt.botservice.models.
PublicNetworkAccess
(value)[source]¶ -
Whether the bot is in an isolated network
-
DISABLED
= 'Disabled'¶
-
ENABLED
= 'Enabled'¶
-
-
class
azure.mgmt.botservice.models.
RegenerateKeysChannelName
(value)[source]¶ -
An enumeration.
-
DIRECT_LINE_CHANNEL
= 'DirectLineChannel'¶
-
WEB_CHAT_CHANNEL
= 'WebChatChannel'¶
-
-
class
azure.mgmt.botservice.models.
Resource
(*, 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, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Azure resource.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
name (str) – Specifies the name of the resource.
location (str) – Specifies the location of the resource.
tags (dict[str, str]) – A set of tags. 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”, “azurebot”.
etag (str) – Entity Tag.
- Keyword Arguments
location (str) – Specifies the location of the resource.
tags (dict[str, str]) – A set of tags. 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”, “azurebot”.
etag (str) – Entity Tag.
-
class
azure.mgmt.botservice.models.
ServiceProvider
(*, properties: Optional[azure.mgmt.botservice.models._models_py3.ServiceProviderProperties] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Service Provider Definition.
- Variables
properties (ServiceProviderProperties) – The Properties of a Service Provider Object.
- Keyword Arguments
properties (ServiceProviderProperties) – The Properties of a Service Provider Object.
-
class
azure.mgmt.botservice.models.
ServiceProviderParameter
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
Extra Parameters specific to each Service Provider.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
name (str) – Name of the Service Provider.
display_name (str) – Display Name of the Service Provider.
description (str) – Description of the Service Provider.
help_url (str) – Help Url for the Service Provider.
default (str) – Default Name for the Service Provider.
metadata (ServiceProviderParameterMetadata) – Meta data for the Service Provider.
-
class
azure.mgmt.botservice.models.
ServiceProviderParameterMetadata
(*, constraints: Optional[azure.mgmt.botservice.models._models_py3.ServiceProviderParameterMetadataConstraints] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Meta data for the Service Provider.
- Variables
constraints (ServiceProviderParameterMetadataConstraints) – the constraints of the bot meta data.
- Keyword Arguments
constraints (ServiceProviderParameterMetadataConstraints) – the constraints of the bot meta data.
-
class
azure.mgmt.botservice.models.
ServiceProviderParameterMetadataConstraints
(*, required: Optional[bool] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
the constraints of the bot meta data.
-
class
azure.mgmt.botservice.models.
ServiceProviderProperties
(*, parameters: Optional[List[azure.mgmt.botservice.models._models_py3.ServiceProviderParameter]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The Object used to describe a Service Provider supported by Bot Service.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
display_name (str) – Display Name of the Service Provider.
service_provider_name (str) – Display Name of the Service Provider.
dev_portal_url (str) – Display Name of the Service Provider.
icon_url (str) – Display Name of the Service Provider.
parameters (list[ServiceProviderParameter]) – The list of parameters for the Service Provider.
- Keyword Arguments
parameters (list[ServiceProviderParameter]) – The list of parameters for the Service Provider.
-
class
azure.mgmt.botservice.models.
ServiceProviderResponseList
(*, next_link: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The list of bot service providers response.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
next_link (str) – The link used to get the next page of bot service providers.
value (list[ServiceProvider]) – Gets the list of bot service providers and their properties.
- Keyword Arguments
next_link (str) – The link used to get the next page of bot service providers.
-
class
azure.mgmt.botservice.models.
Site
(*, is_v1_enabled: bool, is_v3_enabled: bool, site_name: str, is_enabled: bool, is_webchat_preview_enabled: bool, is_secure_site_enabled: Optional[bool] = None, is_block_user_upload_enabled: Optional[bool] = None, trusted_origins: Optional[List[str]] = None, is_token_enabled: Optional[bool] = None, e_tag: Optional[str] = None, **kwargs)[source]¶ Bases:
azure.mgmt.botservice.models._models_py3.WebChatSite
,azure.mgmt.botservice.models._models_py3.DirectLineSite
A site for the channel.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
is_v1_enabled (bool) – Required. Whether this site is enabled for Bot Framework V1 protocol.
is_v3_enabled (bool) – Required. Whether this site is enabled for Bot Framework V1 protocol.
is_secure_site_enabled (bool) – Whether this site is enabled for authentication with Bot Framework.
is_block_user_upload_enabled (bool) – Whether this site is enabled for block user upload.
trusted_origins (list[str]) – List of Trusted Origin URLs for this site. This field is applicable only if isSecureSiteEnabled is True.
site_id (str) – Site Id.
site_name (str) – Required. Site name.
key (str) – Primary key. Value only returned through POST to the action Channel List API, otherwise empty.
key2 (str) – Secondary key. Value only returned through POST to the action Channel List API, otherwise empty.
is_enabled (bool) – Required. Whether this site is enabled for DirectLine channel.
is_webchat_preview_enabled (bool) – Required. Whether this site is enabled for preview versions of Webchat.
is_token_enabled (bool) – Whether this site is token enabled for channel.
e_tag (str) – Entity Tag.
- Keyword Arguments
is_v1_enabled (bool) – Required. Whether this site is enabled for Bot Framework V1 protocol.
is_v3_enabled (bool) – Required. Whether this site is enabled for Bot Framework V1 protocol.
is_secure_site_enabled (bool) – Whether this site is enabled for authentication with Bot Framework.
is_block_user_upload_enabled (bool) – Whether this site is enabled for block user upload.
trusted_origins (list[str]) – List of Trusted Origin URLs for this site. This field is applicable only if isSecureSiteEnabled is True.
site_name (str) – Required. Site name.
is_enabled (bool) – Required. Whether this site is enabled for DirectLine channel.
is_webchat_preview_enabled (bool) – Required. Whether this site is enabled for preview versions of Webchat.
is_token_enabled (bool) – Whether this site is token enabled for channel.
e_tag (str) – Entity Tag.
-
class
azure.mgmt.botservice.models.
SiteInfo
(*, site_name: str, key: Union[str, azure.mgmt.botservice.models._azure_bot_service_enums.Key], **kwargs)[source]¶ Bases:
msrest.serialization.Model
Site information for WebChat or DirectLine Channels to identify which site to regenerate keys for.
All required parameters must be populated in order to send to Azure.
- Variables
- Keyword Arguments
-
class
azure.mgmt.botservice.models.
Sku
(*, name: Union[str, azure.mgmt.botservice.models._azure_bot_service_enums.SkuName], **kwargs)[source]¶ Bases:
msrest.serialization.Model
The SKU of the cognitive services account.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
-
class
azure.mgmt.botservice.models.
SkuTier
(value)[source]¶ -
Gets the sku tier. This is based on the SKU name.
-
FREE
= 'Free'¶
-
STANDARD
= 'Standard'¶
-
-
class
azure.mgmt.botservice.models.
SkypeChannel
(*, etag: Optional[str] = None, location: Optional[str] = 'global', properties: Optional[azure.mgmt.botservice.models._models_py3.SkypeChannelProperties] = None, **kwargs)[source]¶ Bases:
azure.mgmt.botservice.models._models_py3.Channel
Skype channel definition.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
channel_name (str) – Required. The channel name.Constant filled by server.
etag (str) – Entity Tag of the resource.
provisioning_state (str) – Provisioning state of the resource.
location (str) – Specifies the location of the resource.
properties (SkypeChannelProperties) – The set of properties specific to Skype channel resource.
- Keyword Arguments
etag (str) – Entity Tag of the resource.
location (str) – Specifies the location of the resource.
properties (SkypeChannelProperties) – The set of properties specific to Skype channel resource.
-
class
azure.mgmt.botservice.models.
SkypeChannelProperties
(*, is_enabled: bool, enable_messaging: Optional[bool] = None, enable_media_cards: Optional[bool] = None, enable_video: Optional[bool] = None, enable_calling: Optional[bool] = None, enable_screen_sharing: Optional[bool] = None, enable_groups: Optional[bool] = None, groups_mode: Optional[str] = None, calling_web_hook: Optional[str] = None, incoming_call_route: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The parameters to provide for the Microsoft Teams channel.
All required parameters must be populated in order to send to Azure.
- Variables
enable_messaging (bool) – Enable messaging for Skype channel.
enable_media_cards (bool) – Enable media cards for Skype channel.
enable_video (bool) – Enable video for Skype channel.
enable_calling (bool) – Enable calling for Skype channel.
enable_screen_sharing (bool) – Enable screen sharing for Skype channel.
enable_groups (bool) – Enable groups for Skype channel.
groups_mode (str) – Group mode for Skype channel.
calling_web_hook (str) – Calling web hook for Skype channel.
incoming_call_route (str) – Incoming call route for Skype channel.
is_enabled (bool) – Required. Whether this channel is enabled for the bot.
- Keyword Arguments
enable_messaging (bool) – Enable messaging for Skype channel.
enable_media_cards (bool) – Enable media cards for Skype channel.
enable_video (bool) – Enable video for Skype channel.
enable_calling (bool) – Enable calling for Skype channel.
enable_screen_sharing (bool) – Enable screen sharing for Skype channel.
enable_groups (bool) – Enable groups for Skype channel.
groups_mode (str) – Group mode for Skype channel.
calling_web_hook (str) – Calling web hook for Skype channel.
incoming_call_route (str) – Incoming call route for Skype channel.
is_enabled (bool) – Required. Whether this channel is enabled for the bot.
-
class
azure.mgmt.botservice.models.
SlackChannel
(*, etag: Optional[str] = None, location: Optional[str] = 'global', properties: Optional[azure.mgmt.botservice.models._models_py3.SlackChannelProperties] = None, **kwargs)[source]¶ Bases:
azure.mgmt.botservice.models._models_py3.Channel
Slack channel definition.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
channel_name (str) – Required. The channel name.Constant filled by server.
etag (str) – Entity Tag of the resource.
provisioning_state (str) – Provisioning state of the resource.
location (str) – Specifies the location of the resource.
properties (SlackChannelProperties) – The set of properties specific to Slack channel resource.
- Keyword Arguments
etag (str) – Entity Tag of the resource.
location (str) – Specifies the location of the resource.
properties (SlackChannelProperties) – The set of properties specific to Slack channel resource.
-
class
azure.mgmt.botservice.models.
SlackChannelProperties
(*, is_enabled: bool, client_id: Optional[str] = None, client_secret: Optional[str] = None, verification_token: Optional[str] = None, scopes: Optional[str] = None, landing_page_url: Optional[str] = None, signing_secret: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The parameters to provide for the Slack channel.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
client_id (str) – The Slack client id.
client_secret (str) – The Slack client secret. Value only returned through POST to the action Channel List API, otherwise empty.
verification_token (str) – The Slack verification token. Value only returned through POST to the action Channel List API, otherwise empty.
scopes (str) – The Slack permission scopes.
landing_page_url (str) – The Slack landing page Url.
redirect_action (str) – The Slack redirect action.
last_submission_id (str) – The Sms auth token.
register_before_o_auth_flow (bool) – Whether to register the settings before OAuth validation is performed. Recommended to True.
is_validated (bool) – Whether this channel is validated for the bot.
signing_secret (str) – The Slack signing secret.
is_enabled (bool) – Required. Whether this channel is enabled for the bot.
- Keyword Arguments
client_id (str) – The Slack client id.
client_secret (str) – The Slack client secret. Value only returned through POST to the action Channel List API, otherwise empty.
verification_token (str) – The Slack verification token. Value only returned through POST to the action Channel List API, otherwise empty.
scopes (str) – The Slack permission scopes.
landing_page_url (str) – The Slack landing page Url.
signing_secret (str) – The Slack signing secret.
is_enabled (bool) – Required. Whether this channel is enabled for the bot.
-
class
azure.mgmt.botservice.models.
SmsChannel
(*, etag: Optional[str] = None, location: Optional[str] = 'global', properties: Optional[azure.mgmt.botservice.models._models_py3.SmsChannelProperties] = None, **kwargs)[source]¶ Bases:
azure.mgmt.botservice.models._models_py3.Channel
Sms channel definition.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
channel_name (str) – Required. The channel name.Constant filled by server.
etag (str) – Entity Tag of the resource.
provisioning_state (str) – Provisioning state of the resource.
location (str) – Specifies the location of the resource.
properties (SmsChannelProperties) – The set of properties specific to Sms channel resource.
- Keyword Arguments
etag (str) – Entity Tag of the resource.
location (str) – Specifies the location of the resource.
properties (SmsChannelProperties) – The set of properties specific to Sms channel resource.
-
class
azure.mgmt.botservice.models.
SmsChannelProperties
(*, phone: str, account_sid: str, is_enabled: bool, auth_token: Optional[str] = None, is_validated: Optional[bool] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The parameters to provide for the Sms channel.
All required parameters must be populated in order to send to Azure.
- Variables
phone (str) – Required. The Sms phone.
account_sid (str) – Required. The Sms account SID. Value only returned through POST to the action Channel List API, otherwise empty.
auth_token (str) – The Sms auth token. Value only returned through POST to the action Channel List API, otherwise empty.
is_validated (bool) – Whether this channel is validated for the bot.
is_enabled (bool) – Required. Whether this channel is enabled for the bot.
- Keyword Arguments
phone (str) – Required. The Sms phone.
account_sid (str) – Required. The Sms account SID. Value only returned through POST to the action Channel List API, otherwise empty.
auth_token (str) – The Sms auth token. Value only returned through POST to the action Channel List API, otherwise empty.
is_validated (bool) – Whether this channel is validated for the bot.
is_enabled (bool) – Required. Whether this channel is enabled for the bot.
-
class
azure.mgmt.botservice.models.
TelegramChannel
(*, etag: Optional[str] = None, location: Optional[str] = 'global', properties: Optional[azure.mgmt.botservice.models._models_py3.TelegramChannelProperties] = None, **kwargs)[source]¶ Bases:
azure.mgmt.botservice.models._models_py3.Channel
Telegram channel definition.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
channel_name (str) – Required. The channel name.Constant filled by server.
etag (str) – Entity Tag of the resource.
provisioning_state (str) – Provisioning state of the resource.
location (str) – Specifies the location of the resource.
properties (TelegramChannelProperties) – The set of properties specific to Telegram channel resource.
- Keyword Arguments
etag (str) – Entity Tag of the resource.
location (str) – Specifies the location of the resource.
properties (TelegramChannelProperties) – The set of properties specific to Telegram channel resource.
-
class
azure.mgmt.botservice.models.
TelegramChannelProperties
(*, is_enabled: bool, access_token: Optional[str] = None, is_validated: Optional[bool] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The parameters to provide for the Telegram channel.
All required parameters must be populated in order to send to Azure.
- Variables
- Keyword Arguments
-
class
azure.mgmt.botservice.models.
WebChatChannel
(*, etag: Optional[str] = None, location: Optional[str] = 'global', properties: Optional[azure.mgmt.botservice.models._models_py3.WebChatChannelProperties] = None, **kwargs)[source]¶ Bases:
azure.mgmt.botservice.models._models_py3.Channel
Web Chat channel definition.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
channel_name (str) – Required. The channel name.Constant filled by server.
etag (str) – Entity Tag of the resource.
provisioning_state (str) – Provisioning state of the resource.
location (str) – Specifies the location of the resource.
properties (WebChatChannelProperties) – The set of properties specific to Web Chat channel resource.
- Keyword Arguments
etag (str) – Entity Tag of the resource.
location (str) – Specifies the location of the resource.
properties (WebChatChannelProperties) – The set of properties specific to Web Chat channel resource.
-
class
azure.mgmt.botservice.models.
WebChatChannelProperties
(*, sites: Optional[List[azure.mgmt.botservice.models._models_py3.WebChatSite]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The parameters to provide for the Web Chat channel.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
web_chat_embed_code (str) – Web chat control embed code.
sites (list[WebChatSite]) – The list of Web Chat sites.
- Keyword Arguments
sites (list[WebChatSite]) – The list of Web Chat sites.
-
class
azure.mgmt.botservice.models.
WebChatSite
(*, site_name: str, is_enabled: bool, is_webchat_preview_enabled: bool, **kwargs)[source]¶ Bases:
msrest.serialization.Model
A site for the Webchat channel.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
site_id (str) – Site Id.
site_name (str) – Required. Site name.
key (str) – Primary key. Value only returned through POST to the action Channel List API, otherwise empty.
key2 (str) – Secondary key. Value only returned through POST to the action Channel List API, otherwise empty.
is_enabled (bool) – Required. Whether this site is enabled for DirectLine channel.
is_webchat_preview_enabled (bool) – Required. Whether this site is enabled for preview versions of Webchat.
- Keyword Arguments