BotProperties Class

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.

Inheritance

azure.mgmt.botservice._serialization.Model

BotProperties

Constructor

BotProperties(*, display_name: str, endpoint: str, msa_app_id: str, description: str | None = None, icon_url: str = '', all_settings: Dict[str, str] | None = None, parameters: Dict[str, str] | None = None, manifest_url: str | None = None, msa_app_type: str | _models.MsaAppType | None = None, msa_app_tenant_id: str | None = None, msa_app_msi_resource_id: str | None = None, developer_app_insight_key: str | None = None, developer_app_insights_api_key: str | None = None, developer_app_insights_application_id: str | None = None, luis_app_ids: List[str] | None = None, luis_key: str | None = None, is_cmek_enabled: bool = False, cmek_key_vault_url: str | None = None, tenant_id: str | None = None, public_network_access: str | _models.PublicNetworkAccess = 'Enabled', is_streaming_supported: bool = False, disable_local_auth: bool | None = None, schema_transformation_version: str | None = None, storage_resource_id: str | None = None, open_with_hint: str | None = None, app_password_hint: str | None = None, publishing_credentials: str | None = None, **kwargs)

Keyword-Only Parameters

Name	Description
display_name	str The Name of the bot. Required.
description	str The description of the bot.
icon_url	str The Icon Url of the bot.
endpoint	str The bot's endpoint. Required.
all_settings	dict[str, str] Contains resource all settings defined as key/value pairs.
parameters	dict[str, str] Contains resource parameters defined as key/value pairs.
manifest_url	str The bot's manifest url.
msa_app_type	str or MsaAppType Microsoft App Type for the bot. Known values are: "UserAssignedMSI", "SingleTenant", and "MultiTenant".
msa_app_id	str Microsoft App Id for the bot. Required.
msa_app_tenant_id	str Microsoft App Tenant Id for the bot.
msa_app_msi_resource_id	str Microsoft App Managed Identity Resource Id for the bot.
developer_app_insight_key	str The Application Insights key.
developer_app_insights_api_key	str The Application Insights Api Key.
developer_app_insights_application_id	str The Application Insights App Id.
luis_app_ids	list[str] Collection of LUIS App Ids.
luis_key	str The LUIS Key.
is_cmek_enabled	bool Whether Cmek is enabled.
cmek_key_vault_url	str The CMK Url.
tenant_id	str The Tenant Id for the bot.
public_network_access	str or PublicNetworkAccess Whether the bot is in an isolated network. Known values are: "Enabled" and "Disabled". default value: Enabled
is_streaming_supported	bool Whether the bot is streaming supported.
disable_local_auth	bool Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
schema_transformation_version	str The channel schema transformation version for the bot.
storage_resource_id	str The storage resourceId for the bot.
open_with_hint	str The hint to browser (e.g. protocol handler) on how to open the bot for authoring.
app_password_hint	str The hint (e.g. keyVault secret resourceId) on how to fetch the app secret.
publishing_credentials	str Publishing credentials of the resource.

Variables

Name	Description
display_name	str The Name of the bot. Required.
description	str The description of the bot.
icon_url	str The Icon Url of the bot.
endpoint	str The bot's endpoint. Required.
endpoint_version	str The bot's endpoint version.
all_settings	dict[str, str] Contains resource all settings defined as key/value pairs.
parameters	dict[str, str] Contains resource parameters defined as key/value pairs.
manifest_url	str The bot's manifest url.
msa_app_type	str or MsaAppType Microsoft App Type for the bot. Known values are: "UserAssignedMSI", "SingleTenant", and "MultiTenant".
msa_app_id	str Microsoft App Id for the bot. Required.
msa_app_tenant_id	str Microsoft App Tenant Id for the bot.
msa_app_msi_resource_id	str Microsoft App Managed Identity Resource Id for the bot.
configured_channels	list[str] Collection of channels for which the bot is configured.
enabled_channels	list[str] Collection of channels for which the bot is enabled.
developer_app_insight_key	str The Application Insights key.
developer_app_insights_api_key	str The Application Insights Api Key.
developer_app_insights_application_id	str The Application Insights App Id.
luis_app_ids	list[str] Collection of LUIS App Ids.
luis_key	str The LUIS Key.
is_cmek_enabled	bool Whether Cmek is enabled.
cmek_key_vault_url	str The CMK Url.
cmek_encryption_status	str The CMK encryption status.
tenant_id	str The Tenant Id for the bot.
public_network_access	str or PublicNetworkAccess Whether the bot is in an isolated network. Known values are: "Enabled" and "Disabled".
is_streaming_supported	bool Whether the bot is streaming supported.
is_developer_app_insights_api_key_set	bool Whether the bot is developerAppInsightsApiKey set.
migration_token	str Token used to migrate non Azure bot to azure subscription.
disable_local_auth	bool Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
schema_transformation_version	str The channel schema transformation version for the bot.
storage_resource_id	str The storage resourceId for the bot.
private_endpoint_connections	list[PrivateEndpointConnection] List of Private Endpoint Connections configured for the bot.
open_with_hint	str The hint to browser (e.g. protocol handler) on how to open the bot for authoring.
app_password_hint	str The hint (e.g. keyVault secret resourceId) on how to fetch the app secret.
provisioning_state	str Provisioning state of the resource.
publishing_credentials	str Publishing credentials of the resource.