azure.mgmt.botservice.models module¶

exception azure.mgmt.botservice.models.ErrorException(deserialize, response, *args)[source]¶

Bases: msrest.exceptions.HttpOperationError

Server responsed with exception of type: ‘Error’.

Parameters

deserialize – A deserializer
response – Server response to be deserialized.

class azure.mgmt.botservice.models.Sku(*, name, **kwargs)[source]¶

Bases: msrest.serialization.Model

The SKU of the cognitive services account.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters: name (str or SkuName) – Required. The sku name. Possible values include: ‘F0’, ‘S1’
Variables: tier (str or SkuTier) – Gets the sku tier. This is based on the SKU name. Possible values include: ‘Free’, ‘Standard’

class azure.mgmt.botservice.models.Resource(*, location: str = None, tags=None, sku=None, kind=None, etag: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Azure resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Specifies the resource ID.
name (str) – Specifies the name of the resource.
type (str) – Specifies the type of the resource.

Parameters

location (str) – Specifies the location of the resource.
tags (dict[str, str]) – Contains resource tags defined as key/value pairs.
sku (Sku) – Gets or sets the SKU of the resource.
kind (str or Kind) – Required. Gets or sets the Kind of the resource. Possible values include: ‘sdk’, ‘designer’, ‘bot’, ‘function’
etag (str) – Entity Tag

class azure.mgmt.botservice.models.BotProperties(*, display_name: str, endpoint: str, msa_app_id: str, description: str = None, icon_url: str = None, developer_app_insight_key: str = None, developer_app_insights_api_key: str = None, developer_app_insights_application_id: str = None, luis_app_ids=None, luis_key: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The parameters to provide for the Bot.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

display_name (str) – Required. The Name of the bot
description (str) – The description of the bot
icon_url (str) – The Icon Url of the bot
endpoint (str) – Required. The bot’s endpoint
msa_app_id (str) – Required. Microsoft App Id for the bot
developer_app_insight_key (str) – The Application Insights key
developer_app_insights_api_key (str) – The Application Insights Api Key
developer_app_insights_application_id (str) – The Application Insights App Id
luis_app_ids (list[str]) – Collection of LUIS App Ids
luis_key (str) – The LUIS Key

Variables

endpoint_version (str) – The bot’s endpoint version
configured_channels (list[str]) – Collection of channels for which the bot is configured
enabled_channels (list[str]) – Collection of channels for which the bot is enabled

class azure.mgmt.botservice.models.Bot(*, location: str = None, tags=None, sku=None, kind=None, etag: str = None, properties=None, **kwargs)[source]¶

Bases: azure.mgmt.botservice.models.resource_py3.Resource

Bot resource definition.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Specifies the resource ID.
name (str) – Specifies the name of the resource.
type (str) – Specifies the type of the resource.

Parameters

location (str) – Specifies the location of the resource.
tags (dict[str, str]) – Contains resource tags defined as key/value pairs.
sku (Sku) – Gets or sets the SKU of the resource.
kind (str or Kind) – Required. Gets or sets the Kind of the resource. Possible values include: ‘sdk’, ‘designer’, ‘bot’, ‘function’
etag (str) – Entity Tag
properties (BotProperties) – The set of properties specific to bot resource

class azure.mgmt.botservice.models.Channel(**kwargs)[source]¶

Bases: msrest.serialization.Model

Channel definition.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: FacebookChannel, EmailChannel, MsTeamsChannel, SkypeChannel, KikChannel, WebChatChannel, DirectLineChannel, TelegramChannel, SmsChannel, SlackChannel

All required parameters must be populated in order to send to Azure.

Parameters: channel_name (str) – Required. Constant filled by server.

class azure.mgmt.botservice.models.BotChannel(*, location: str = None, tags=None, sku=None, kind=None, etag: str = None, properties=None, **kwargs)[source]¶

Bases: azure.mgmt.botservice.models.resource_py3.Resource

Bot channel resource definition.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Specifies the resource ID.
name (str) – Specifies the name of the resource.
type (str) – Specifies the type of the resource.

Parameters

location (str) – Specifies the location of the resource.
tags (dict[str, str]) – Contains resource tags defined as key/value pairs.
sku (Sku) – Gets or sets the SKU of the resource.
kind (str or Kind) – Required. Gets or sets the Kind of the resource. Possible values include: ‘sdk’, ‘designer’, ‘bot’, ‘function’
etag (str) – Entity Tag
properties (Channel) – The set of properties specific to bot channel resource

class azure.mgmt.botservice.models.FacebookPage(*, id: str, access_token: str, **kwargs)[source]¶

Bases: msrest.serialization.Model

A Facebook page for Facebook channel registration.

All required parameters must be populated in order to send to Azure.

Parameters

id (str) – Required. Page id
access_token (str) – Required. Facebook application access token. Value only returned through POST to the action Channel List API, otherwise empty.

class azure.mgmt.botservice.models.FacebookChannelProperties(*, app_id: str, app_secret: str, is_enabled: bool, pages=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The parameters to provide for the Facebook channel.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

verify_token (str) – Verify token. Value only returned through POST to the action Channel List API, otherwise empty.
callback_url (str) – Callback Url

Parameters

pages (list[FacebookPage]) – The list of Facebook pages
app_id (str) – Required. Facebook application id
app_secret (str) – Required. Facebook application secret. Value only returned through POST to the action Channel List API, otherwise empty.
is_enabled (bool) – Required. Whether this channel is enabled for the bot

class azure.mgmt.botservice.models.FacebookChannel(*, properties=None, **kwargs)[source]¶

Bases: azure.mgmt.botservice.models.channel_py3.Channel

Facebook channel definition.

All required parameters must be populated in order to send to Azure.

Parameters

channel_name (str) – Required. Constant filled by server.
properties (FacebookChannelProperties) – The set of properties specific to bot facebook channel

class azure.mgmt.botservice.models.EmailChannelProperties(*, email_address: str, password: str, is_enabled: bool, **kwargs)[source]¶

Bases: msrest.serialization.Model

The parameters to provide for the Email channel.

All required parameters must be populated in order to send to Azure.

Parameters

email_address (str) – Required. The email address
password (str) – Required. The password for the email address. Value only returned through POST to the action Channel List API, otherwise empty.
is_enabled (bool) – Required. Whether this channel is enabled for the bot

class azure.mgmt.botservice.models.EmailChannel(*, properties=None, **kwargs)[source]¶

Bases: azure.mgmt.botservice.models.channel_py3.Channel

Email channel definition.

All required parameters must be populated in order to send to Azure.

Parameters

channel_name (str) – Required. Constant filled by server.
properties (EmailChannelProperties) – The set of properties specific to email channel resource

class azure.mgmt.botservice.models.MsTeamsChannelProperties(*, is_enabled: bool, enable_calling: bool = None, calling_web_hook: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The parameters to provide for the Microsoft Teams channel.

All required parameters must be populated in order to send to Azure.

Parameters

enable_calling (bool) – Enable calling for Microsoft Teams channel
calling_web_hook (str) – Webhook for Microsoft Teams channel calls
is_enabled (bool) – Required. Whether this channel is enabled for the bot

class azure.mgmt.botservice.models.MsTeamsChannel(*, properties=None, **kwargs)[source]¶

Bases: azure.mgmt.botservice.models.channel_py3.Channel

Microsoft Teams channel definition.

All required parameters must be populated in order to send to Azure.

Parameters

channel_name (str) – Required. Constant filled by server.
properties (MsTeamsChannelProperties) – The set of properties specific to Microsoft Teams channel resource

class azure.mgmt.botservice.models.SkypeChannelProperties(*, is_enabled: bool, enable_messaging: bool = None, enable_media_cards: bool = None, enable_video: bool = None, enable_calling: bool = None, enable_screen_sharing: bool = None, enable_groups: bool = None, groups_mode: str = None, calling_web_hook: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The parameters to provide for the Microsoft Teams channel.

All required parameters must be populated in order to send to Azure.

Parameters

enable_messaging (bool) – Enable messaging for Skype channel
enable_media_cards (bool) – Enable media cards for Skype channel
enable_video (bool) – Enable video for Skype channel
enable_calling (bool) – Enable calling for Skype channel
enable_screen_sharing (bool) – Enable screen sharing for Skype channel
enable_groups (bool) – Enable groups for Skype channel
groups_mode (str) – Group mode for Skype channel
calling_web_hook (str) – Calling web hook for Skype channel
is_enabled (bool) – Required. Whether this channel is enabled for the bot

class azure.mgmt.botservice.models.SkypeChannel(*, properties=None, **kwargs)[source]¶

Bases: azure.mgmt.botservice.models.channel_py3.Channel

Skype channel definition.

All required parameters must be populated in order to send to Azure.

Parameters

channel_name (str) – Required. Constant filled by server.
properties (SkypeChannelProperties) – The set of properties specific to Skype channel resource

class azure.mgmt.botservice.models.KikChannelProperties(*, user_name: str, api_key: str, is_enabled: bool, is_validated: bool = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The parameters to provide for the Kik channel.

All required parameters must be populated in order to send to Azure.

Parameters

user_name (str) – Required. The Kik user name
api_key (str) – Required. Kik API key. Value only returned through POST to the action Channel List API, otherwise empty.
is_validated (bool) – Whether this channel is validated for the bot
is_enabled (bool) – Required. Whether this channel is enabled for the bot

class azure.mgmt.botservice.models.KikChannel(*, properties=None, **kwargs)[source]¶

Bases: azure.mgmt.botservice.models.channel_py3.Channel

Kik channel definition.

All required parameters must be populated in order to send to Azure.

Parameters

channel_name (str) – Required. Constant filled by server.
properties (KikChannelProperties) – The set of properties specific to Kik channel resource

class azure.mgmt.botservice.models.WebChatSite(*, site_name: str, is_enabled: bool, enable_preview: bool, **kwargs)[source]¶

Bases: msrest.serialization.Model

A site for the Webchat channel.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

site_id (str) – Site Id
key (str) – Primary key. Value only returned through POST to the action Channel List API, otherwise empty.
key2 (str) – Secondary key. Value only returned through POST to the action Channel List API, otherwise empty.

Parameters

site_name (str) – Required. Site name
is_enabled (bool) – Required. Whether this site is enabled for DirectLine channel
enable_preview (bool) – Required. Whether this site is enabled for preview versions of Webchat

class azure.mgmt.botservice.models.WebChatChannelProperties(*, sites=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The parameters to provide for the Web Chat channel.

Variables are only populated by the server, and will be ignored when sending a request.

Variables: web_chat_embed_code (str) – Web chat control embed code
Parameters: sites (list[WebChatSite]) – The list of Web Chat sites

class azure.mgmt.botservice.models.WebChatChannel(*, properties=None, **kwargs)[source]¶

Bases: azure.mgmt.botservice.models.channel_py3.Channel

Web Chat channel definition.

All required parameters must be populated in order to send to Azure.

Parameters

channel_name (str) – Required. Constant filled by server.
properties (WebChatChannelProperties) – The set of properties specific to Web Chat channel resource

class azure.mgmt.botservice.models.DirectLineSite(*, site_name: str, is_enabled: bool, is_v1_enabled: bool, is_v3_enabled: bool, is_secure_site_enabled: bool = None, trusted_origins=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

A site for the Direct Line channel.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

site_id (str) – Site Id
key (str) – Primary key. Value only returned through POST to the action Channel List API, otherwise empty.
key2 (str) – Secondary key. Value only returned through POST to the action Channel List API, otherwise empty.

Parameters

site_name (str) – Required. Site name
is_enabled (bool) – Required. Whether this site is enabled for DirectLine channel.
is_v1_enabled (bool) – Required. Whether this site is enabled for Bot Framework V1 protocol.
is_v3_enabled (bool) – Required. Whether this site is enabled for Bot Framework V1 protocol.
is_secure_site_enabled (bool) – Whether this site is enabled for authentication with Bot Framework.
trusted_origins (list[str]) – List of Trusted Origin URLs for this site. This field is applicable only if isSecureSiteEnabled is True.

class azure.mgmt.botservice.models.DirectLineChannelProperties(*, sites=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The parameters to provide for the Direct Line channel.

Parameters: sites (list[DirectLineSite]) – The list of Direct Line sites

class azure.mgmt.botservice.models.DirectLineChannel(*, properties=None, **kwargs)[source]¶

Bases: azure.mgmt.botservice.models.channel_py3.Channel

Direct Line channel definition.

All required parameters must be populated in order to send to Azure.

Parameters

channel_name (str) – Required. Constant filled by server.
properties (DirectLineChannelProperties) – The set of properties specific to Direct Line channel resource

class azure.mgmt.botservice.models.TelegramChannelProperties(*, access_token: str, is_enabled: bool, is_validated: bool = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The parameters to provide for the Telegram channel.

All required parameters must be populated in order to send to Azure.

Parameters

access_token (str) – Required. The Telegram access token. Value only returned through POST to the action Channel List API, otherwise empty.
is_validated (bool) – Whether this channel is validated for the bot
is_enabled (bool) – Required. Whether this channel is enabled for the bot

class azure.mgmt.botservice.models.TelegramChannel(*, properties=None, **kwargs)[source]¶

Bases: azure.mgmt.botservice.models.channel_py3.Channel

Telegram channel definition.

All required parameters must be populated in order to send to Azure.

Parameters

channel_name (str) – Required. Constant filled by server.
properties (TelegramChannelProperties) – The set of properties specific to Telegram channel resource

class azure.mgmt.botservice.models.SmsChannelProperties(*, phone: str, account_sid: str, auth_token: str, is_enabled: bool, is_validated: bool = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The parameters to provide for the Sms channel.

All required parameters must be populated in order to send to Azure.

Parameters

phone (str) – Required. The Sms phone
account_sid (str) – Required. The Sms account SID. Value only returned through POST to the action Channel List API, otherwise empty.
auth_token (str) – Required. The Sms auth token. Value only returned through POST to the action Channel List API, otherwise empty.
is_validated (bool) – Whether this channel is validated for the bot
is_enabled (bool) – Required. Whether this channel is enabled for the bot

class azure.mgmt.botservice.models.SmsChannel(*, properties=None, **kwargs)[source]¶

Bases: azure.mgmt.botservice.models.channel_py3.Channel

Sms channel definition.

All required parameters must be populated in order to send to Azure.

Parameters

channel_name (str) – Required. Constant filled by server.
properties (SmsChannelProperties) – The set of properties specific to Sms channel resource

class azure.mgmt.botservice.models.SlackChannelProperties(*, client_id: str, client_secret: str, verification_token: str, is_enabled: bool, landing_page_url: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The parameters to provide for the Slack channel.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

client_id (str) – Required. The Slack client id
client_secret (str) – Required. The Slack client secret. Value only returned through POST to the action Channel List API, otherwise empty.
verification_token (str) – Required. The Slack verification token. Value only returned through POST to the action Channel List API, otherwise empty.
landing_page_url (str) – The Slack landing page Url
is_enabled (bool) – Required. Whether this channel is enabled for the bot

Variables

redirect_action (str) – The Slack redirect action
last_submission_id (str) – The Sms auth token
register_before_oauth_flow (bool) – Whether to register the settings before OAuth validation is performed. Recommended to True.
is_validated (bool) – Whether this channel is validated for the bot

class azure.mgmt.botservice.models.SlackChannel(*, properties=None, **kwargs)[source]¶

Bases: azure.mgmt.botservice.models.channel_py3.Channel

Slack channel definition.

All required parameters must be populated in order to send to Azure.

Parameters

channel_name (str) – Required. Constant filled by server.
properties (SlackChannelProperties) – The set of properties specific to Slack channel resource

class azure.mgmt.botservice.models.ConnectionItemName(**kwargs)[source]¶

Bases: msrest.serialization.Model

The display name of a connection Item Setting registered with the Bot.

Variables are only populated by the server, and will be ignored when sending a request.

Variables: name (str) – Connection Item name that has been added in the API

class azure.mgmt.botservice.models.ConnectionSettingParameter(*, key: str = None, value: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Extra Parameter in a Connection Setting Properties to indicate service provider specific properties.

Parameters

key (str) – Key for the Connection Setting Parameter.
value (str) – Value associated with the Connection Setting Parameter.

class azure.mgmt.botservice.models.ConnectionSettingProperties(*, client_id: str = None, client_secret: str = None, scopes: str = None, service_provider_id: str = None, service_provider_display_name: str = None, parameters=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Properties for a Connection Setting Item.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters

client_id (str) – Client Id associated with the Connection Setting.
client_secret (str) – Client Secret associated with the Connection Setting
scopes (str) – Scopes associated with the Connection Setting
service_provider_id (str) – Service Provider Id associated with the Connection Setting
service_provider_display_name (str) – Service Provider Display Name associated with the Connection Setting
parameters (list[ConnectionSettingParameter]) – Service Provider Parameters associated with the Connection Setting

Variables

setting_id (str) – Setting Id set by the service for the Connection Setting.

class azure.mgmt.botservice.models.ConnectionSetting(*, location: str = None, tags=None, sku=None, kind=None, etag: str = None, properties=None, **kwargs)[source]¶

Bases: azure.mgmt.botservice.models.resource_py3.Resource

Bot channel resource definition.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Specifies the resource ID.
name (str) – Specifies the name of the resource.
type (str) – Specifies the type of the resource.

Parameters

location (str) – Specifies the location of the resource.
tags (dict[str, str]) – Contains resource tags defined as key/value pairs.
sku (Sku) – Gets or sets the SKU of the resource.
kind (str or Kind) – Required. Gets or sets the Kind of the resource. Possible values include: ‘sdk’, ‘designer’, ‘bot’, ‘function’
etag (str) – Entity Tag
properties (ConnectionSettingProperties) – The set of properties specific to bot channel resource

class azure.mgmt.botservice.models.ServiceProviderParameter(**kwargs)[source]¶

Bases: msrest.serialization.Model

Extra Parameters specific to each Service Provider.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

name (str) – Name of the Service Provider
type (str) – Type of the Service Provider
display_name (str) – Display Name of the Service Provider
description (str) – Description of the Service Provider
help_url (str) – Help Url for the Service Provider
default (str) – Default Name for the Service Provider

class azure.mgmt.botservice.models.ServiceProviderProperties(*, parameters=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The Object used to describe a Service Provider supported by Bot Service.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Id for Service Provider
display_name (str) – Display Name of the Service Provider
service_provider_name (str) – Display Name of the Service Provider
dev_portal_url (str) – Display Name of the Service Provider
icon_url (str) – Display Name of the Service Provider

Parameters

parameters (list[ServiceProviderParameter]) – The list of parameters for the Service Provider

class azure.mgmt.botservice.models.ServiceProvider(*, properties=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Service Provider Definition.

Parameters: properties (ServiceProviderProperties) – The Properties of a Service Provider Object

class azure.mgmt.botservice.models.ServiceProviderResponseList(*, next_link: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The list of bot service service providers response.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters: next_link (str) – The link used to get the next page of bot service service providers.
Variables: value (list[ServiceProvider]) – Gets the list of bot service service providers and their properties.

class azure.mgmt.botservice.models.ErrorBody(*, code: str, message: str, **kwargs)[source]¶

Bases: msrest.serialization.Model

Bot Service error body.

All required parameters must be populated in order to send to Azure.

Parameters

code (str) – Required. error code
message (str) – Required. error message

class azure.mgmt.botservice.models.Error(*, error=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Bot Service error object.

Parameters: error (ErrorBody) – The error body.

class azure.mgmt.botservice.models.OperationDisplayInfo(*, description: str = None, operation: str = None, provider: str = None, resource: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The operation supported by Bot Service Management.

Parameters

description (str) – The description of the operation.
operation (str) – The action that users can perform, based on their permission level.
provider (str) – Service provider: Microsoft Bot Service.
resource (str) – Resource on which the operation is performed.

class azure.mgmt.botservice.models.OperationEntity(*, name: str = None, display=None, origin: str = None, properties=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The operations supported by Bot Service Management.

Parameters

name (str) – Operation name: {provider}/{resource}/{operation}.
display (OperationDisplayInfo) – The operation supported by Bot Service Management.
origin (str) – The origin of the operation.
properties (object) – Additional properties.

class azure.mgmt.botservice.models.CheckNameAvailabilityRequestBody(*, name: str = None, type: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The request body for a request to Bot Service Management to check availability of a bot name.

Parameters

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

class azure.mgmt.botservice.models.CheckNameAvailabilityResponseBody(*, valid: bool = None, message: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The response body returned for a request to Bot Service Management to check availability of a bot name.

Parameters

valid (bool) – indicates if the bot name is valid.
message (str) – additional message from the bot management api showing why a bot name is not available

class azure.mgmt.botservice.models.EnterpriseChannelCheckNameAvailabilityRequest(*, name: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

A request to Bot Service Management to check availability of an Enterprise Channel name.

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

class azure.mgmt.botservice.models.EnterpriseChannelCheckNameAvailabilityResponse(*, valid: bool = None, message: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

A request to Bot Service Management to check availability of an Enterprise Channel name.

Parameters

valid (bool) – Indicates if the Enterprise Channel name is valid.
message (str) – Additional information about why a bot name is not available.

class azure.mgmt.botservice.models.EnterpriseChannelNode(*, name: str, azure_sku: str, azure_location: str, state=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The properties specific to an Enterprise Channel Node.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – Id of Enterprise Channel Node. This is generated by the Bot Framework.

Parameters

state (str or EnterpriseChannelNodeState) – The current state of the Enterprise Channel Node. Possible values include: ‘Creating’, ‘CreateFailed’, ‘Started’, ‘Starting’, ‘StartFailed’, ‘Stopped’, ‘Stopping’, ‘StopFailed’, ‘Deleting’, ‘DeleteFailed’
name (str) – Required. The name of the Enterprise Channel Node.
azure_sku (str) – Required. The sku of the Enterprise Channel Node.
azure_location (str) – Required. The location of the Enterprise Channel Node.

class azure.mgmt.botservice.models.EnterpriseChannelProperties(*, nodes, state=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The parameters to provide for the Enterprise Channel.

All required parameters must be populated in order to send to Azure.

Parameters

state (str or EnterpriseChannelState) – The current state of the Enterprise Channel. Possible values include: ‘Creating’, ‘CreateFailed’, ‘Started’, ‘Starting’, ‘StartFailed’, ‘Stopped’, ‘Stopping’, ‘StopFailed’, ‘Deleting’, ‘DeleteFailed’
nodes (list[EnterpriseChannelNode]) – Required. The nodes associated with the Enterprise Channel.

class azure.mgmt.botservice.models.EnterpriseChannel(*, location: str = None, tags=None, sku=None, kind=None, etag: str = None, properties=None, **kwargs)[source]¶

Bases: azure.mgmt.botservice.models.resource_py3.Resource

Enterprise Channel resource definition.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Specifies the resource ID.
name (str) – Specifies the name of the resource.
type (str) – Specifies the type of the resource.

Parameters

location (str) – Specifies the location of the resource.
tags (dict[str, str]) – Contains resource tags defined as key/value pairs.
sku (Sku) – Gets or sets the SKU of the resource.
kind (str or Kind) – Required. Gets or sets the Kind of the resource. Possible values include: ‘sdk’, ‘designer’, ‘bot’, ‘function’
etag (str) – Entity Tag
properties (EnterpriseChannelProperties) – The set of properties specific to an Enterprise Channel resource.

class azure.mgmt.botservice.models.BotPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of Bot object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.botservice.models.BotChannelPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of BotChannel object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.botservice.models.OperationEntityPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of OperationEntity object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.botservice.models.ConnectionSettingPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of ConnectionSetting object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.botservice.models.EnterpriseChannelPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of EnterpriseChannel object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.botservice.models.SkuName[source]¶

Bases: str, enum.Enum

An enumeration.

f0 = 'F0'¶

s1 = 'S1'¶

class azure.mgmt.botservice.models.SkuTier[source]¶

Bases: str, enum.Enum

An enumeration.

free = 'Free'¶

standard = 'Standard'¶

class azure.mgmt.botservice.models.Kind[source]¶

Bases: str, enum.Enum

An enumeration.

bot = 'bot'¶

designer = 'designer'¶

function = 'function'¶

sdk = 'sdk'¶

class azure.mgmt.botservice.models.EnterpriseChannelState[source]¶

Bases: str, enum.Enum

An enumeration.

create_failed = 'CreateFailed'¶

creating = 'Creating'¶

delete_failed = 'DeleteFailed'¶

deleting = 'Deleting'¶

start_failed = 'StartFailed'¶

started = 'Started'¶

starting = 'Starting'¶

stop_failed = 'StopFailed'¶

stopped = 'Stopped'¶

stopping = 'Stopping'¶

class azure.mgmt.botservice.models.EnterpriseChannelNodeState[source]¶

Bases: str, enum.Enum

An enumeration.

create_failed = 'CreateFailed'¶

creating = 'Creating'¶

delete_failed = 'DeleteFailed'¶

deleting = 'Deleting'¶

start_failed = 'StartFailed'¶

started = 'Started'¶

starting = 'Starting'¶

stop_failed = 'StopFailed'¶

stopped = 'Stopped'¶

stopping = 'Stopping'¶

class azure.mgmt.botservice.models.ChannelName[source]¶

Bases: str, enum.Enum

An enumeration.

direct_line_channel = 'DirectLineChannel'¶

email_channel = 'EmailChannel'¶

facebook_channel = 'FacebookChannel'¶

kik_channel = 'KikChannel'¶

ms_teams_channel = 'MsTeamsChannel'¶

skype_channel = 'SkypeChannel'¶

slack_channel = 'SlackChannel'¶

sms_channel = 'SmsChannel'¶

telegram_channel = 'TelegramChannel'¶

web_chat_channel = 'WebChatChannel'¶