# coding=utf-8
# --------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
# Code generated by Microsoft (R) AutoRest Code Generator.
# Changes may cause incorrect behavior and will be lost if the code is regenerated.
# --------------------------------------------------------------------------
from typing import Any, Dict, List, Optional, Union
from azure.core.exceptions import HttpResponseError
import msrest.serialization
from ._azure_bot_service_enums import *
[docs]class Channel(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.
:ivar channel_name: Required. The channel name.Constant filled by server.
:vartype channel_name: str
:ivar etag: Entity Tag of the resource.
:vartype etag: str
:ivar provisioning_state: Provisioning state of the resource.
:vartype provisioning_state: str
:ivar location: Specifies the location of the resource.
:vartype location: str
"""
_validation = {
'channel_name': {'required': True},
'provisioning_state': {'readonly': True},
}
_attribute_map = {
'channel_name': {'key': 'channelName', 'type': 'str'},
'etag': {'key': 'etag', 'type': 'str'},
'provisioning_state': {'key': 'provisioningState', 'type': 'str'},
'location': {'key': 'location', 'type': 'str'},
}
_subtype_map = {
'channel_name': {'AlexaChannel': 'AlexaChannel', 'DirectLineChannel': 'DirectLineChannel', 'DirectLineSpeechChannel': 'DirectLineSpeechChannel', 'EmailChannel': 'EmailChannel', 'FacebookChannel': 'FacebookChannel', 'KikChannel': 'KikChannel', 'LineChannel': 'LineChannel', 'MsTeamsChannel': 'MsTeamsChannel', 'SkypeChannel': 'SkypeChannel', 'SlackChannel': 'SlackChannel', 'SmsChannel': 'SmsChannel', 'TelegramChannel': 'TelegramChannel', 'WebChatChannel': 'WebChatChannel'}
}
def __init__(
self,
*,
etag: Optional[str] = None,
location: Optional[str] = "global",
**kwargs
):
"""
:keyword etag: Entity Tag of the resource.
:paramtype etag: str
:keyword location: Specifies the location of the resource.
:paramtype location: str
"""
super(Channel, self).__init__(**kwargs)
self.channel_name = None # type: Optional[str]
self.etag = etag
self.provisioning_state = None
self.location = location
[docs]class AlexaChannel(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.
:ivar channel_name: Required. The channel name.Constant filled by server.
:vartype channel_name: str
:ivar etag: Entity Tag of the resource.
:vartype etag: str
:ivar provisioning_state: Provisioning state of the resource.
:vartype provisioning_state: str
:ivar location: Specifies the location of the resource.
:vartype location: str
:ivar properties: The set of properties specific to Alexa channel resource.
:vartype properties: ~azure.mgmt.botservice.models.AlexaChannelProperties
"""
_validation = {
'channel_name': {'required': True},
'provisioning_state': {'readonly': True},
}
_attribute_map = {
'channel_name': {'key': 'channelName', 'type': 'str'},
'etag': {'key': 'etag', 'type': 'str'},
'provisioning_state': {'key': 'provisioningState', 'type': 'str'},
'location': {'key': 'location', 'type': 'str'},
'properties': {'key': 'properties', 'type': 'AlexaChannelProperties'},
}
def __init__(
self,
*,
etag: Optional[str] = None,
location: Optional[str] = "global",
properties: Optional["AlexaChannelProperties"] = None,
**kwargs
):
"""
:keyword etag: Entity Tag of the resource.
:paramtype etag: str
:keyword location: Specifies the location of the resource.
:paramtype location: str
:keyword properties: The set of properties specific to Alexa channel resource.
:paramtype properties: ~azure.mgmt.botservice.models.AlexaChannelProperties
"""
super(AlexaChannel, self).__init__(etag=etag, location=location, **kwargs)
self.channel_name = 'AlexaChannel' # type: str
self.properties = properties
[docs]class AlexaChannelProperties(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.
:ivar alexa_skill_id: Required. The Alexa skill Id.
:vartype alexa_skill_id: str
:ivar url_fragment: Url fragment used in part of the Uri configured in Alexa.
:vartype url_fragment: str
:ivar service_endpoint_uri: Full Uri used to configured the skill in Alexa.
:vartype service_endpoint_uri: str
:ivar is_enabled: Required. Whether this channel is enabled for the bot.
:vartype is_enabled: bool
"""
_validation = {
'alexa_skill_id': {'required': True},
'url_fragment': {'readonly': True},
'service_endpoint_uri': {'readonly': True},
'is_enabled': {'required': True},
}
_attribute_map = {
'alexa_skill_id': {'key': 'alexaSkillId', 'type': 'str'},
'url_fragment': {'key': 'urlFragment', 'type': 'str'},
'service_endpoint_uri': {'key': 'serviceEndpointUri', 'type': 'str'},
'is_enabled': {'key': 'isEnabled', 'type': 'bool'},
}
def __init__(
self,
*,
alexa_skill_id: str,
is_enabled: bool,
**kwargs
):
"""
:keyword alexa_skill_id: Required. The Alexa skill Id.
:paramtype alexa_skill_id: str
:keyword is_enabled: Required. Whether this channel is enabled for the bot.
:paramtype is_enabled: bool
"""
super(AlexaChannelProperties, self).__init__(**kwargs)
self.alexa_skill_id = alexa_skill_id
self.url_fragment = None
self.service_endpoint_uri = None
self.is_enabled = is_enabled
[docs]class Resource(msrest.serialization.Model):
"""Azure resource.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar id: Specifies the resource ID.
:vartype id: str
:ivar name: Specifies the name of the resource.
:vartype name: str
:ivar location: Specifies the location of the resource.
:vartype location: str
:ivar type: Specifies the type of the resource.
:vartype type: str
:ivar tags: A set of tags. Contains resource tags defined as key/value pairs.
:vartype tags: dict[str, str]
:ivar sku: Gets or sets the SKU of the resource.
:vartype sku: ~azure.mgmt.botservice.models.Sku
:ivar kind: Required. Gets or sets the Kind of the resource. Possible values include: "sdk",
"designer", "bot", "function", "azurebot".
:vartype kind: str or ~azure.mgmt.botservice.models.Kind
:ivar etag: Entity Tag.
:vartype etag: str
:ivar zones: Entity zones.
:vartype zones: list[str]
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'zones': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'location': {'key': 'location', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'tags': {'key': 'tags', 'type': '{str}'},
'sku': {'key': 'sku', 'type': 'Sku'},
'kind': {'key': 'kind', 'type': 'str'},
'etag': {'key': 'etag', 'type': 'str'},
'zones': {'key': 'zones', 'type': '[str]'},
}
def __init__(
self,
*,
location: Optional[str] = None,
tags: Optional[Dict[str, str]] = None,
sku: Optional["Sku"] = None,
kind: Optional[Union[str, "Kind"]] = None,
etag: Optional[str] = None,
**kwargs
):
"""
:keyword location: Specifies the location of the resource.
:paramtype location: str
:keyword tags: A set of tags. Contains resource tags defined as key/value pairs.
:paramtype tags: dict[str, str]
:keyword sku: Gets or sets the SKU of the resource.
:paramtype sku: ~azure.mgmt.botservice.models.Sku
:keyword kind: Required. Gets or sets the Kind of the resource. Possible values include: "sdk",
"designer", "bot", "function", "azurebot".
:paramtype kind: str or ~azure.mgmt.botservice.models.Kind
:keyword etag: Entity Tag.
:paramtype etag: str
"""
super(Resource, self).__init__(**kwargs)
self.id = None
self.name = None
self.location = location
self.type = None
self.tags = tags
self.sku = sku
self.kind = kind
self.etag = etag
self.zones = None
[docs]class Bot(Resource):
"""Bot resource definition.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar id: Specifies the resource ID.
:vartype id: str
:ivar name: Specifies the name of the resource.
:vartype name: str
:ivar location: Specifies the location of the resource.
:vartype location: str
:ivar type: Specifies the type of the resource.
:vartype type: str
:ivar tags: A set of tags. Contains resource tags defined as key/value pairs.
:vartype tags: dict[str, str]
:ivar sku: Gets or sets the SKU of the resource.
:vartype sku: ~azure.mgmt.botservice.models.Sku
:ivar kind: Required. Gets or sets the Kind of the resource. Possible values include: "sdk",
"designer", "bot", "function", "azurebot".
:vartype kind: str or ~azure.mgmt.botservice.models.Kind
:ivar etag: Entity Tag.
:vartype etag: str
:ivar zones: Entity zones.
:vartype zones: list[str]
:ivar properties: The set of properties specific to bot resource.
:vartype properties: ~azure.mgmt.botservice.models.BotProperties
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'zones': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'location': {'key': 'location', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'tags': {'key': 'tags', 'type': '{str}'},
'sku': {'key': 'sku', 'type': 'Sku'},
'kind': {'key': 'kind', 'type': 'str'},
'etag': {'key': 'etag', 'type': 'str'},
'zones': {'key': 'zones', 'type': '[str]'},
'properties': {'key': 'properties', 'type': 'BotProperties'},
}
def __init__(
self,
*,
location: Optional[str] = None,
tags: Optional[Dict[str, str]] = None,
sku: Optional["Sku"] = None,
kind: Optional[Union[str, "Kind"]] = None,
etag: Optional[str] = None,
properties: Optional["BotProperties"] = None,
**kwargs
):
"""
:keyword location: Specifies the location of the resource.
:paramtype location: str
:keyword tags: A set of tags. Contains resource tags defined as key/value pairs.
:paramtype tags: dict[str, str]
:keyword sku: Gets or sets the SKU of the resource.
:paramtype sku: ~azure.mgmt.botservice.models.Sku
:keyword kind: Required. Gets or sets the Kind of the resource. Possible values include: "sdk",
"designer", "bot", "function", "azurebot".
:paramtype kind: str or ~azure.mgmt.botservice.models.Kind
:keyword etag: Entity Tag.
:paramtype etag: str
:keyword properties: The set of properties specific to bot resource.
:paramtype properties: ~azure.mgmt.botservice.models.BotProperties
"""
super(Bot, self).__init__(location=location, tags=tags, sku=sku, kind=kind, etag=etag, **kwargs)
self.properties = properties
[docs]class BotChannel(Resource):
"""Bot channel resource definition.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar id: Specifies the resource ID.
:vartype id: str
:ivar name: Specifies the name of the resource.
:vartype name: str
:ivar location: Specifies the location of the resource.
:vartype location: str
:ivar type: Specifies the type of the resource.
:vartype type: str
:ivar tags: A set of tags. Contains resource tags defined as key/value pairs.
:vartype tags: dict[str, str]
:ivar sku: Gets or sets the SKU of the resource.
:vartype sku: ~azure.mgmt.botservice.models.Sku
:ivar kind: Required. Gets or sets the Kind of the resource. Possible values include: "sdk",
"designer", "bot", "function", "azurebot".
:vartype kind: str or ~azure.mgmt.botservice.models.Kind
:ivar etag: Entity Tag.
:vartype etag: str
:ivar zones: Entity zones.
:vartype zones: list[str]
:ivar properties: The set of properties specific to bot channel resource.
:vartype properties: ~azure.mgmt.botservice.models.Channel
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'zones': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'location': {'key': 'location', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'tags': {'key': 'tags', 'type': '{str}'},
'sku': {'key': 'sku', 'type': 'Sku'},
'kind': {'key': 'kind', 'type': 'str'},
'etag': {'key': 'etag', 'type': 'str'},
'zones': {'key': 'zones', 'type': '[str]'},
'properties': {'key': 'properties', 'type': 'Channel'},
}
def __init__(
self,
*,
location: Optional[str] = None,
tags: Optional[Dict[str, str]] = None,
sku: Optional["Sku"] = None,
kind: Optional[Union[str, "Kind"]] = None,
etag: Optional[str] = None,
properties: Optional["Channel"] = None,
**kwargs
):
"""
:keyword location: Specifies the location of the resource.
:paramtype location: str
:keyword tags: A set of tags. Contains resource tags defined as key/value pairs.
:paramtype tags: dict[str, str]
:keyword sku: Gets or sets the SKU of the resource.
:paramtype sku: ~azure.mgmt.botservice.models.Sku
:keyword kind: Required. Gets or sets the Kind of the resource. Possible values include: "sdk",
"designer", "bot", "function", "azurebot".
:paramtype kind: str or ~azure.mgmt.botservice.models.Kind
:keyword etag: Entity Tag.
:paramtype etag: str
:keyword properties: The set of properties specific to bot channel resource.
:paramtype properties: ~azure.mgmt.botservice.models.Channel
"""
super(BotChannel, self).__init__(location=location, tags=tags, sku=sku, kind=kind, etag=etag, **kwargs)
self.properties = properties
[docs]class BotProperties(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.
:ivar display_name: Required. The Name of the bot.
:vartype display_name: str
:ivar description: The description of the bot.
:vartype description: str
:ivar icon_url: The Icon Url of the bot.
:vartype icon_url: str
:ivar endpoint: Required. The bot's endpoint.
:vartype endpoint: str
:ivar endpoint_version: The bot's endpoint version.
:vartype endpoint_version: str
:ivar all_settings: Contains resource all settings defined as key/value pairs.
:vartype all_settings: dict[str, str]
:ivar parameters: Contains resource parameters defined as key/value pairs.
:vartype parameters: dict[str, str]
:ivar manifest_url: The bot's manifest url.
:vartype manifest_url: str
:ivar msa_app_type: Microsoft App Type for the bot. Possible values include: "UserAssignedMSI",
"SingleTenant", "MultiTenant".
:vartype msa_app_type: str or ~azure.mgmt.botservice.models.MsaAppType
:ivar msa_app_id: Required. Microsoft App Id for the bot.
:vartype msa_app_id: str
:ivar msa_app_tenant_id: Microsoft App Tenant Id for the bot.
:vartype msa_app_tenant_id: str
:ivar msa_app_msi_resource_id: Microsoft App Managed Identity Resource Id for the bot.
:vartype msa_app_msi_resource_id: str
:ivar configured_channels: Collection of channels for which the bot is configured.
:vartype configured_channels: list[str]
:ivar enabled_channels: Collection of channels for which the bot is enabled.
:vartype enabled_channels: list[str]
:ivar developer_app_insight_key: The Application Insights key.
:vartype developer_app_insight_key: str
:ivar developer_app_insights_api_key: The Application Insights Api Key.
:vartype developer_app_insights_api_key: str
:ivar developer_app_insights_application_id: The Application Insights App Id.
:vartype developer_app_insights_application_id: str
:ivar luis_app_ids: Collection of LUIS App Ids.
:vartype luis_app_ids: list[str]
:ivar luis_key: The LUIS Key.
:vartype luis_key: str
:ivar is_cmek_enabled: Whether Cmek is enabled.
:vartype is_cmek_enabled: bool
:ivar cmek_key_vault_url: The CMK Url.
:vartype cmek_key_vault_url: str
:ivar cmek_encryption_status: The CMK encryption status.
:vartype cmek_encryption_status: str
:ivar public_network_access: Whether the bot is in an isolated network. Possible values
include: "Enabled", "Disabled". Default value: "Enabled".
:vartype public_network_access: str or ~azure.mgmt.botservice.models.PublicNetworkAccess
:ivar is_streaming_supported: Whether the bot is streaming supported.
:vartype is_streaming_supported: bool
:ivar is_developer_app_insights_api_key_set: Whether the bot is developerAppInsightsApiKey set.
:vartype is_developer_app_insights_api_key_set: bool
:ivar migration_token: Token used to migrate non Azure bot to azure subscription.
:vartype migration_token: str
:ivar disable_local_auth: Opt-out of local authentication and ensure only MSI and AAD can be
used exclusively for authentication.
:vartype disable_local_auth: bool
:ivar schema_transformation_version: The channel schema transformation version for the bot.
:vartype schema_transformation_version: str
:ivar storage_resource_id: The storage resourceId for the bot.
:vartype storage_resource_id: str
:ivar private_endpoint_connections: List of Private Endpoint Connections configured for the
bot.
:vartype private_endpoint_connections:
list[~azure.mgmt.botservice.models.PrivateEndpointConnection]
:ivar open_with_hint: The hint to browser (e.g. protocol handler) on how to open the bot for
authoring.
:vartype open_with_hint: str
:ivar app_password_hint: The hint (e.g. keyVault secret resourceId) on how to fetch the app
secret.
:vartype app_password_hint: str
:ivar provisioning_state: Provisioning state of the resource.
:vartype provisioning_state: str
:ivar publishing_credentials: Publishing credentials of the resource.
:vartype publishing_credentials: str
"""
_validation = {
'display_name': {'required': True},
'endpoint': {'required': True},
'endpoint_version': {'readonly': True},
'msa_app_id': {'required': True},
'configured_channels': {'readonly': True},
'enabled_channels': {'readonly': True},
'cmek_encryption_status': {'readonly': True},
'is_developer_app_insights_api_key_set': {'readonly': True},
'migration_token': {'readonly': True},
'private_endpoint_connections': {'readonly': True},
'provisioning_state': {'readonly': True},
}
_attribute_map = {
'display_name': {'key': 'displayName', 'type': 'str'},
'description': {'key': 'description', 'type': 'str'},
'icon_url': {'key': 'iconUrl', 'type': 'str'},
'endpoint': {'key': 'endpoint', 'type': 'str'},
'endpoint_version': {'key': 'endpointVersion', 'type': 'str'},
'all_settings': {'key': 'allSettings', 'type': '{str}'},
'parameters': {'key': 'parameters', 'type': '{str}'},
'manifest_url': {'key': 'manifestUrl', 'type': 'str'},
'msa_app_type': {'key': 'msaAppType', 'type': 'str'},
'msa_app_id': {'key': 'msaAppId', 'type': 'str'},
'msa_app_tenant_id': {'key': 'msaAppTenantId', 'type': 'str'},
'msa_app_msi_resource_id': {'key': 'msaAppMSIResourceId', 'type': 'str'},
'configured_channels': {'key': 'configuredChannels', 'type': '[str]'},
'enabled_channels': {'key': 'enabledChannels', 'type': '[str]'},
'developer_app_insight_key': {'key': 'developerAppInsightKey', 'type': 'str'},
'developer_app_insights_api_key': {'key': 'developerAppInsightsApiKey', 'type': 'str'},
'developer_app_insights_application_id': {'key': 'developerAppInsightsApplicationId', 'type': 'str'},
'luis_app_ids': {'key': 'luisAppIds', 'type': '[str]'},
'luis_key': {'key': 'luisKey', 'type': 'str'},
'is_cmek_enabled': {'key': 'isCmekEnabled', 'type': 'bool'},
'cmek_key_vault_url': {'key': 'cmekKeyVaultUrl', 'type': 'str'},
'cmek_encryption_status': {'key': 'cmekEncryptionStatus', 'type': 'str'},
'public_network_access': {'key': 'publicNetworkAccess', 'type': 'str'},
'is_streaming_supported': {'key': 'isStreamingSupported', 'type': 'bool'},
'is_developer_app_insights_api_key_set': {'key': 'isDeveloperAppInsightsApiKeySet', 'type': 'bool'},
'migration_token': {'key': 'migrationToken', 'type': 'str'},
'disable_local_auth': {'key': 'disableLocalAuth', 'type': 'bool'},
'schema_transformation_version': {'key': 'schemaTransformationVersion', 'type': 'str'},
'storage_resource_id': {'key': 'storageResourceId', 'type': 'str'},
'private_endpoint_connections': {'key': 'privateEndpointConnections', 'type': '[PrivateEndpointConnection]'},
'open_with_hint': {'key': 'openWithHint', 'type': 'str'},
'app_password_hint': {'key': 'appPasswordHint', 'type': 'str'},
'provisioning_state': {'key': 'provisioningState', 'type': 'str'},
'publishing_credentials': {'key': 'publishingCredentials', 'type': 'str'},
}
def __init__(
self,
*,
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, "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, "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
):
"""
:keyword display_name: Required. The Name of the bot.
:paramtype display_name: str
:keyword description: The description of the bot.
:paramtype description: str
:keyword icon_url: The Icon Url of the bot.
:paramtype icon_url: str
:keyword endpoint: Required. The bot's endpoint.
:paramtype endpoint: str
:keyword all_settings: Contains resource all settings defined as key/value pairs.
:paramtype all_settings: dict[str, str]
:keyword parameters: Contains resource parameters defined as key/value pairs.
:paramtype parameters: dict[str, str]
:keyword manifest_url: The bot's manifest url.
:paramtype manifest_url: str
:keyword msa_app_type: Microsoft App Type for the bot. Possible values include:
"UserAssignedMSI", "SingleTenant", "MultiTenant".
:paramtype msa_app_type: str or ~azure.mgmt.botservice.models.MsaAppType
:keyword msa_app_id: Required. Microsoft App Id for the bot.
:paramtype msa_app_id: str
:keyword msa_app_tenant_id: Microsoft App Tenant Id for the bot.
:paramtype msa_app_tenant_id: str
:keyword msa_app_msi_resource_id: Microsoft App Managed Identity Resource Id for the bot.
:paramtype msa_app_msi_resource_id: str
:keyword developer_app_insight_key: The Application Insights key.
:paramtype developer_app_insight_key: str
:keyword developer_app_insights_api_key: The Application Insights Api Key.
:paramtype developer_app_insights_api_key: str
:keyword developer_app_insights_application_id: The Application Insights App Id.
:paramtype developer_app_insights_application_id: str
:keyword luis_app_ids: Collection of LUIS App Ids.
:paramtype luis_app_ids: list[str]
:keyword luis_key: The LUIS Key.
:paramtype luis_key: str
:keyword is_cmek_enabled: Whether Cmek is enabled.
:paramtype is_cmek_enabled: bool
:keyword cmek_key_vault_url: The CMK Url.
:paramtype cmek_key_vault_url: str
:keyword public_network_access: Whether the bot is in an isolated network. Possible values
include: "Enabled", "Disabled". Default value: "Enabled".
:paramtype public_network_access: str or ~azure.mgmt.botservice.models.PublicNetworkAccess
:keyword is_streaming_supported: Whether the bot is streaming supported.
:paramtype is_streaming_supported: bool
:keyword disable_local_auth: Opt-out of local authentication and ensure only MSI and AAD can be
used exclusively for authentication.
:paramtype disable_local_auth: bool
:keyword schema_transformation_version: The channel schema transformation version for the bot.
:paramtype schema_transformation_version: str
:keyword storage_resource_id: The storage resourceId for the bot.
:paramtype storage_resource_id: str
:keyword open_with_hint: The hint to browser (e.g. protocol handler) on how to open the bot for
authoring.
:paramtype open_with_hint: str
:keyword app_password_hint: The hint (e.g. keyVault secret resourceId) on how to fetch the app
secret.
:paramtype app_password_hint: str
:keyword publishing_credentials: Publishing credentials of the resource.
:paramtype publishing_credentials: str
"""
super(BotProperties, self).__init__(**kwargs)
self.display_name = display_name
self.description = description
self.icon_url = icon_url
self.endpoint = endpoint
self.endpoint_version = None
self.all_settings = all_settings
self.parameters = parameters
self.manifest_url = manifest_url
self.msa_app_type = msa_app_type
self.msa_app_id = msa_app_id
self.msa_app_tenant_id = msa_app_tenant_id
self.msa_app_msi_resource_id = msa_app_msi_resource_id
self.configured_channels = None
self.enabled_channels = None
self.developer_app_insight_key = developer_app_insight_key
self.developer_app_insights_api_key = developer_app_insights_api_key
self.developer_app_insights_application_id = developer_app_insights_application_id
self.luis_app_ids = luis_app_ids
self.luis_key = luis_key
self.is_cmek_enabled = is_cmek_enabled
self.cmek_key_vault_url = cmek_key_vault_url
self.cmek_encryption_status = None
self.public_network_access = public_network_access
self.is_streaming_supported = is_streaming_supported
self.is_developer_app_insights_api_key_set = None
self.migration_token = None
self.disable_local_auth = disable_local_auth
self.schema_transformation_version = schema_transformation_version
self.storage_resource_id = storage_resource_id
self.private_endpoint_connections = None
self.open_with_hint = open_with_hint
self.app_password_hint = app_password_hint
self.provisioning_state = None
self.publishing_credentials = publishing_credentials
[docs]class BotResponseList(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.
:ivar next_link: The link used to get the next page of bot service resources.
:vartype next_link: str
:ivar value: Gets the list of bot service results and their properties.
:vartype value: list[~azure.mgmt.botservice.models.Bot]
"""
_validation = {
'value': {'readonly': True},
}
_attribute_map = {
'next_link': {'key': 'nextLink', 'type': 'str'},
'value': {'key': 'value', 'type': '[Bot]'},
}
def __init__(
self,
*,
next_link: Optional[str] = None,
**kwargs
):
"""
:keyword next_link: The link used to get the next page of bot service resources.
:paramtype next_link: str
"""
super(BotResponseList, self).__init__(**kwargs)
self.next_link = next_link
self.value = None
[docs]class ChannelResponseList(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.
:ivar next_link: The link used to get the next page of bot service channel resources.
:vartype next_link: str
:ivar value: Gets the list of bot service channel results and their properties.
:vartype value: list[~azure.mgmt.botservice.models.BotChannel]
"""
_validation = {
'value': {'readonly': True},
}
_attribute_map = {
'next_link': {'key': 'nextLink', 'type': 'str'},
'value': {'key': 'value', 'type': '[BotChannel]'},
}
def __init__(
self,
*,
next_link: Optional[str] = None,
**kwargs
):
"""
:keyword next_link: The link used to get the next page of bot service channel resources.
:paramtype next_link: str
"""
super(ChannelResponseList, self).__init__(**kwargs)
self.next_link = next_link
self.value = None
[docs]class ChannelSettings(msrest.serialization.Model):
"""Channel settings definition.
:ivar extension_key1: The extensionKey1.
:vartype extension_key1: str
:ivar extension_key2: The extensionKey2.
:vartype extension_key2: str
:ivar sites: The list of sites.
:vartype sites: list[~azure.mgmt.botservice.models.Site]
:ivar channel_id: The channel id.
:vartype channel_id: str
:ivar channel_display_name: The channel display name.
:vartype channel_display_name: str
:ivar bot_id: The bot id.
:vartype bot_id: str
:ivar bot_icon_url: The bot icon url.
:vartype bot_icon_url: str
:ivar is_enabled: Whether this channel is enabled for the bot.
:vartype is_enabled: bool
:ivar disable_local_auth: Opt-out of local authentication and ensure only MSI and AAD can be
used exclusively for authentication.
:vartype disable_local_auth: bool
"""
_attribute_map = {
'extension_key1': {'key': 'extensionKey1', 'type': 'str'},
'extension_key2': {'key': 'extensionKey2', 'type': 'str'},
'sites': {'key': 'sites', 'type': '[Site]'},
'channel_id': {'key': 'channelId', 'type': 'str'},
'channel_display_name': {'key': 'channelDisplayName', 'type': 'str'},
'bot_id': {'key': 'botId', 'type': 'str'},
'bot_icon_url': {'key': 'botIconUrl', 'type': 'str'},
'is_enabled': {'key': 'isEnabled', 'type': 'bool'},
'disable_local_auth': {'key': 'disableLocalAuth', 'type': 'bool'},
}
def __init__(
self,
*,
extension_key1: Optional[str] = None,
extension_key2: Optional[str] = None,
sites: Optional[List["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
):
"""
:keyword extension_key1: The extensionKey1.
:paramtype extension_key1: str
:keyword extension_key2: The extensionKey2.
:paramtype extension_key2: str
:keyword sites: The list of sites.
:paramtype sites: list[~azure.mgmt.botservice.models.Site]
:keyword channel_id: The channel id.
:paramtype channel_id: str
:keyword channel_display_name: The channel display name.
:paramtype channel_display_name: str
:keyword bot_id: The bot id.
:paramtype bot_id: str
:keyword bot_icon_url: The bot icon url.
:paramtype bot_icon_url: str
:keyword is_enabled: Whether this channel is enabled for the bot.
:paramtype is_enabled: bool
:keyword disable_local_auth: Opt-out of local authentication and ensure only MSI and AAD can be
used exclusively for authentication.
:paramtype disable_local_auth: bool
"""
super(ChannelSettings, self).__init__(**kwargs)
self.extension_key1 = extension_key1
self.extension_key2 = extension_key2
self.sites = sites
self.channel_id = channel_id
self.channel_display_name = channel_display_name
self.bot_id = bot_id
self.bot_icon_url = bot_icon_url
self.is_enabled = is_enabled
self.disable_local_auth = disable_local_auth
[docs]class CheckNameAvailabilityRequestBody(msrest.serialization.Model):
"""The request body for a request to Bot Service Management to check availability of a bot name.
:ivar name: the name of the bot for which availability needs to be checked.
:vartype name: str
:ivar type: the type of the bot for which availability needs to be checked.
:vartype type: str
"""
_attribute_map = {
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
}
def __init__(
self,
*,
name: Optional[str] = None,
type: Optional[str] = None,
**kwargs
):
"""
:keyword name: the name of the bot for which availability needs to be checked.
:paramtype name: str
:keyword type: the type of the bot for which availability needs to be checked.
:paramtype type: str
"""
super(CheckNameAvailabilityRequestBody, self).__init__(**kwargs)
self.name = name
self.type = type
[docs]class CheckNameAvailabilityResponseBody(msrest.serialization.Model):
"""The response body returned for a request to Bot Service Management to check availability of a bot name.
:ivar valid: indicates if the bot name is valid.
:vartype valid: bool
:ivar message: additional message from the bot management api showing why a bot name is not
available.
:vartype message: str
"""
_attribute_map = {
'valid': {'key': 'valid', 'type': 'bool'},
'message': {'key': 'message', 'type': 'str'},
}
def __init__(
self,
*,
valid: Optional[bool] = None,
message: Optional[str] = None,
**kwargs
):
"""
:keyword valid: indicates if the bot name is valid.
:paramtype valid: bool
:keyword message: additional message from the bot management api showing why a bot name is not
available.
:paramtype message: str
"""
super(CheckNameAvailabilityResponseBody, self).__init__(**kwargs)
self.valid = valid
self.message = message
[docs]class ConnectionItemName(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.
:ivar name: Connection Item name that has been added in the API.
:vartype name: str
"""
_validation = {
'name': {'readonly': True},
}
_attribute_map = {
'name': {'key': 'name', 'type': 'str'},
}
def __init__(
self,
**kwargs
):
"""
"""
super(ConnectionItemName, self).__init__(**kwargs)
self.name = None
[docs]class ConnectionSetting(Resource):
"""Bot channel resource definition.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar id: Specifies the resource ID.
:vartype id: str
:ivar name: Specifies the name of the resource.
:vartype name: str
:ivar location: Specifies the location of the resource.
:vartype location: str
:ivar type: Specifies the type of the resource.
:vartype type: str
:ivar tags: A set of tags. Contains resource tags defined as key/value pairs.
:vartype tags: dict[str, str]
:ivar sku: Gets or sets the SKU of the resource.
:vartype sku: ~azure.mgmt.botservice.models.Sku
:ivar kind: Required. Gets or sets the Kind of the resource. Possible values include: "sdk",
"designer", "bot", "function", "azurebot".
:vartype kind: str or ~azure.mgmt.botservice.models.Kind
:ivar etag: Entity Tag.
:vartype etag: str
:ivar zones: Entity zones.
:vartype zones: list[str]
:ivar properties: The set of properties specific to bot channel resource.
:vartype properties: ~azure.mgmt.botservice.models.ConnectionSettingProperties
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'zones': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'location': {'key': 'location', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'tags': {'key': 'tags', 'type': '{str}'},
'sku': {'key': 'sku', 'type': 'Sku'},
'kind': {'key': 'kind', 'type': 'str'},
'etag': {'key': 'etag', 'type': 'str'},
'zones': {'key': 'zones', 'type': '[str]'},
'properties': {'key': 'properties', 'type': 'ConnectionSettingProperties'},
}
def __init__(
self,
*,
location: Optional[str] = None,
tags: Optional[Dict[str, str]] = None,
sku: Optional["Sku"] = None,
kind: Optional[Union[str, "Kind"]] = None,
etag: Optional[str] = None,
properties: Optional["ConnectionSettingProperties"] = None,
**kwargs
):
"""
:keyword location: Specifies the location of the resource.
:paramtype location: str
:keyword tags: A set of tags. Contains resource tags defined as key/value pairs.
:paramtype tags: dict[str, str]
:keyword sku: Gets or sets the SKU of the resource.
:paramtype sku: ~azure.mgmt.botservice.models.Sku
:keyword kind: Required. Gets or sets the Kind of the resource. Possible values include: "sdk",
"designer", "bot", "function", "azurebot".
:paramtype kind: str or ~azure.mgmt.botservice.models.Kind
:keyword etag: Entity Tag.
:paramtype etag: str
:keyword properties: The set of properties specific to bot channel resource.
:paramtype properties: ~azure.mgmt.botservice.models.ConnectionSettingProperties
"""
super(ConnectionSetting, self).__init__(location=location, tags=tags, sku=sku, kind=kind, etag=etag, **kwargs)
self.properties = properties
[docs]class ConnectionSettingParameter(msrest.serialization.Model):
"""Extra Parameter in a Connection Setting Properties to indicate service provider specific properties.
:ivar key: Key for the Connection Setting Parameter.
:vartype key: str
:ivar value: Value associated with the Connection Setting Parameter.
:vartype value: str
"""
_attribute_map = {
'key': {'key': 'key', 'type': 'str'},
'value': {'key': 'value', 'type': 'str'},
}
def __init__(
self,
*,
key: Optional[str] = None,
value: Optional[str] = None,
**kwargs
):
"""
:keyword key: Key for the Connection Setting Parameter.
:paramtype key: str
:keyword value: Value associated with the Connection Setting Parameter.
:paramtype value: str
"""
super(ConnectionSettingParameter, self).__init__(**kwargs)
self.key = key
self.value = value
[docs]class ConnectionSettingProperties(msrest.serialization.Model):
"""Properties for a Connection Setting Item.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar id: Id associated with the Connection Setting.
:vartype id: str
:ivar name: Name associated with the Connection Setting.
:vartype name: str
:ivar client_id: Client Id associated with the Connection Setting.
:vartype client_id: str
:ivar setting_id: Setting Id set by the service for the Connection Setting.
:vartype setting_id: str
:ivar client_secret: Client Secret associated with the Connection Setting.
:vartype client_secret: str
:ivar scopes: Scopes associated with the Connection Setting.
:vartype scopes: str
:ivar service_provider_id: Service Provider Id associated with the Connection Setting.
:vartype service_provider_id: str
:ivar service_provider_display_name: Service Provider Display Name associated with the
Connection Setting.
:vartype service_provider_display_name: str
:ivar parameters: Service Provider Parameters associated with the Connection Setting.
:vartype parameters: list[~azure.mgmt.botservice.models.ConnectionSettingParameter]
:ivar provisioning_state: Provisioning state of the resource.
:vartype provisioning_state: str
"""
_validation = {
'setting_id': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'client_id': {'key': 'clientId', 'type': 'str'},
'setting_id': {'key': 'settingId', 'type': 'str'},
'client_secret': {'key': 'clientSecret', 'type': 'str'},
'scopes': {'key': 'scopes', 'type': 'str'},
'service_provider_id': {'key': 'serviceProviderId', 'type': 'str'},
'service_provider_display_name': {'key': 'serviceProviderDisplayName', 'type': 'str'},
'parameters': {'key': 'parameters', 'type': '[ConnectionSettingParameter]'},
'provisioning_state': {'key': 'provisioningState', 'type': 'str'},
}
def __init__(
self,
*,
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["ConnectionSettingParameter"]] = None,
provisioning_state: Optional[str] = None,
**kwargs
):
"""
:keyword id: Id associated with the Connection Setting.
:paramtype id: str
:keyword name: Name associated with the Connection Setting.
:paramtype name: str
:keyword client_id: Client Id associated with the Connection Setting.
:paramtype client_id: str
:keyword client_secret: Client Secret associated with the Connection Setting.
:paramtype client_secret: str
:keyword scopes: Scopes associated with the Connection Setting.
:paramtype scopes: str
:keyword service_provider_id: Service Provider Id associated with the Connection Setting.
:paramtype service_provider_id: str
:keyword service_provider_display_name: Service Provider Display Name associated with the
Connection Setting.
:paramtype service_provider_display_name: str
:keyword parameters: Service Provider Parameters associated with the Connection Setting.
:paramtype parameters: list[~azure.mgmt.botservice.models.ConnectionSettingParameter]
:keyword provisioning_state: Provisioning state of the resource.
:paramtype provisioning_state: str
"""
super(ConnectionSettingProperties, self).__init__(**kwargs)
self.id = id
self.name = name
self.client_id = client_id
self.setting_id = None
self.client_secret = client_secret
self.scopes = scopes
self.service_provider_id = service_provider_id
self.service_provider_display_name = service_provider_display_name
self.parameters = parameters
self.provisioning_state = provisioning_state
[docs]class ConnectionSettingResponseList(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.
:ivar next_link: The link used to get the next page of bot service connection setting
resources.
:vartype next_link: str
:ivar value: Gets the list of bot service connection settings and their properties.
:vartype value: list[~azure.mgmt.botservice.models.ConnectionSetting]
"""
_validation = {
'value': {'readonly': True},
}
_attribute_map = {
'next_link': {'key': 'nextLink', 'type': 'str'},
'value': {'key': 'value', 'type': '[ConnectionSetting]'},
}
def __init__(
self,
*,
next_link: Optional[str] = None,
**kwargs
):
"""
:keyword next_link: The link used to get the next page of bot service connection setting
resources.
:paramtype next_link: str
"""
super(ConnectionSettingResponseList, self).__init__(**kwargs)
self.next_link = next_link
self.value = None
[docs]class DirectLineChannel(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.
:ivar channel_name: Required. The channel name.Constant filled by server.
:vartype channel_name: str
:ivar etag: Entity Tag of the resource.
:vartype etag: str
:ivar provisioning_state: Provisioning state of the resource.
:vartype provisioning_state: str
:ivar location: Specifies the location of the resource.
:vartype location: str
:ivar properties: The set of properties specific to Direct Line channel resource.
:vartype properties: ~azure.mgmt.botservice.models.DirectLineChannelProperties
"""
_validation = {
'channel_name': {'required': True},
'provisioning_state': {'readonly': True},
}
_attribute_map = {
'channel_name': {'key': 'channelName', 'type': 'str'},
'etag': {'key': 'etag', 'type': 'str'},
'provisioning_state': {'key': 'provisioningState', 'type': 'str'},
'location': {'key': 'location', 'type': 'str'},
'properties': {'key': 'properties', 'type': 'DirectLineChannelProperties'},
}
def __init__(
self,
*,
etag: Optional[str] = None,
location: Optional[str] = "global",
properties: Optional["DirectLineChannelProperties"] = None,
**kwargs
):
"""
:keyword etag: Entity Tag of the resource.
:paramtype etag: str
:keyword location: Specifies the location of the resource.
:paramtype location: str
:keyword properties: The set of properties specific to Direct Line channel resource.
:paramtype properties: ~azure.mgmt.botservice.models.DirectLineChannelProperties
"""
super(DirectLineChannel, self).__init__(etag=etag, location=location, **kwargs)
self.channel_name = 'DirectLineChannel' # type: str
self.properties = properties
[docs]class DirectLineChannelProperties(msrest.serialization.Model):
"""The parameters to provide for the Direct Line channel.
:ivar sites: The list of Direct Line sites.
:vartype sites: list[~azure.mgmt.botservice.models.DirectLineSite]
:ivar direct_line_embed_code: Direct Line embed code of the resource.
:vartype direct_line_embed_code: str
"""
_attribute_map = {
'sites': {'key': 'sites', 'type': '[DirectLineSite]'},
'direct_line_embed_code': {'key': 'DirectLineEmbedCode', 'type': 'str'},
}
def __init__(
self,
*,
sites: Optional[List["DirectLineSite"]] = None,
direct_line_embed_code: Optional[str] = None,
**kwargs
):
"""
:keyword sites: The list of Direct Line sites.
:paramtype sites: list[~azure.mgmt.botservice.models.DirectLineSite]
:keyword direct_line_embed_code: Direct Line embed code of the resource.
:paramtype direct_line_embed_code: str
"""
super(DirectLineChannelProperties, self).__init__(**kwargs)
self.sites = sites
self.direct_line_embed_code = direct_line_embed_code
class DirectLineSite(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.
:ivar site_id: Site Id.
:vartype site_id: str
:ivar site_name: Required. Site name.
:vartype site_name: str
:ivar key: Primary key. Value only returned through POST to the action Channel List API,
otherwise empty.
:vartype key: str
:ivar key2: Secondary key. Value only returned through POST to the action Channel List API,
otherwise empty.
:vartype key2: str
:ivar is_enabled: Required. Whether this site is enabled for DirectLine channel.
:vartype is_enabled: bool
:ivar is_v1_enabled: Required. Whether this site is enabled for Bot Framework V1 protocol.
:vartype is_v1_enabled: bool
:ivar is_v3_enabled: Required. Whether this site is enabled for Bot Framework V1 protocol.
:vartype is_v3_enabled: bool
:ivar is_secure_site_enabled: Whether this site is enabled for authentication with Bot
Framework.
:vartype is_secure_site_enabled: bool
:ivar is_block_user_upload_enabled: Whether this site is enabled for block user upload.
:vartype is_block_user_upload_enabled: bool
:ivar trusted_origins: List of Trusted Origin URLs for this site. This field is applicable only
if isSecureSiteEnabled is True.
:vartype trusted_origins: list[str]
"""
_validation = {
'site_id': {'readonly': True},
'site_name': {'required': True},
'key': {'readonly': True},
'key2': {'readonly': True},
'is_enabled': {'required': True},
'is_v1_enabled': {'required': True},
'is_v3_enabled': {'required': True},
}
_attribute_map = {
'site_id': {'key': 'siteId', 'type': 'str'},
'site_name': {'key': 'siteName', 'type': 'str'},
'key': {'key': 'key', 'type': 'str'},
'key2': {'key': 'key2', 'type': 'str'},
'is_enabled': {'key': 'isEnabled', 'type': 'bool'},
'is_v1_enabled': {'key': 'isV1Enabled', 'type': 'bool'},
'is_v3_enabled': {'key': 'isV3Enabled', 'type': 'bool'},
'is_secure_site_enabled': {'key': 'isSecureSiteEnabled', 'type': 'bool'},
'is_block_user_upload_enabled': {'key': 'isBlockUserUploadEnabled', 'type': 'bool'},
'trusted_origins': {'key': 'trustedOrigins', 'type': '[str]'},
}
def __init__(
self,
*,
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
):
"""
:keyword site_name: Required. Site name.
:paramtype site_name: str
:keyword is_enabled: Required. Whether this site is enabled for DirectLine channel.
:paramtype is_enabled: bool
:keyword is_v1_enabled: Required. Whether this site is enabled for Bot Framework V1 protocol.
:paramtype is_v1_enabled: bool
:keyword is_v3_enabled: Required. Whether this site is enabled for Bot Framework V1 protocol.
:paramtype is_v3_enabled: bool
:keyword is_secure_site_enabled: Whether this site is enabled for authentication with Bot
Framework.
:paramtype is_secure_site_enabled: bool
:keyword is_block_user_upload_enabled: Whether this site is enabled for block user upload.
:paramtype is_block_user_upload_enabled: bool
:keyword trusted_origins: List of Trusted Origin URLs for this site. This field is applicable
only if isSecureSiteEnabled is True.
:paramtype trusted_origins: list[str]
"""
super(DirectLineSite, self).__init__(**kwargs)
self.site_id = None
self.site_name = site_name
self.key = None
self.key2 = None
self.is_enabled = is_enabled
self.is_v1_enabled = is_v1_enabled
self.is_v3_enabled = is_v3_enabled
self.is_secure_site_enabled = is_secure_site_enabled
self.is_block_user_upload_enabled = is_block_user_upload_enabled
self.trusted_origins = trusted_origins
[docs]class DirectLineSpeechChannel(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.
:ivar channel_name: Required. The channel name.Constant filled by server.
:vartype channel_name: str
:ivar etag: Entity Tag of the resource.
:vartype etag: str
:ivar provisioning_state: Provisioning state of the resource.
:vartype provisioning_state: str
:ivar location: Specifies the location of the resource.
:vartype location: str
:ivar properties: The set of properties specific to DirectLine Speech channel resource.
:vartype properties: ~azure.mgmt.botservice.models.DirectLineSpeechChannelProperties
"""
_validation = {
'channel_name': {'required': True},
'provisioning_state': {'readonly': True},
}
_attribute_map = {
'channel_name': {'key': 'channelName', 'type': 'str'},
'etag': {'key': 'etag', 'type': 'str'},
'provisioning_state': {'key': 'provisioningState', 'type': 'str'},
'location': {'key': 'location', 'type': 'str'},
'properties': {'key': 'properties', 'type': 'DirectLineSpeechChannelProperties'},
}
def __init__(
self,
*,
etag: Optional[str] = None,
location: Optional[str] = "global",
properties: Optional["DirectLineSpeechChannelProperties"] = None,
**kwargs
):
"""
:keyword etag: Entity Tag of the resource.
:paramtype etag: str
:keyword location: Specifies the location of the resource.
:paramtype location: str
:keyword properties: The set of properties specific to DirectLine Speech channel resource.
:paramtype properties: ~azure.mgmt.botservice.models.DirectLineSpeechChannelProperties
"""
super(DirectLineSpeechChannel, self).__init__(etag=etag, location=location, **kwargs)
self.channel_name = 'DirectLineSpeechChannel' # type: str
self.properties = properties
[docs]class DirectLineSpeechChannelProperties(msrest.serialization.Model):
"""The parameters to provide for the DirectLine Speech channel.
All required parameters must be populated in order to send to Azure.
:ivar cognitive_service_region: Required. The cognitive service region with this channel
registration.
:vartype cognitive_service_region: str
:ivar cognitive_service_subscription_key: Required. The cognitive service subscription key to
use with this channel registration.
:vartype cognitive_service_subscription_key: str
:ivar is_enabled: Whether this channel is enabled or not.
:vartype is_enabled: bool
:ivar custom_voice_deployment_id: Custom speech model id (optional).
:vartype custom_voice_deployment_id: str
:ivar custom_speech_model_id: Custom voice deployment id (optional).
:vartype custom_speech_model_id: str
:ivar is_default_bot_for_cog_svc_account: Make this a default bot for chosen cognitive service
account.
:vartype is_default_bot_for_cog_svc_account: bool
"""
_validation = {
'cognitive_service_region': {'required': True},
'cognitive_service_subscription_key': {'required': True},
}
_attribute_map = {
'cognitive_service_region': {'key': 'cognitiveServiceRegion', 'type': 'str'},
'cognitive_service_subscription_key': {'key': 'cognitiveServiceSubscriptionKey', 'type': 'str'},
'is_enabled': {'key': 'isEnabled', 'type': 'bool'},
'custom_voice_deployment_id': {'key': 'customVoiceDeploymentId', 'type': 'str'},
'custom_speech_model_id': {'key': 'customSpeechModelId', 'type': 'str'},
'is_default_bot_for_cog_svc_account': {'key': 'isDefaultBotForCogSvcAccount', 'type': 'bool'},
}
def __init__(
self,
*,
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
):
"""
:keyword cognitive_service_region: Required. The cognitive service region with this channel
registration.
:paramtype cognitive_service_region: str
:keyword cognitive_service_subscription_key: Required. The cognitive service subscription key
to use with this channel registration.
:paramtype cognitive_service_subscription_key: str
:keyword is_enabled: Whether this channel is enabled or not.
:paramtype is_enabled: bool
:keyword custom_voice_deployment_id: Custom speech model id (optional).
:paramtype custom_voice_deployment_id: str
:keyword custom_speech_model_id: Custom voice deployment id (optional).
:paramtype custom_speech_model_id: str
:keyword is_default_bot_for_cog_svc_account: Make this a default bot for chosen cognitive
service account.
:paramtype is_default_bot_for_cog_svc_account: bool
"""
super(DirectLineSpeechChannelProperties, self).__init__(**kwargs)
self.cognitive_service_region = cognitive_service_region
self.cognitive_service_subscription_key = cognitive_service_subscription_key
self.is_enabled = is_enabled
self.custom_voice_deployment_id = custom_voice_deployment_id
self.custom_speech_model_id = custom_speech_model_id
self.is_default_bot_for_cog_svc_account = is_default_bot_for_cog_svc_account
[docs]class EmailChannel(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.
:ivar channel_name: Required. The channel name.Constant filled by server.
:vartype channel_name: str
:ivar etag: Entity Tag of the resource.
:vartype etag: str
:ivar provisioning_state: Provisioning state of the resource.
:vartype provisioning_state: str
:ivar location: Specifies the location of the resource.
:vartype location: str
:ivar properties: The set of properties specific to email channel resource.
:vartype properties: ~azure.mgmt.botservice.models.EmailChannelProperties
"""
_validation = {
'channel_name': {'required': True},
'provisioning_state': {'readonly': True},
}
_attribute_map = {
'channel_name': {'key': 'channelName', 'type': 'str'},
'etag': {'key': 'etag', 'type': 'str'},
'provisioning_state': {'key': 'provisioningState', 'type': 'str'},
'location': {'key': 'location', 'type': 'str'},
'properties': {'key': 'properties', 'type': 'EmailChannelProperties'},
}
def __init__(
self,
*,
etag: Optional[str] = None,
location: Optional[str] = "global",
properties: Optional["EmailChannelProperties"] = None,
**kwargs
):
"""
:keyword etag: Entity Tag of the resource.
:paramtype etag: str
:keyword location: Specifies the location of the resource.
:paramtype location: str
:keyword properties: The set of properties specific to email channel resource.
:paramtype properties: ~azure.mgmt.botservice.models.EmailChannelProperties
"""
super(EmailChannel, self).__init__(etag=etag, location=location, **kwargs)
self.channel_name = 'EmailChannel' # type: str
self.properties = properties
[docs]class EmailChannelProperties(msrest.serialization.Model):
"""The parameters to provide for the Email channel.
All required parameters must be populated in order to send to Azure.
:ivar email_address: Required. The email address.
:vartype email_address: str
:ivar password: The password for the email address. Value only returned through POST to the
action Channel List API, otherwise empty.
:vartype password: str
:ivar is_enabled: Required. Whether this channel is enabled for the bot.
:vartype is_enabled: bool
"""
_validation = {
'email_address': {'required': True},
'is_enabled': {'required': True},
}
_attribute_map = {
'email_address': {'key': 'emailAddress', 'type': 'str'},
'password': {'key': 'password', 'type': 'str'},
'is_enabled': {'key': 'isEnabled', 'type': 'bool'},
}
def __init__(
self,
*,
email_address: str,
is_enabled: bool,
password: Optional[str] = None,
**kwargs
):
"""
:keyword email_address: Required. The email address.
:paramtype email_address: str
:keyword password: The password for the email address. Value only returned through POST to the
action Channel List API, otherwise empty.
:paramtype password: str
:keyword is_enabled: Required. Whether this channel is enabled for the bot.
:paramtype is_enabled: bool
"""
super(EmailChannelProperties, self).__init__(**kwargs)
self.email_address = email_address
self.password = password
self.is_enabled = is_enabled
[docs]class Error(msrest.serialization.Model):
"""Bot Service error object.
:ivar error: The error body.
:vartype error: ~azure.mgmt.botservice.models.ErrorBody
"""
_attribute_map = {
'error': {'key': 'error', 'type': 'ErrorBody'},
}
def __init__(
self,
*,
error: Optional["ErrorBody"] = None,
**kwargs
):
"""
:keyword error: The error body.
:paramtype error: ~azure.mgmt.botservice.models.ErrorBody
"""
super(Error, self).__init__(**kwargs)
self.error = error
[docs]class ErrorBody(msrest.serialization.Model):
"""Bot Service error body.
All required parameters must be populated in order to send to Azure.
:ivar code: Required. error code.
:vartype code: str
:ivar message: Required. error message.
:vartype message: str
"""
_validation = {
'code': {'required': True},
'message': {'required': True},
}
_attribute_map = {
'code': {'key': 'code', 'type': 'str'},
'message': {'key': 'message', 'type': 'str'},
}
def __init__(
self,
*,
code: str,
message: str,
**kwargs
):
"""
:keyword code: Required. error code.
:paramtype code: str
:keyword message: Required. error message.
:paramtype message: str
"""
super(ErrorBody, self).__init__(**kwargs)
self.code = code
self.message = message
[docs]class FacebookChannel(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.
:ivar channel_name: Required. The channel name.Constant filled by server.
:vartype channel_name: str
:ivar etag: Entity Tag of the resource.
:vartype etag: str
:ivar provisioning_state: Provisioning state of the resource.
:vartype provisioning_state: str
:ivar location: Specifies the location of the resource.
:vartype location: str
:ivar properties: The set of properties specific to bot facebook channel.
:vartype properties: ~azure.mgmt.botservice.models.FacebookChannelProperties
"""
_validation = {
'channel_name': {'required': True},
'provisioning_state': {'readonly': True},
}
_attribute_map = {
'channel_name': {'key': 'channelName', 'type': 'str'},
'etag': {'key': 'etag', 'type': 'str'},
'provisioning_state': {'key': 'provisioningState', 'type': 'str'},
'location': {'key': 'location', 'type': 'str'},
'properties': {'key': 'properties', 'type': 'FacebookChannelProperties'},
}
def __init__(
self,
*,
etag: Optional[str] = None,
location: Optional[str] = "global",
properties: Optional["FacebookChannelProperties"] = None,
**kwargs
):
"""
:keyword etag: Entity Tag of the resource.
:paramtype etag: str
:keyword location: Specifies the location of the resource.
:paramtype location: str
:keyword properties: The set of properties specific to bot facebook channel.
:paramtype properties: ~azure.mgmt.botservice.models.FacebookChannelProperties
"""
super(FacebookChannel, self).__init__(etag=etag, location=location, **kwargs)
self.channel_name = 'FacebookChannel' # type: str
self.properties = properties
[docs]class FacebookChannelProperties(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.
:ivar verify_token: Verify token. Value only returned through POST to the action Channel List
API, otherwise empty.
:vartype verify_token: str
:ivar pages: The list of Facebook pages.
:vartype pages: list[~azure.mgmt.botservice.models.FacebookPage]
:ivar app_id: Required. Facebook application id.
:vartype app_id: str
:ivar app_secret: Facebook application secret. Value only returned through POST to the action
Channel List API, otherwise empty.
:vartype app_secret: str
:ivar callback_url: Callback Url.
:vartype callback_url: str
:ivar is_enabled: Required. Whether this channel is enabled for the bot.
:vartype is_enabled: bool
"""
_validation = {
'verify_token': {'readonly': True},
'app_id': {'required': True},
'callback_url': {'readonly': True},
'is_enabled': {'required': True},
}
_attribute_map = {
'verify_token': {'key': 'verifyToken', 'type': 'str'},
'pages': {'key': 'pages', 'type': '[FacebookPage]'},
'app_id': {'key': 'appId', 'type': 'str'},
'app_secret': {'key': 'appSecret', 'type': 'str'},
'callback_url': {'key': 'callbackUrl', 'type': 'str'},
'is_enabled': {'key': 'isEnabled', 'type': 'bool'},
}
def __init__(
self,
*,
app_id: str,
is_enabled: bool,
pages: Optional[List["FacebookPage"]] = None,
app_secret: Optional[str] = None,
**kwargs
):
"""
:keyword pages: The list of Facebook pages.
:paramtype pages: list[~azure.mgmt.botservice.models.FacebookPage]
:keyword app_id: Required. Facebook application id.
:paramtype app_id: str
:keyword app_secret: Facebook application secret. Value only returned through POST to the
action Channel List API, otherwise empty.
:paramtype app_secret: str
:keyword is_enabled: Required. Whether this channel is enabled for the bot.
:paramtype is_enabled: bool
"""
super(FacebookChannelProperties, self).__init__(**kwargs)
self.verify_token = None
self.pages = pages
self.app_id = app_id
self.app_secret = app_secret
self.callback_url = None
self.is_enabled = is_enabled
[docs]class FacebookPage(msrest.serialization.Model):
"""A Facebook page for Facebook channel registration.
All required parameters must be populated in order to send to Azure.
:ivar id: Required. Page id.
:vartype id: str
:ivar access_token: Facebook application access token. Value only returned through POST to the
action Channel List API, otherwise empty.
:vartype access_token: str
"""
_validation = {
'id': {'required': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'access_token': {'key': 'accessToken', 'type': 'str'},
}
def __init__(
self,
*,
id: str,
access_token: Optional[str] = None,
**kwargs
):
"""
:keyword id: Required. Page id.
:paramtype id: str
:keyword access_token: Facebook application access token. Value only returned through POST to
the action Channel List API, otherwise empty.
:paramtype access_token: str
"""
super(FacebookPage, self).__init__(**kwargs)
self.id = id
self.access_token = access_token
[docs]class HostSettingsResponse(msrest.serialization.Model):
"""The response body returned for a request to Bot Service Management to check per subscription hostSettings.
:ivar o_auth_url: For in-conversation bot user authentication.
:vartype o_auth_url: str
:ivar to_bot_from_channel_open_id_metadata_url: For verifying incoming tokens from the
channels.
:vartype to_bot_from_channel_open_id_metadata_url: str
:ivar to_bot_from_channel_token_issuer: For verifying incoming tokens from the channels.
:vartype to_bot_from_channel_token_issuer: str
:ivar to_bot_from_emulator_open_id_metadata_url: For verifying incoming tokens from bot
emulator.
:vartype to_bot_from_emulator_open_id_metadata_url: str
:ivar to_channel_from_bot_login_url: For getting access token to channels from bot host.
:vartype to_channel_from_bot_login_url: str
:ivar to_channel_from_bot_o_auth_scope: For getting access token to channels from bot host.
:vartype to_channel_from_bot_o_auth_scope: str
:ivar validate_authority: Per cloud OAuth setting on whether authority is validated.
:vartype validate_authority: bool
:ivar bot_open_id_metadata: Same as toBotFromChannelOpenIdMetadataUrl, used by SDK < v4.12.
:vartype bot_open_id_metadata: str
"""
_attribute_map = {
'o_auth_url': {'key': 'OAuthUrl', 'type': 'str'},
'to_bot_from_channel_open_id_metadata_url': {'key': 'ToBotFromChannelOpenIdMetadataUrl', 'type': 'str'},
'to_bot_from_channel_token_issuer': {'key': 'ToBotFromChannelTokenIssuer', 'type': 'str'},
'to_bot_from_emulator_open_id_metadata_url': {'key': 'ToBotFromEmulatorOpenIdMetadataUrl', 'type': 'str'},
'to_channel_from_bot_login_url': {'key': 'ToChannelFromBotLoginUrl', 'type': 'str'},
'to_channel_from_bot_o_auth_scope': {'key': 'ToChannelFromBotOAuthScope', 'type': 'str'},
'validate_authority': {'key': 'ValidateAuthority', 'type': 'bool'},
'bot_open_id_metadata': {'key': 'BotOpenIdMetadata', 'type': 'str'},
}
def __init__(
self,
*,
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
):
"""
:keyword o_auth_url: For in-conversation bot user authentication.
:paramtype o_auth_url: str
:keyword to_bot_from_channel_open_id_metadata_url: For verifying incoming tokens from the
channels.
:paramtype to_bot_from_channel_open_id_metadata_url: str
:keyword to_bot_from_channel_token_issuer: For verifying incoming tokens from the channels.
:paramtype to_bot_from_channel_token_issuer: str
:keyword to_bot_from_emulator_open_id_metadata_url: For verifying incoming tokens from bot
emulator.
:paramtype to_bot_from_emulator_open_id_metadata_url: str
:keyword to_channel_from_bot_login_url: For getting access token to channels from bot host.
:paramtype to_channel_from_bot_login_url: str
:keyword to_channel_from_bot_o_auth_scope: For getting access token to channels from bot host.
:paramtype to_channel_from_bot_o_auth_scope: str
:keyword validate_authority: Per cloud OAuth setting on whether authority is validated.
:paramtype validate_authority: bool
:keyword bot_open_id_metadata: Same as toBotFromChannelOpenIdMetadataUrl, used by SDK < v4.12.
:paramtype bot_open_id_metadata: str
"""
super(HostSettingsResponse, self).__init__(**kwargs)
self.o_auth_url = o_auth_url
self.to_bot_from_channel_open_id_metadata_url = to_bot_from_channel_open_id_metadata_url
self.to_bot_from_channel_token_issuer = to_bot_from_channel_token_issuer
self.to_bot_from_emulator_open_id_metadata_url = to_bot_from_emulator_open_id_metadata_url
self.to_channel_from_bot_login_url = to_channel_from_bot_login_url
self.to_channel_from_bot_o_auth_scope = to_channel_from_bot_o_auth_scope
self.validate_authority = validate_authority
self.bot_open_id_metadata = bot_open_id_metadata
[docs]class KikChannel(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.
:ivar channel_name: Required. The channel name.Constant filled by server.
:vartype channel_name: str
:ivar etag: Entity Tag of the resource.
:vartype etag: str
:ivar provisioning_state: Provisioning state of the resource.
:vartype provisioning_state: str
:ivar location: Specifies the location of the resource.
:vartype location: str
:ivar properties: The set of properties specific to Kik channel resource.
:vartype properties: ~azure.mgmt.botservice.models.KikChannelProperties
"""
_validation = {
'channel_name': {'required': True},
'provisioning_state': {'readonly': True},
}
_attribute_map = {
'channel_name': {'key': 'channelName', 'type': 'str'},
'etag': {'key': 'etag', 'type': 'str'},
'provisioning_state': {'key': 'provisioningState', 'type': 'str'},
'location': {'key': 'location', 'type': 'str'},
'properties': {'key': 'properties', 'type': 'KikChannelProperties'},
}
def __init__(
self,
*,
etag: Optional[str] = None,
location: Optional[str] = "global",
properties: Optional["KikChannelProperties"] = None,
**kwargs
):
"""
:keyword etag: Entity Tag of the resource.
:paramtype etag: str
:keyword location: Specifies the location of the resource.
:paramtype location: str
:keyword properties: The set of properties specific to Kik channel resource.
:paramtype properties: ~azure.mgmt.botservice.models.KikChannelProperties
"""
super(KikChannel, self).__init__(etag=etag, location=location, **kwargs)
self.channel_name = 'KikChannel' # type: str
self.properties = properties
[docs]class KikChannelProperties(msrest.serialization.Model):
"""The parameters to provide for the Kik channel.
All required parameters must be populated in order to send to Azure.
:ivar user_name: Required. The Kik user name.
:vartype user_name: str
:ivar api_key: Kik API key. Value only returned through POST to the action Channel List API,
otherwise empty.
:vartype api_key: str
:ivar is_validated: Whether this channel is validated for the bot.
:vartype is_validated: bool
:ivar is_enabled: Required. Whether this channel is enabled for the bot.
:vartype is_enabled: bool
"""
_validation = {
'user_name': {'required': True},
'is_enabled': {'required': True},
}
_attribute_map = {
'user_name': {'key': 'userName', 'type': 'str'},
'api_key': {'key': 'apiKey', 'type': 'str'},
'is_validated': {'key': 'isValidated', 'type': 'bool'},
'is_enabled': {'key': 'isEnabled', 'type': 'bool'},
}
def __init__(
self,
*,
user_name: str,
is_enabled: bool,
api_key: Optional[str] = None,
is_validated: Optional[bool] = None,
**kwargs
):
"""
:keyword user_name: Required. The Kik user name.
:paramtype user_name: str
:keyword api_key: Kik API key. Value only returned through POST to the action Channel List API,
otherwise empty.
:paramtype api_key: str
:keyword is_validated: Whether this channel is validated for the bot.
:paramtype is_validated: bool
:keyword is_enabled: Required. Whether this channel is enabled for the bot.
:paramtype is_enabled: bool
"""
super(KikChannelProperties, self).__init__(**kwargs)
self.user_name = user_name
self.api_key = api_key
self.is_validated = is_validated
self.is_enabled = is_enabled
[docs]class LineChannel(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.
:ivar channel_name: Required. The channel name.Constant filled by server.
:vartype channel_name: str
:ivar etag: Entity Tag of the resource.
:vartype etag: str
:ivar provisioning_state: Provisioning state of the resource.
:vartype provisioning_state: str
:ivar location: Specifies the location of the resource.
:vartype location: str
:ivar properties: The set of properties specific to line channel resource.
:vartype properties: ~azure.mgmt.botservice.models.LineChannelProperties
"""
_validation = {
'channel_name': {'required': True},
'provisioning_state': {'readonly': True},
}
_attribute_map = {
'channel_name': {'key': 'channelName', 'type': 'str'},
'etag': {'key': 'etag', 'type': 'str'},
'provisioning_state': {'key': 'provisioningState', 'type': 'str'},
'location': {'key': 'location', 'type': 'str'},
'properties': {'key': 'properties', 'type': 'LineChannelProperties'},
}
def __init__(
self,
*,
etag: Optional[str] = None,
location: Optional[str] = "global",
properties: Optional["LineChannelProperties"] = None,
**kwargs
):
"""
:keyword etag: Entity Tag of the resource.
:paramtype etag: str
:keyword location: Specifies the location of the resource.
:paramtype location: str
:keyword properties: The set of properties specific to line channel resource.
:paramtype properties: ~azure.mgmt.botservice.models.LineChannelProperties
"""
super(LineChannel, self).__init__(etag=etag, location=location, **kwargs)
self.channel_name = 'LineChannel' # type: str
self.properties = properties
[docs]class LineChannelProperties(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.
:ivar line_registrations: Required. The list of line channel registrations.
:vartype line_registrations: list[~azure.mgmt.botservice.models.LineRegistration]
:ivar callback_url: Callback Url to enter in line registration.
:vartype callback_url: str
:ivar is_validated: Whether this channel is validated for the bot.
:vartype is_validated: bool
"""
_validation = {
'line_registrations': {'required': True},
'callback_url': {'readonly': True},
'is_validated': {'readonly': True},
}
_attribute_map = {
'line_registrations': {'key': 'lineRegistrations', 'type': '[LineRegistration]'},
'callback_url': {'key': 'callbackUrl', 'type': 'str'},
'is_validated': {'key': 'isValidated', 'type': 'bool'},
}
def __init__(
self,
*,
line_registrations: List["LineRegistration"],
**kwargs
):
"""
:keyword line_registrations: Required. The list of line channel registrations.
:paramtype line_registrations: list[~azure.mgmt.botservice.models.LineRegistration]
"""
super(LineChannelProperties, self).__init__(**kwargs)
self.line_registrations = line_registrations
self.callback_url = None
self.is_validated = None
[docs]class LineRegistration(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.
:ivar generated_id: Id generated for the line channel registration.
:vartype generated_id: str
:ivar channel_secret: Secret for the line channel registration.
:vartype channel_secret: str
:ivar channel_access_token: Access token for the line channel registration.
:vartype channel_access_token: str
"""
_validation = {
'generated_id': {'readonly': True},
}
_attribute_map = {
'generated_id': {'key': 'generatedId', 'type': 'str'},
'channel_secret': {'key': 'channelSecret', 'type': 'str'},
'channel_access_token': {'key': 'channelAccessToken', 'type': 'str'},
}
def __init__(
self,
*,
channel_secret: Optional[str] = None,
channel_access_token: Optional[str] = None,
**kwargs
):
"""
:keyword channel_secret: Secret for the line channel registration.
:paramtype channel_secret: str
:keyword channel_access_token: Access token for the line channel registration.
:paramtype channel_access_token: str
"""
super(LineRegistration, self).__init__(**kwargs)
self.generated_id = None
self.channel_secret = channel_secret
self.channel_access_token = channel_access_token
[docs]class ListChannelWithKeysResponse(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.
:ivar id: Specifies the resource ID.
:vartype id: str
:ivar name: Specifies the name of the resource.
:vartype name: str
:ivar location: Specifies the location of the resource.
:vartype location: str
:ivar type: Specifies the type of the resource.
:vartype type: str
:ivar tags: A set of tags. Contains resource tags defined as key/value pairs.
:vartype tags: dict[str, str]
:ivar sku: Gets or sets the SKU of the resource.
:vartype sku: ~azure.mgmt.botservice.models.Sku
:ivar kind: Required. Gets or sets the Kind of the resource. Possible values include: "sdk",
"designer", "bot", "function", "azurebot".
:vartype kind: str or ~azure.mgmt.botservice.models.Kind
:ivar etag: Entity Tag.
:vartype etag: str
:ivar zones: Entity zones.
:vartype zones: list[str]
:ivar properties: The set of properties specific to bot channel resource.
:vartype properties: ~azure.mgmt.botservice.models.Channel
:ivar resource: The set of properties specific to bot channel resource.
:vartype resource: ~azure.mgmt.botservice.models.Channel
:ivar setting: Channel settings.
:vartype setting: ~azure.mgmt.botservice.models.ChannelSettings
:ivar provisioning_state: Provisioning state of the resource.
:vartype provisioning_state: str
:ivar entity_tag: Entity tag of the resource.
:vartype entity_tag: str
:ivar changed_time: Changed time of the resource.
:vartype changed_time: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'zones': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'location': {'key': 'location', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'tags': {'key': 'tags', 'type': '{str}'},
'sku': {'key': 'sku', 'type': 'Sku'},
'kind': {'key': 'kind', 'type': 'str'},
'etag': {'key': 'etag', 'type': 'str'},
'zones': {'key': 'zones', 'type': '[str]'},
'properties': {'key': 'properties', 'type': 'Channel'},
'resource': {'key': 'resource', 'type': 'Channel'},
'setting': {'key': 'setting', 'type': 'ChannelSettings'},
'provisioning_state': {'key': 'provisioningState', 'type': 'str'},
'entity_tag': {'key': 'entityTag', 'type': 'str'},
'changed_time': {'key': 'changedTime', 'type': 'str'},
}
def __init__(
self,
*,
location: Optional[str] = None,
tags: Optional[Dict[str, str]] = None,
sku: Optional["Sku"] = None,
kind: Optional[Union[str, "Kind"]] = None,
etag: Optional[str] = None,
properties: Optional["Channel"] = None,
resource: Optional["Channel"] = None,
setting: Optional["ChannelSettings"] = None,
provisioning_state: Optional[str] = None,
entity_tag: Optional[str] = None,
changed_time: Optional[str] = None,
**kwargs
):
"""
:keyword location: Specifies the location of the resource.
:paramtype location: str
:keyword tags: A set of tags. Contains resource tags defined as key/value pairs.
:paramtype tags: dict[str, str]
:keyword sku: Gets or sets the SKU of the resource.
:paramtype sku: ~azure.mgmt.botservice.models.Sku
:keyword kind: Required. Gets or sets the Kind of the resource. Possible values include: "sdk",
"designer", "bot", "function", "azurebot".
:paramtype kind: str or ~azure.mgmt.botservice.models.Kind
:keyword etag: Entity Tag.
:paramtype etag: str
:keyword properties: The set of properties specific to bot channel resource.
:paramtype properties: ~azure.mgmt.botservice.models.Channel
:keyword resource: The set of properties specific to bot channel resource.
:paramtype resource: ~azure.mgmt.botservice.models.Channel
:keyword setting: Channel settings.
:paramtype setting: ~azure.mgmt.botservice.models.ChannelSettings
:keyword provisioning_state: Provisioning state of the resource.
:paramtype provisioning_state: str
:keyword entity_tag: Entity tag of the resource.
:paramtype entity_tag: str
:keyword changed_time: Changed time of the resource.
:paramtype changed_time: str
"""
super(ListChannelWithKeysResponse, self).__init__(location=location, tags=tags, sku=sku, kind=kind, etag=etag, properties=properties, **kwargs)
self.resource = resource
self.setting = setting
self.provisioning_state = provisioning_state
self.entity_tag = entity_tag
self.changed_time = changed_time
[docs]class MsTeamsChannel(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.
:ivar channel_name: Required. The channel name.Constant filled by server.
:vartype channel_name: str
:ivar etag: Entity Tag of the resource.
:vartype etag: str
:ivar provisioning_state: Provisioning state of the resource.
:vartype provisioning_state: str
:ivar location: Specifies the location of the resource.
:vartype location: str
:ivar properties: The set of properties specific to Microsoft Teams channel resource.
:vartype properties: ~azure.mgmt.botservice.models.MsTeamsChannelProperties
"""
_validation = {
'channel_name': {'required': True},
'provisioning_state': {'readonly': True},
}
_attribute_map = {
'channel_name': {'key': 'channelName', 'type': 'str'},
'etag': {'key': 'etag', 'type': 'str'},
'provisioning_state': {'key': 'provisioningState', 'type': 'str'},
'location': {'key': 'location', 'type': 'str'},
'properties': {'key': 'properties', 'type': 'MsTeamsChannelProperties'},
}
def __init__(
self,
*,
etag: Optional[str] = None,
location: Optional[str] = "global",
properties: Optional["MsTeamsChannelProperties"] = None,
**kwargs
):
"""
:keyword etag: Entity Tag of the resource.
:paramtype etag: str
:keyword location: Specifies the location of the resource.
:paramtype location: str
:keyword properties: The set of properties specific to Microsoft Teams channel resource.
:paramtype properties: ~azure.mgmt.botservice.models.MsTeamsChannelProperties
"""
super(MsTeamsChannel, self).__init__(etag=etag, location=location, **kwargs)
self.channel_name = 'MsTeamsChannel' # type: str
self.properties = properties
[docs]class MsTeamsChannelProperties(msrest.serialization.Model):
"""The parameters to provide for the Microsoft Teams channel.
All required parameters must be populated in order to send to Azure.
:ivar enable_calling: Enable calling for Microsoft Teams channel.
:vartype enable_calling: bool
:ivar calling_web_hook: Webhook for Microsoft Teams channel calls.
:vartype calling_web_hook: str
:ivar is_enabled: Required. Whether this channel is enabled for the bot.
:vartype is_enabled: bool
:ivar incoming_call_route: Webhook for Microsoft Teams channel calls.
:vartype incoming_call_route: str
:ivar deployment_environment: Deployment environment for Microsoft Teams channel calls.
:vartype deployment_environment: str
:ivar accepted_terms: Whether this channel accepted terms.
:vartype accepted_terms: bool
"""
_validation = {
'is_enabled': {'required': True},
}
_attribute_map = {
'enable_calling': {'key': 'enableCalling', 'type': 'bool'},
'calling_web_hook': {'key': 'callingWebHook', 'type': 'str'},
'is_enabled': {'key': 'isEnabled', 'type': 'bool'},
'incoming_call_route': {'key': 'incomingCallRoute', 'type': 'str'},
'deployment_environment': {'key': 'deploymentEnvironment', 'type': 'str'},
'accepted_terms': {'key': 'acceptedTerms', 'type': 'bool'},
}
def __init__(
self,
*,
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
):
"""
:keyword enable_calling: Enable calling for Microsoft Teams channel.
:paramtype enable_calling: bool
:keyword calling_web_hook: Webhook for Microsoft Teams channel calls.
:paramtype calling_web_hook: str
:keyword is_enabled: Required. Whether this channel is enabled for the bot.
:paramtype is_enabled: bool
:keyword incoming_call_route: Webhook for Microsoft Teams channel calls.
:paramtype incoming_call_route: str
:keyword deployment_environment: Deployment environment for Microsoft Teams channel calls.
:paramtype deployment_environment: str
:keyword accepted_terms: Whether this channel accepted terms.
:paramtype accepted_terms: bool
"""
super(MsTeamsChannelProperties, self).__init__(**kwargs)
self.enable_calling = enable_calling
self.calling_web_hook = calling_web_hook
self.is_enabled = is_enabled
self.incoming_call_route = incoming_call_route
self.deployment_environment = deployment_environment
self.accepted_terms = accepted_terms
[docs]class OperationDisplayInfo(msrest.serialization.Model):
"""The operation supported by Bot Service Management.
:ivar description: The description of the operation.
:vartype description: str
:ivar operation: The action that users can perform, based on their permission level.
:vartype operation: str
:ivar provider: Service provider: Microsoft Bot Service.
:vartype provider: str
:ivar resource: Resource on which the operation is performed.
:vartype resource: str
"""
_attribute_map = {
'description': {'key': 'description', 'type': 'str'},
'operation': {'key': 'operation', 'type': 'str'},
'provider': {'key': 'provider', 'type': 'str'},
'resource': {'key': 'resource', 'type': 'str'},
}
def __init__(
self,
*,
description: Optional[str] = None,
operation: Optional[str] = None,
provider: Optional[str] = None,
resource: Optional[str] = None,
**kwargs
):
"""
:keyword description: The description of the operation.
:paramtype description: str
:keyword operation: The action that users can perform, based on their permission level.
:paramtype operation: str
:keyword provider: Service provider: Microsoft Bot Service.
:paramtype provider: str
:keyword resource: Resource on which the operation is performed.
:paramtype resource: str
"""
super(OperationDisplayInfo, self).__init__(**kwargs)
self.description = description
self.operation = operation
self.provider = provider
self.resource = resource
[docs]class OperationEntity(msrest.serialization.Model):
"""The operations supported by Bot Service Management.
:ivar name: Operation name: {provider}/{resource}/{operation}.
:vartype name: str
:ivar display: The operation supported by Bot Service Management.
:vartype display: ~azure.mgmt.botservice.models.OperationDisplayInfo
:ivar origin: The origin of the operation.
:vartype origin: str
:ivar properties: Additional properties.
:vartype properties: any
"""
_attribute_map = {
'name': {'key': 'name', 'type': 'str'},
'display': {'key': 'display', 'type': 'OperationDisplayInfo'},
'origin': {'key': 'origin', 'type': 'str'},
'properties': {'key': 'properties', 'type': 'object'},
}
def __init__(
self,
*,
name: Optional[str] = None,
display: Optional["OperationDisplayInfo"] = None,
origin: Optional[str] = None,
properties: Optional[Any] = None,
**kwargs
):
"""
:keyword name: Operation name: {provider}/{resource}/{operation}.
:paramtype name: str
:keyword display: The operation supported by Bot Service Management.
:paramtype display: ~azure.mgmt.botservice.models.OperationDisplayInfo
:keyword origin: The origin of the operation.
:paramtype origin: str
:keyword properties: Additional properties.
:paramtype properties: any
"""
super(OperationEntity, self).__init__(**kwargs)
self.name = name
self.display = display
self.origin = origin
self.properties = properties
[docs]class OperationEntityListResult(msrest.serialization.Model):
"""The list of bot service operation response.
:ivar next_link: The link used to get the next page of operations.
:vartype next_link: str
:ivar value: The list of operations.
:vartype value: list[~azure.mgmt.botservice.models.OperationEntity]
"""
_attribute_map = {
'next_link': {'key': 'nextLink', 'type': 'str'},
'value': {'key': 'value', 'type': '[OperationEntity]'},
}
def __init__(
self,
*,
next_link: Optional[str] = None,
value: Optional[List["OperationEntity"]] = None,
**kwargs
):
"""
:keyword next_link: The link used to get the next page of operations.
:paramtype next_link: str
:keyword value: The list of operations.
:paramtype value: list[~azure.mgmt.botservice.models.OperationEntity]
"""
super(OperationEntityListResult, self).__init__(**kwargs)
self.next_link = next_link
self.value = value
[docs]class OperationResultsDescription(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.
:ivar id: The ID of the operation returned.
:vartype id: str
:ivar name: The name of the operation result.
:vartype name: str
:ivar status: The status of the operation being performed. Possible values include: "Canceled",
"Succeeded", "Failed", "Requested", "Running".
:vartype status: str or ~azure.mgmt.botservice.models.OperationResultStatus
:ivar start_time: The time that the operation was started.
:vartype start_time: ~datetime.datetime
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'status': {'readonly': True},
'start_time': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'status': {'key': 'status', 'type': 'str'},
'start_time': {'key': 'startTime', 'type': 'iso-8601'},
}
def __init__(
self,
**kwargs
):
"""
"""
super(OperationResultsDescription, self).__init__(**kwargs)
self.id = None
self.name = None
self.status = None
self.start_time = None
[docs]class PrivateEndpoint(msrest.serialization.Model):
"""The Private Endpoint resource.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar id: The ARM identifier for Private Endpoint.
:vartype id: str
"""
_validation = {
'id': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
}
def __init__(
self,
**kwargs
):
"""
"""
super(PrivateEndpoint, self).__init__(**kwargs)
self.id = None
[docs]class PrivateLinkResourceBase(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.
:ivar id: Fully qualified resource ID for the resource. Ex -
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
:vartype id: str
:ivar name: The name of the resource.
:vartype name: str
:ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or
"Microsoft.Storage/storageAccounts".
:vartype type: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
}
def __init__(
self,
**kwargs
):
"""
"""
super(PrivateLinkResourceBase, self).__init__(**kwargs)
self.id = None
self.name = None
self.type = None
[docs]class PrivateEndpointConnection(PrivateLinkResourceBase):
"""The Private Endpoint Connection resource.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar id: Fully qualified resource ID for the resource. Ex -
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
:vartype id: str
:ivar name: The name of the resource.
:vartype name: str
:ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or
"Microsoft.Storage/storageAccounts".
:vartype type: str
:ivar private_endpoint: The resource of private end point.
:vartype private_endpoint: ~azure.mgmt.botservice.models.PrivateEndpoint
:ivar private_link_service_connection_state: A collection of information about the state of the
connection between service consumer and provider.
:vartype private_link_service_connection_state:
~azure.mgmt.botservice.models.PrivateLinkServiceConnectionState
:ivar provisioning_state: The provisioning state of the private endpoint connection resource.
Possible values include: "Succeeded", "Creating", "Deleting", "Failed".
:vartype provisioning_state: str or
~azure.mgmt.botservice.models.PrivateEndpointConnectionProvisioningState
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'provisioning_state': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'private_endpoint': {'key': 'properties.privateEndpoint', 'type': 'PrivateEndpoint'},
'private_link_service_connection_state': {'key': 'properties.privateLinkServiceConnectionState', 'type': 'PrivateLinkServiceConnectionState'},
'provisioning_state': {'key': 'properties.provisioningState', 'type': 'str'},
}
def __init__(
self,
*,
private_endpoint: Optional["PrivateEndpoint"] = None,
private_link_service_connection_state: Optional["PrivateLinkServiceConnectionState"] = None,
**kwargs
):
"""
:keyword private_endpoint: The resource of private end point.
:paramtype private_endpoint: ~azure.mgmt.botservice.models.PrivateEndpoint
:keyword private_link_service_connection_state: A collection of information about the state of
the connection between service consumer and provider.
:paramtype private_link_service_connection_state:
~azure.mgmt.botservice.models.PrivateLinkServiceConnectionState
"""
super(PrivateEndpointConnection, self).__init__(**kwargs)
self.private_endpoint = private_endpoint
self.private_link_service_connection_state = private_link_service_connection_state
self.provisioning_state = None
[docs]class PrivateEndpointConnectionListResult(msrest.serialization.Model):
"""List of private endpoint connection associated with the specified storage account.
:ivar value: Array of private endpoint connections.
:vartype value: list[~azure.mgmt.botservice.models.PrivateEndpointConnection]
"""
_attribute_map = {
'value': {'key': 'value', 'type': '[PrivateEndpointConnection]'},
}
def __init__(
self,
*,
value: Optional[List["PrivateEndpointConnection"]] = None,
**kwargs
):
"""
:keyword value: Array of private endpoint connections.
:paramtype value: list[~azure.mgmt.botservice.models.PrivateEndpointConnection]
"""
super(PrivateEndpointConnectionListResult, self).__init__(**kwargs)
self.value = value
[docs]class PrivateLinkResource(PrivateLinkResourceBase):
"""A private link resource.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar id: Fully qualified resource ID for the resource. Ex -
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
:vartype id: str
:ivar name: The name of the resource.
:vartype name: str
:ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or
"Microsoft.Storage/storageAccounts".
:vartype type: str
:ivar group_id: The private link resource group id.
:vartype group_id: str
:ivar required_members: The private link resource required member names.
:vartype required_members: list[str]
:ivar required_zone_names: The private link resource Private link DNS zone name.
:vartype required_zone_names: list[str]
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'group_id': {'readonly': True},
'required_members': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'group_id': {'key': 'properties.groupId', 'type': 'str'},
'required_members': {'key': 'properties.requiredMembers', 'type': '[str]'},
'required_zone_names': {'key': 'properties.requiredZoneNames', 'type': '[str]'},
}
def __init__(
self,
*,
required_zone_names: Optional[List[str]] = None,
**kwargs
):
"""
:keyword required_zone_names: The private link resource Private link DNS zone name.
:paramtype required_zone_names: list[str]
"""
super(PrivateLinkResource, self).__init__(**kwargs)
self.group_id = None
self.required_members = None
self.required_zone_names = required_zone_names
[docs]class PrivateLinkResourceListResult(msrest.serialization.Model):
"""A list of private link resources.
:ivar value: Array of private link resources.
:vartype value: list[~azure.mgmt.botservice.models.PrivateLinkResource]
"""
_attribute_map = {
'value': {'key': 'value', 'type': '[PrivateLinkResource]'},
}
def __init__(
self,
*,
value: Optional[List["PrivateLinkResource"]] = None,
**kwargs
):
"""
:keyword value: Array of private link resources.
:paramtype value: list[~azure.mgmt.botservice.models.PrivateLinkResource]
"""
super(PrivateLinkResourceListResult, self).__init__(**kwargs)
self.value = value
[docs]class PrivateLinkServiceConnectionState(msrest.serialization.Model):
"""A collection of information about the state of the connection between service consumer and provider.
:ivar status: Indicates whether the connection has been Approved/Rejected/Removed by the owner
of the service. Possible values include: "Pending", "Approved", "Rejected".
:vartype status: str or ~azure.mgmt.botservice.models.PrivateEndpointServiceConnectionStatus
:ivar description: The reason for approval/rejection of the connection.
:vartype description: str
:ivar actions_required: A message indicating if changes on the service provider require any
updates on the consumer.
:vartype actions_required: str
"""
_attribute_map = {
'status': {'key': 'status', 'type': 'str'},
'description': {'key': 'description', 'type': 'str'},
'actions_required': {'key': 'actionsRequired', 'type': 'str'},
}
def __init__(
self,
*,
status: Optional[Union[str, "PrivateEndpointServiceConnectionStatus"]] = None,
description: Optional[str] = None,
actions_required: Optional[str] = None,
**kwargs
):
"""
:keyword status: Indicates whether the connection has been Approved/Rejected/Removed by the
owner of the service. Possible values include: "Pending", "Approved", "Rejected".
:paramtype status: str or ~azure.mgmt.botservice.models.PrivateEndpointServiceConnectionStatus
:keyword description: The reason for approval/rejection of the connection.
:paramtype description: str
:keyword actions_required: A message indicating if changes on the service provider require any
updates on the consumer.
:paramtype actions_required: str
"""
super(PrivateLinkServiceConnectionState, self).__init__(**kwargs)
self.status = status
self.description = description
self.actions_required = actions_required
[docs]class ServiceProvider(msrest.serialization.Model):
"""Service Provider Definition.
:ivar properties: The Properties of a Service Provider Object.
:vartype properties: ~azure.mgmt.botservice.models.ServiceProviderProperties
"""
_attribute_map = {
'properties': {'key': 'properties', 'type': 'ServiceProviderProperties'},
}
def __init__(
self,
*,
properties: Optional["ServiceProviderProperties"] = None,
**kwargs
):
"""
:keyword properties: The Properties of a Service Provider Object.
:paramtype properties: ~azure.mgmt.botservice.models.ServiceProviderProperties
"""
super(ServiceProvider, self).__init__(**kwargs)
self.properties = properties
[docs]class ServiceProviderParameter(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.
:ivar name: Name of the Service Provider.
:vartype name: str
:ivar type: Type of the Service Provider.
:vartype type: str
:ivar display_name: Display Name of the Service Provider.
:vartype display_name: str
:ivar description: Description of the Service Provider.
:vartype description: str
:ivar help_url: Help Url for the Service Provider.
:vartype help_url: str
:ivar default: Default Name for the Service Provider.
:vartype default: str
:ivar metadata: Meta data for the Service Provider.
:vartype metadata: ~azure.mgmt.botservice.models.ServiceProviderParameterMetadata
"""
_validation = {
'name': {'readonly': True},
'type': {'readonly': True},
'display_name': {'readonly': True},
'description': {'readonly': True},
'help_url': {'readonly': True},
'default': {'readonly': True},
'metadata': {'readonly': True},
}
_attribute_map = {
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'display_name': {'key': 'displayName', 'type': 'str'},
'description': {'key': 'description', 'type': 'str'},
'help_url': {'key': 'helpUrl', 'type': 'str'},
'default': {'key': 'default', 'type': 'str'},
'metadata': {'key': 'metadata', 'type': 'ServiceProviderParameterMetadata'},
}
def __init__(
self,
**kwargs
):
"""
"""
super(ServiceProviderParameter, self).__init__(**kwargs)
self.name = None
self.type = None
self.display_name = None
self.description = None
self.help_url = None
self.default = None
self.metadata = None
[docs]class ServiceProviderProperties(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.
:ivar id: Id for Service Provider.
:vartype id: str
:ivar display_name: Display Name of the Service Provider.
:vartype display_name: str
:ivar service_provider_name: Display Name of the Service Provider.
:vartype service_provider_name: str
:ivar dev_portal_url: Display Name of the Service Provider.
:vartype dev_portal_url: str
:ivar icon_url: Display Name of the Service Provider.
:vartype icon_url: str
:ivar parameters: The list of parameters for the Service Provider.
:vartype parameters: list[~azure.mgmt.botservice.models.ServiceProviderParameter]
"""
_validation = {
'id': {'readonly': True},
'display_name': {'readonly': True},
'service_provider_name': {'readonly': True},
'dev_portal_url': {'readonly': True},
'icon_url': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'display_name': {'key': 'displayName', 'type': 'str'},
'service_provider_name': {'key': 'serviceProviderName', 'type': 'str'},
'dev_portal_url': {'key': 'devPortalUrl', 'type': 'str'},
'icon_url': {'key': 'iconUrl', 'type': 'str'},
'parameters': {'key': 'parameters', 'type': '[ServiceProviderParameter]'},
}
def __init__(
self,
*,
parameters: Optional[List["ServiceProviderParameter"]] = None,
**kwargs
):
"""
:keyword parameters: The list of parameters for the Service Provider.
:paramtype parameters: list[~azure.mgmt.botservice.models.ServiceProviderParameter]
"""
super(ServiceProviderProperties, self).__init__(**kwargs)
self.id = None
self.display_name = None
self.service_provider_name = None
self.dev_portal_url = None
self.icon_url = None
self.parameters = parameters
[docs]class ServiceProviderResponseList(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.
:ivar next_link: The link used to get the next page of bot service providers.
:vartype next_link: str
:ivar value: Gets the list of bot service providers and their properties.
:vartype value: list[~azure.mgmt.botservice.models.ServiceProvider]
"""
_validation = {
'value': {'readonly': True},
}
_attribute_map = {
'next_link': {'key': 'nextLink', 'type': 'str'},
'value': {'key': 'value', 'type': '[ServiceProvider]'},
}
def __init__(
self,
*,
next_link: Optional[str] = None,
**kwargs
):
"""
:keyword next_link: The link used to get the next page of bot service providers.
:paramtype next_link: str
"""
super(ServiceProviderResponseList, self).__init__(**kwargs)
self.next_link = next_link
self.value = None
class WebChatSite(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.
:ivar site_id: Site Id.
:vartype site_id: str
:ivar site_name: Required. Site name.
:vartype site_name: str
:ivar key: Primary key. Value only returned through POST to the action Channel List API,
otherwise empty.
:vartype key: str
:ivar key2: Secondary key. Value only returned through POST to the action Channel List API,
otherwise empty.
:vartype key2: str
:ivar is_enabled: Required. Whether this site is enabled for DirectLine channel.
:vartype is_enabled: bool
:ivar is_webchat_preview_enabled: Required. Whether this site is enabled for preview versions
of Webchat.
:vartype is_webchat_preview_enabled: bool
"""
_validation = {
'site_id': {'readonly': True},
'site_name': {'required': True},
'key': {'readonly': True},
'key2': {'readonly': True},
'is_enabled': {'required': True},
'is_webchat_preview_enabled': {'required': True},
}
_attribute_map = {
'site_id': {'key': 'siteId', 'type': 'str'},
'site_name': {'key': 'siteName', 'type': 'str'},
'key': {'key': 'key', 'type': 'str'},
'key2': {'key': 'key2', 'type': 'str'},
'is_enabled': {'key': 'isEnabled', 'type': 'bool'},
'is_webchat_preview_enabled': {'key': 'isWebchatPreviewEnabled', 'type': 'bool'},
}
def __init__(
self,
*,
site_name: str,
is_enabled: bool,
is_webchat_preview_enabled: bool,
**kwargs
):
"""
:keyword site_name: Required. Site name.
:paramtype site_name: str
:keyword is_enabled: Required. Whether this site is enabled for DirectLine channel.
:paramtype is_enabled: bool
:keyword is_webchat_preview_enabled: Required. Whether this site is enabled for preview
versions of Webchat.
:paramtype is_webchat_preview_enabled: bool
"""
super(WebChatSite, self).__init__(**kwargs)
self.site_id = None
self.site_name = site_name
self.key = None
self.key2 = None
self.is_enabled = is_enabled
self.is_webchat_preview_enabled = is_webchat_preview_enabled
class Site(WebChatSite, 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.
:ivar is_v1_enabled: Required. Whether this site is enabled for Bot Framework V1 protocol.
:vartype is_v1_enabled: bool
:ivar is_v3_enabled: Required. Whether this site is enabled for Bot Framework V1 protocol.
:vartype is_v3_enabled: bool
:ivar is_secure_site_enabled: Whether this site is enabled for authentication with Bot
Framework.
:vartype is_secure_site_enabled: bool
:ivar is_block_user_upload_enabled: Whether this site is enabled for block user upload.
:vartype is_block_user_upload_enabled: bool
:ivar trusted_origins: List of Trusted Origin URLs for this site. This field is applicable only
if isSecureSiteEnabled is True.
:vartype trusted_origins: list[str]
:ivar site_id: Site Id.
:vartype site_id: str
:ivar site_name: Required. Site name.
:vartype site_name: str
:ivar key: Primary key. Value only returned through POST to the action Channel List API,
otherwise empty.
:vartype key: str
:ivar key2: Secondary key. Value only returned through POST to the action Channel List API,
otherwise empty.
:vartype key2: str
:ivar is_enabled: Required. Whether this site is enabled for DirectLine channel.
:vartype is_enabled: bool
:ivar is_webchat_preview_enabled: Required. Whether this site is enabled for preview versions
of Webchat.
:vartype is_webchat_preview_enabled: bool
:ivar is_token_enabled: Whether this site is token enabled for channel.
:vartype is_token_enabled: bool
:ivar e_tag: Entity Tag.
:vartype e_tag: str
"""
_validation = {
'is_v1_enabled': {'required': True},
'is_v3_enabled': {'required': True},
'site_id': {'readonly': True},
'site_name': {'required': True},
'key': {'readonly': True},
'key2': {'readonly': True},
'is_enabled': {'required': True},
'is_webchat_preview_enabled': {'required': True},
}
_attribute_map = {
'is_v1_enabled': {'key': 'isV1Enabled', 'type': 'bool'},
'is_v3_enabled': {'key': 'isV3Enabled', 'type': 'bool'},
'is_secure_site_enabled': {'key': 'isSecureSiteEnabled', 'type': 'bool'},
'is_block_user_upload_enabled': {'key': 'isBlockUserUploadEnabled', 'type': 'bool'},
'trusted_origins': {'key': 'trustedOrigins', 'type': '[str]'},
'site_id': {'key': 'siteId', 'type': 'str'},
'site_name': {'key': 'siteName', 'type': 'str'},
'key': {'key': 'key', 'type': 'str'},
'key2': {'key': 'key2', 'type': 'str'},
'is_enabled': {'key': 'isEnabled', 'type': 'bool'},
'is_webchat_preview_enabled': {'key': 'isWebchatPreviewEnabled', 'type': 'bool'},
'is_token_enabled': {'key': 'isTokenEnabled', 'type': 'bool'},
'e_tag': {'key': 'eTag', 'type': 'str'},
}
def __init__(
self,
*,
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
):
"""
:keyword is_v1_enabled: Required. Whether this site is enabled for Bot Framework V1 protocol.
:paramtype is_v1_enabled: bool
:keyword is_v3_enabled: Required. Whether this site is enabled for Bot Framework V1 protocol.
:paramtype is_v3_enabled: bool
:keyword is_secure_site_enabled: Whether this site is enabled for authentication with Bot
Framework.
:paramtype is_secure_site_enabled: bool
:keyword is_block_user_upload_enabled: Whether this site is enabled for block user upload.
:paramtype is_block_user_upload_enabled: bool
:keyword trusted_origins: List of Trusted Origin URLs for this site. This field is applicable
only if isSecureSiteEnabled is True.
:paramtype trusted_origins: list[str]
:keyword site_name: Required. Site name.
:paramtype site_name: str
:keyword is_enabled: Required. Whether this site is enabled for DirectLine channel.
:paramtype is_enabled: bool
:keyword is_webchat_preview_enabled: Required. Whether this site is enabled for preview
versions of Webchat.
:paramtype is_webchat_preview_enabled: bool
:keyword is_token_enabled: Whether this site is token enabled for channel.
:paramtype is_token_enabled: bool
:keyword e_tag: Entity Tag.
:paramtype e_tag: str
"""
super(Site, self).__init__(site_name=site_name, is_enabled=is_enabled, is_webchat_preview_enabled=is_webchat_preview_enabled, is_v1_enabled=is_v1_enabled, is_v3_enabled=is_v3_enabled, is_secure_site_enabled=is_secure_site_enabled, is_block_user_upload_enabled=is_block_user_upload_enabled, trusted_origins=trusted_origins, **kwargs)
self.is_v1_enabled = is_v1_enabled
self.is_v3_enabled = is_v3_enabled
self.is_secure_site_enabled = is_secure_site_enabled
self.is_block_user_upload_enabled = is_block_user_upload_enabled
self.trusted_origins = trusted_origins
self.is_token_enabled = is_token_enabled
self.e_tag = e_tag
self.site_id = None
self.site_name = site_name
self.key = None
self.key2 = None
self.is_enabled = is_enabled
self.is_webchat_preview_enabled = is_webchat_preview_enabled
self.is_token_enabled = is_token_enabled
self.e_tag = e_tag
[docs]class SiteInfo(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.
:ivar site_name: Required. The site name.
:vartype site_name: str
:ivar key: Required. Determines which key is to be regenerated. Possible values include:
"key1", "key2".
:vartype key: str or ~azure.mgmt.botservice.models.Key
"""
_validation = {
'site_name': {'required': True},
'key': {'required': True},
}
_attribute_map = {
'site_name': {'key': 'siteName', 'type': 'str'},
'key': {'key': 'key', 'type': 'str'},
}
def __init__(
self,
*,
site_name: str,
key: Union[str, "Key"],
**kwargs
):
"""
:keyword site_name: Required. The site name.
:paramtype site_name: str
:keyword key: Required. Determines which key is to be regenerated. Possible values include:
"key1", "key2".
:paramtype key: str or ~azure.mgmt.botservice.models.Key
"""
super(SiteInfo, self).__init__(**kwargs)
self.site_name = site_name
self.key = key
[docs]class Sku(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.
:ivar name: Required. The sku name. Possible values include: "F0", "S1".
:vartype name: str or ~azure.mgmt.botservice.models.SkuName
:ivar tier: Gets the sku tier. This is based on the SKU name. Possible values include: "Free",
"Standard".
:vartype tier: str or ~azure.mgmt.botservice.models.SkuTier
"""
_validation = {
'name': {'required': True},
'tier': {'readonly': True},
}
_attribute_map = {
'name': {'key': 'name', 'type': 'str'},
'tier': {'key': 'tier', 'type': 'str'},
}
def __init__(
self,
*,
name: Union[str, "SkuName"],
**kwargs
):
"""
:keyword name: Required. The sku name. Possible values include: "F0", "S1".
:paramtype name: str or ~azure.mgmt.botservice.models.SkuName
"""
super(Sku, self).__init__(**kwargs)
self.name = name
self.tier = None
[docs]class SkypeChannel(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.
:ivar channel_name: Required. The channel name.Constant filled by server.
:vartype channel_name: str
:ivar etag: Entity Tag of the resource.
:vartype etag: str
:ivar provisioning_state: Provisioning state of the resource.
:vartype provisioning_state: str
:ivar location: Specifies the location of the resource.
:vartype location: str
:ivar properties: The set of properties specific to Skype channel resource.
:vartype properties: ~azure.mgmt.botservice.models.SkypeChannelProperties
"""
_validation = {
'channel_name': {'required': True},
'provisioning_state': {'readonly': True},
}
_attribute_map = {
'channel_name': {'key': 'channelName', 'type': 'str'},
'etag': {'key': 'etag', 'type': 'str'},
'provisioning_state': {'key': 'provisioningState', 'type': 'str'},
'location': {'key': 'location', 'type': 'str'},
'properties': {'key': 'properties', 'type': 'SkypeChannelProperties'},
}
def __init__(
self,
*,
etag: Optional[str] = None,
location: Optional[str] = "global",
properties: Optional["SkypeChannelProperties"] = None,
**kwargs
):
"""
:keyword etag: Entity Tag of the resource.
:paramtype etag: str
:keyword location: Specifies the location of the resource.
:paramtype location: str
:keyword properties: The set of properties specific to Skype channel resource.
:paramtype properties: ~azure.mgmt.botservice.models.SkypeChannelProperties
"""
super(SkypeChannel, self).__init__(etag=etag, location=location, **kwargs)
self.channel_name = 'SkypeChannel' # type: str
self.properties = properties
[docs]class SkypeChannelProperties(msrest.serialization.Model):
"""The parameters to provide for the Microsoft Teams channel.
All required parameters must be populated in order to send to Azure.
:ivar enable_messaging: Enable messaging for Skype channel.
:vartype enable_messaging: bool
:ivar enable_media_cards: Enable media cards for Skype channel.
:vartype enable_media_cards: bool
:ivar enable_video: Enable video for Skype channel.
:vartype enable_video: bool
:ivar enable_calling: Enable calling for Skype channel.
:vartype enable_calling: bool
:ivar enable_screen_sharing: Enable screen sharing for Skype channel.
:vartype enable_screen_sharing: bool
:ivar enable_groups: Enable groups for Skype channel.
:vartype enable_groups: bool
:ivar groups_mode: Group mode for Skype channel.
:vartype groups_mode: str
:ivar calling_web_hook: Calling web hook for Skype channel.
:vartype calling_web_hook: str
:ivar incoming_call_route: Incoming call route for Skype channel.
:vartype incoming_call_route: str
:ivar is_enabled: Required. Whether this channel is enabled for the bot.
:vartype is_enabled: bool
"""
_validation = {
'is_enabled': {'required': True},
}
_attribute_map = {
'enable_messaging': {'key': 'enableMessaging', 'type': 'bool'},
'enable_media_cards': {'key': 'enableMediaCards', 'type': 'bool'},
'enable_video': {'key': 'enableVideo', 'type': 'bool'},
'enable_calling': {'key': 'enableCalling', 'type': 'bool'},
'enable_screen_sharing': {'key': 'enableScreenSharing', 'type': 'bool'},
'enable_groups': {'key': 'enableGroups', 'type': 'bool'},
'groups_mode': {'key': 'groupsMode', 'type': 'str'},
'calling_web_hook': {'key': 'callingWebHook', 'type': 'str'},
'incoming_call_route': {'key': 'incomingCallRoute', 'type': 'str'},
'is_enabled': {'key': 'isEnabled', 'type': 'bool'},
}
def __init__(
self,
*,
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
):
"""
:keyword enable_messaging: Enable messaging for Skype channel.
:paramtype enable_messaging: bool
:keyword enable_media_cards: Enable media cards for Skype channel.
:paramtype enable_media_cards: bool
:keyword enable_video: Enable video for Skype channel.
:paramtype enable_video: bool
:keyword enable_calling: Enable calling for Skype channel.
:paramtype enable_calling: bool
:keyword enable_screen_sharing: Enable screen sharing for Skype channel.
:paramtype enable_screen_sharing: bool
:keyword enable_groups: Enable groups for Skype channel.
:paramtype enable_groups: bool
:keyword groups_mode: Group mode for Skype channel.
:paramtype groups_mode: str
:keyword calling_web_hook: Calling web hook for Skype channel.
:paramtype calling_web_hook: str
:keyword incoming_call_route: Incoming call route for Skype channel.
:paramtype incoming_call_route: str
:keyword is_enabled: Required. Whether this channel is enabled for the bot.
:paramtype is_enabled: bool
"""
super(SkypeChannelProperties, self).__init__(**kwargs)
self.enable_messaging = enable_messaging
self.enable_media_cards = enable_media_cards
self.enable_video = enable_video
self.enable_calling = enable_calling
self.enable_screen_sharing = enable_screen_sharing
self.enable_groups = enable_groups
self.groups_mode = groups_mode
self.calling_web_hook = calling_web_hook
self.incoming_call_route = incoming_call_route
self.is_enabled = is_enabled
[docs]class SlackChannel(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.
:ivar channel_name: Required. The channel name.Constant filled by server.
:vartype channel_name: str
:ivar etag: Entity Tag of the resource.
:vartype etag: str
:ivar provisioning_state: Provisioning state of the resource.
:vartype provisioning_state: str
:ivar location: Specifies the location of the resource.
:vartype location: str
:ivar properties: The set of properties specific to Slack channel resource.
:vartype properties: ~azure.mgmt.botservice.models.SlackChannelProperties
"""
_validation = {
'channel_name': {'required': True},
'provisioning_state': {'readonly': True},
}
_attribute_map = {
'channel_name': {'key': 'channelName', 'type': 'str'},
'etag': {'key': 'etag', 'type': 'str'},
'provisioning_state': {'key': 'provisioningState', 'type': 'str'},
'location': {'key': 'location', 'type': 'str'},
'properties': {'key': 'properties', 'type': 'SlackChannelProperties'},
}
def __init__(
self,
*,
etag: Optional[str] = None,
location: Optional[str] = "global",
properties: Optional["SlackChannelProperties"] = None,
**kwargs
):
"""
:keyword etag: Entity Tag of the resource.
:paramtype etag: str
:keyword location: Specifies the location of the resource.
:paramtype location: str
:keyword properties: The set of properties specific to Slack channel resource.
:paramtype properties: ~azure.mgmt.botservice.models.SlackChannelProperties
"""
super(SlackChannel, self).__init__(etag=etag, location=location, **kwargs)
self.channel_name = 'SlackChannel' # type: str
self.properties = properties
[docs]class SlackChannelProperties(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.
:ivar client_id: The Slack client id.
:vartype client_id: str
:ivar client_secret: The Slack client secret. Value only returned through POST to the action
Channel List API, otherwise empty.
:vartype client_secret: str
:ivar verification_token: The Slack verification token. Value only returned through POST to the
action Channel List API, otherwise empty.
:vartype verification_token: str
:ivar scopes: The Slack permission scopes.
:vartype scopes: str
:ivar landing_page_url: The Slack landing page Url.
:vartype landing_page_url: str
:ivar redirect_action: The Slack redirect action.
:vartype redirect_action: str
:ivar last_submission_id: The Sms auth token.
:vartype last_submission_id: str
:ivar register_before_o_auth_flow: Whether to register the settings before OAuth validation is
performed. Recommended to True.
:vartype register_before_o_auth_flow: bool
:ivar is_validated: Whether this channel is validated for the bot.
:vartype is_validated: bool
:ivar signing_secret: The Slack signing secret.
:vartype signing_secret: str
:ivar is_enabled: Required. Whether this channel is enabled for the bot.
:vartype is_enabled: bool
"""
_validation = {
'redirect_action': {'readonly': True},
'last_submission_id': {'readonly': True},
'register_before_o_auth_flow': {'readonly': True},
'is_validated': {'readonly': True},
'is_enabled': {'required': True},
}
_attribute_map = {
'client_id': {'key': 'clientId', 'type': 'str'},
'client_secret': {'key': 'clientSecret', 'type': 'str'},
'verification_token': {'key': 'verificationToken', 'type': 'str'},
'scopes': {'key': 'scopes', 'type': 'str'},
'landing_page_url': {'key': 'landingPageUrl', 'type': 'str'},
'redirect_action': {'key': 'redirectAction', 'type': 'str'},
'last_submission_id': {'key': 'lastSubmissionId', 'type': 'str'},
'register_before_o_auth_flow': {'key': 'registerBeforeOAuthFlow', 'type': 'bool'},
'is_validated': {'key': 'IsValidated', 'type': 'bool'},
'signing_secret': {'key': 'signingSecret', 'type': 'str'},
'is_enabled': {'key': 'isEnabled', 'type': 'bool'},
}
def __init__(
self,
*,
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
):
"""
:keyword client_id: The Slack client id.
:paramtype client_id: str
:keyword client_secret: The Slack client secret. Value only returned through POST to the action
Channel List API, otherwise empty.
:paramtype client_secret: str
:keyword verification_token: The Slack verification token. Value only returned through POST to
the action Channel List API, otherwise empty.
:paramtype verification_token: str
:keyword scopes: The Slack permission scopes.
:paramtype scopes: str
:keyword landing_page_url: The Slack landing page Url.
:paramtype landing_page_url: str
:keyword signing_secret: The Slack signing secret.
:paramtype signing_secret: str
:keyword is_enabled: Required. Whether this channel is enabled for the bot.
:paramtype is_enabled: bool
"""
super(SlackChannelProperties, self).__init__(**kwargs)
self.client_id = client_id
self.client_secret = client_secret
self.verification_token = verification_token
self.scopes = scopes
self.landing_page_url = landing_page_url
self.redirect_action = None
self.last_submission_id = None
self.register_before_o_auth_flow = None
self.is_validated = None
self.signing_secret = signing_secret
self.is_enabled = is_enabled
[docs]class SmsChannel(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.
:ivar channel_name: Required. The channel name.Constant filled by server.
:vartype channel_name: str
:ivar etag: Entity Tag of the resource.
:vartype etag: str
:ivar provisioning_state: Provisioning state of the resource.
:vartype provisioning_state: str
:ivar location: Specifies the location of the resource.
:vartype location: str
:ivar properties: The set of properties specific to Sms channel resource.
:vartype properties: ~azure.mgmt.botservice.models.SmsChannelProperties
"""
_validation = {
'channel_name': {'required': True},
'provisioning_state': {'readonly': True},
}
_attribute_map = {
'channel_name': {'key': 'channelName', 'type': 'str'},
'etag': {'key': 'etag', 'type': 'str'},
'provisioning_state': {'key': 'provisioningState', 'type': 'str'},
'location': {'key': 'location', 'type': 'str'},
'properties': {'key': 'properties', 'type': 'SmsChannelProperties'},
}
def __init__(
self,
*,
etag: Optional[str] = None,
location: Optional[str] = "global",
properties: Optional["SmsChannelProperties"] = None,
**kwargs
):
"""
:keyword etag: Entity Tag of the resource.
:paramtype etag: str
:keyword location: Specifies the location of the resource.
:paramtype location: str
:keyword properties: The set of properties specific to Sms channel resource.
:paramtype properties: ~azure.mgmt.botservice.models.SmsChannelProperties
"""
super(SmsChannel, self).__init__(etag=etag, location=location, **kwargs)
self.channel_name = 'SmsChannel' # type: str
self.properties = properties
[docs]class SmsChannelProperties(msrest.serialization.Model):
"""The parameters to provide for the Sms channel.
All required parameters must be populated in order to send to Azure.
:ivar phone: Required. The Sms phone.
:vartype phone: str
:ivar account_sid: Required. The Sms account SID. Value only returned through POST to the
action Channel List API, otherwise empty.
:vartype account_sid: str
:ivar auth_token: The Sms auth token. Value only returned through POST to the action Channel
List API, otherwise empty.
:vartype auth_token: str
:ivar is_validated: Whether this channel is validated for the bot.
:vartype is_validated: bool
:ivar is_enabled: Required. Whether this channel is enabled for the bot.
:vartype is_enabled: bool
"""
_validation = {
'phone': {'required': True},
'account_sid': {'required': True},
'is_enabled': {'required': True},
}
_attribute_map = {
'phone': {'key': 'phone', 'type': 'str'},
'account_sid': {'key': 'accountSID', 'type': 'str'},
'auth_token': {'key': 'authToken', 'type': 'str'},
'is_validated': {'key': 'isValidated', 'type': 'bool'},
'is_enabled': {'key': 'isEnabled', 'type': 'bool'},
}
def __init__(
self,
*,
phone: str,
account_sid: str,
is_enabled: bool,
auth_token: Optional[str] = None,
is_validated: Optional[bool] = None,
**kwargs
):
"""
:keyword phone: Required. The Sms phone.
:paramtype phone: str
:keyword account_sid: Required. The Sms account SID. Value only returned through POST to the
action Channel List API, otherwise empty.
:paramtype account_sid: str
:keyword auth_token: The Sms auth token. Value only returned through POST to the action Channel
List API, otherwise empty.
:paramtype auth_token: str
:keyword is_validated: Whether this channel is validated for the bot.
:paramtype is_validated: bool
:keyword is_enabled: Required. Whether this channel is enabled for the bot.
:paramtype is_enabled: bool
"""
super(SmsChannelProperties, self).__init__(**kwargs)
self.phone = phone
self.account_sid = account_sid
self.auth_token = auth_token
self.is_validated = is_validated
self.is_enabled = is_enabled
[docs]class TelegramChannel(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.
:ivar channel_name: Required. The channel name.Constant filled by server.
:vartype channel_name: str
:ivar etag: Entity Tag of the resource.
:vartype etag: str
:ivar provisioning_state: Provisioning state of the resource.
:vartype provisioning_state: str
:ivar location: Specifies the location of the resource.
:vartype location: str
:ivar properties: The set of properties specific to Telegram channel resource.
:vartype properties: ~azure.mgmt.botservice.models.TelegramChannelProperties
"""
_validation = {
'channel_name': {'required': True},
'provisioning_state': {'readonly': True},
}
_attribute_map = {
'channel_name': {'key': 'channelName', 'type': 'str'},
'etag': {'key': 'etag', 'type': 'str'},
'provisioning_state': {'key': 'provisioningState', 'type': 'str'},
'location': {'key': 'location', 'type': 'str'},
'properties': {'key': 'properties', 'type': 'TelegramChannelProperties'},
}
def __init__(
self,
*,
etag: Optional[str] = None,
location: Optional[str] = "global",
properties: Optional["TelegramChannelProperties"] = None,
**kwargs
):
"""
:keyword etag: Entity Tag of the resource.
:paramtype etag: str
:keyword location: Specifies the location of the resource.
:paramtype location: str
:keyword properties: The set of properties specific to Telegram channel resource.
:paramtype properties: ~azure.mgmt.botservice.models.TelegramChannelProperties
"""
super(TelegramChannel, self).__init__(etag=etag, location=location, **kwargs)
self.channel_name = 'TelegramChannel' # type: str
self.properties = properties
[docs]class TelegramChannelProperties(msrest.serialization.Model):
"""The parameters to provide for the Telegram channel.
All required parameters must be populated in order to send to Azure.
:ivar access_token: The Telegram access token. Value only returned through POST to the action
Channel List API, otherwise empty.
:vartype access_token: str
:ivar is_validated: Whether this channel is validated for the bot.
:vartype is_validated: bool
:ivar is_enabled: Required. Whether this channel is enabled for the bot.
:vartype is_enabled: bool
"""
_validation = {
'is_enabled': {'required': True},
}
_attribute_map = {
'access_token': {'key': 'accessToken', 'type': 'str'},
'is_validated': {'key': 'isValidated', 'type': 'bool'},
'is_enabled': {'key': 'isEnabled', 'type': 'bool'},
}
def __init__(
self,
*,
is_enabled: bool,
access_token: Optional[str] = None,
is_validated: Optional[bool] = None,
**kwargs
):
"""
:keyword access_token: The Telegram access token. Value only returned through POST to the
action Channel List API, otherwise empty.
:paramtype access_token: str
:keyword is_validated: Whether this channel is validated for the bot.
:paramtype is_validated: bool
:keyword is_enabled: Required. Whether this channel is enabled for the bot.
:paramtype is_enabled: bool
"""
super(TelegramChannelProperties, self).__init__(**kwargs)
self.access_token = access_token
self.is_validated = is_validated
self.is_enabled = is_enabled
[docs]class WebChatChannel(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.
:ivar channel_name: Required. The channel name.Constant filled by server.
:vartype channel_name: str
:ivar etag: Entity Tag of the resource.
:vartype etag: str
:ivar provisioning_state: Provisioning state of the resource.
:vartype provisioning_state: str
:ivar location: Specifies the location of the resource.
:vartype location: str
:ivar properties: The set of properties specific to Web Chat channel resource.
:vartype properties: ~azure.mgmt.botservice.models.WebChatChannelProperties
"""
_validation = {
'channel_name': {'required': True},
'provisioning_state': {'readonly': True},
}
_attribute_map = {
'channel_name': {'key': 'channelName', 'type': 'str'},
'etag': {'key': 'etag', 'type': 'str'},
'provisioning_state': {'key': 'provisioningState', 'type': 'str'},
'location': {'key': 'location', 'type': 'str'},
'properties': {'key': 'properties', 'type': 'WebChatChannelProperties'},
}
def __init__(
self,
*,
etag: Optional[str] = None,
location: Optional[str] = "global",
properties: Optional["WebChatChannelProperties"] = None,
**kwargs
):
"""
:keyword etag: Entity Tag of the resource.
:paramtype etag: str
:keyword location: Specifies the location of the resource.
:paramtype location: str
:keyword properties: The set of properties specific to Web Chat channel resource.
:paramtype properties: ~azure.mgmt.botservice.models.WebChatChannelProperties
"""
super(WebChatChannel, self).__init__(etag=etag, location=location, **kwargs)
self.channel_name = 'WebChatChannel' # type: str
self.properties = properties
[docs]class WebChatChannelProperties(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.
:ivar web_chat_embed_code: Web chat control embed code.
:vartype web_chat_embed_code: str
:ivar sites: The list of Web Chat sites.
:vartype sites: list[~azure.mgmt.botservice.models.WebChatSite]
"""
_validation = {
'web_chat_embed_code': {'readonly': True},
}
_attribute_map = {
'web_chat_embed_code': {'key': 'webChatEmbedCode', 'type': 'str'},
'sites': {'key': 'sites', 'type': '[WebChatSite]'},
}
def __init__(
self,
*,
sites: Optional[List["WebChatSite"]] = None,
**kwargs
):
"""
:keyword sites: The list of Web Chat sites.
:paramtype sites: list[~azure.mgmt.botservice.models.WebChatSite]
"""
super(WebChatChannelProperties, self).__init__(**kwargs)
self.web_chat_embed_code = None
self.sites = sites