Package: azure-mgmt-botservice
Microsoft Azure SDK for PythonThis is the Microsoft Azure Bot Service Client Library.
This package has been tested with Python 3.7+.
For a more complete view of Azure libraries, see theazure sdk python release.DisclaimerAzure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, please refer tohttps://github.com/Azure/azure-sdk-for-python/issues/20691Getting startedPrerequisitesPython 3.7+ is required to use this package.Azure subscriptionInstall the packagepipinstallazure-mgmt-botservice
pipinstallazure-identityAuthenticationBy default,Azure Active Directorytoken authentication depends on correct configure of following environment variables.AZURE_CLIENT_IDfor Azure client ID.AZURE_TENANT_IDfor Azure tenant ID.AZURE_CLIENT_SECRETfor Azure client secret.In addition, Azure subscription ID can be configured via environment variableAZURE_SUBSCRIPTION_ID.With above configuration, client can be authenticated by following code:fromazure.identityimportDefaultAzureCredentialfromazure.mgmt.botserviceimportAzureBotServiceimportossub_id=os.getenv("AZURE_SUBSCRIPTION_ID")client=AzureBotService(credential=DefaultAzureCredential(),subscription_id=sub_id)ExamplesCode samples for this package can be found atBot Serviceon docs.microsoft.com andSamples RepoTroubleshootingNext stepsProvide FeedbackIf you encounter any bugs or have suggestions, please file an issue in theIssuessection of the project.Release History2.0.0 (2023-01-12)Features AddedAdded operation group EmailOperationsAdded operation group OperationResultsOperationsAdded operation group PrivateEndpointConnectionsOperationsAdded operation group PrivateLinkResourcesOperationsAdded operation group QnAMakerEndpointKeysOperationsModel AlexaChannel has a new parameter etagModel AlexaChannel has a new parameter locationModel AlexaChannel has a new parameter provisioning_stateModel Bot has a new parameter zonesModel BotChannel has a new parameter zonesModel BotProperties has a new parameter all_settingsModel BotProperties has a new parameter app_password_hintModel BotProperties has a new parameter cmek_encryption_statusModel BotProperties has a new parameter disable_local_authModel BotProperties has a new parameter is_developer_app_insights_api_key_setModel BotProperties has a new parameter is_streaming_supportedModel BotProperties has a new parameter manifest_urlModel BotProperties has a new parameter migration_tokenModel BotProperties has a new parameter msa_app_msi_resource_idModel BotProperties has a new parameter msa_app_tenant_idModel BotProperties has a new parameter msa_app_typeModel BotProperties has a new parameter open_with_hintModel BotProperties has a new parameter parametersModel BotProperties has a new parameter private_endpoint_connectionsModel BotProperties has a new parameter provisioning_stateModel BotProperties has a new parameter public_network_accessModel BotProperties has a new parameter publishing_credentialsModel BotProperties has a new parameter storage_resource_idModel BotProperties has a new parameter tenant_idModel Channel has a new parameter etagModel Channel has a new parameter locationModel Channel has a new parameter provisioning_stateModel CheckNameAvailabilityResponseBody has a new parameter abs_codeModel ConnectionSetting has a new parameter zonesModel ConnectionSettingProperties has a new parameter provisioning_stateModel DirectLineChannel has a new parameter etagModel DirectLineChannel has a new parameter locationModel DirectLineChannel has a new parameter provisioning_stateModel DirectLineChannelProperties has a new parameter direct_line_embed_codeModel DirectLineChannelProperties has a new parameter extension_key1Model DirectLineChannelProperties has a new parameter extension_key2Model DirectLineSite has a new parameter is_block_user_upload_enabledModel DirectLineSpeechChannel has a new parameter etagModel DirectLineSpeechChannel has a new parameter locationModel DirectLineSpeechChannel has a new parameter provisioning_stateModel DirectLineSpeechChannelProperties has a new parameter cognitive_service_regionModel DirectLineSpeechChannelProperties has a new parameter cognitive_service_resource_idModel DirectLineSpeechChannelProperties has a new parameter cognitive_service_subscription_keyModel EmailChannel has a new parameter etagModel EmailChannel has a new parameter locationModel EmailChannel has a new parameter provisioning_stateModel EmailChannelProperties has a new parameter auth_methodModel EmailChannelProperties has a new parameter magic_codeModel FacebookChannel has a new parameter etagModel FacebookChannel has a new parameter locationModel FacebookChannel has a new parameter provisioning_stateModel KikChannel has a new parameter etagModel KikChannel has a new parameter locationModel KikChannel has a new parameter provisioning_stateModel LineChannel has a new parameter etagModel LineChannel has a new parameter locationModel LineChannel has a new parameter provisioning_stateModel MsTeamsChannel has a new parameter etagModel MsTeamsChannel has a new parameter locationModel MsTeamsChannel has a new parameter provisioning_stateModel MsTeamsChannelProperties has a new parameter accepted_termsModel MsTeamsChannelProperties has a new parameter calling_webhookModel MsTeamsChannelProperties has a new parameter deployment_environmentModel MsTeamsChannelProperties has a new parameter incoming_call_routeModel Resource has a new parameter zonesModel ServiceProviderParameter has a new parameter metadataModel SkypeChannel has a new parameter etagModel SkypeChannel has a new parameter locationModel SkypeChannel has a new parameter provisioning_stateModel SkypeChannelProperties has a new parameter incoming_call_routeModel SlackChannel has a new parameter etagModel SlackChannel has a new parameter locationModel SlackChannel has a new parameter provisioning_stateModel SlackChannelProperties has a new parameter scopesModel SmsChannel has a new parameter etagModel SmsChannel has a new parameter locationModel SmsChannel has a new parameter provisioning_stateModel TelegramChannel has a new parameter etagModel TelegramChannel has a new parameter locationModel TelegramChannel has a new parameter provisioning_stateModel WebChatChannel has a new parameter etagModel WebChatChannel has a new parameter locationModel WebChatChannel has a new parameter provisioning_stateBreaking ChangesModel BotProperties no longer has parameter is_isolatedModel DirectLineSpeechChannelProperties no longer has parameter cognitive_services_subscription_idModel MsTeamsChannelProperties no longer has parameter calling_web_hookModel WebChatSite has a new required parameter is_webchat_preview_enabledModel WebChatSite no longer has parameter enable_preview2.0.0b4 (2022-11-30)Features AddedAdded operation group EmailOperationsAdded operation group QnAMakerEndpointKeysOperationsModel BotProperties has a new parameter tenant_idModel DirectLineChannelProperties has a new parameter extension_key1Model DirectLineChannelProperties has a new parameter extension_key2Model DirectLineSpeechChannelProperties has a new parameter cognitive_service_resource_idModel EmailChannelProperties has a new parameter auth_methodModel EmailChannelProperties has a new parameter magic_codeModel MsTeamsChannelProperties has a new parameter calling_webhookBreaking ChangesModel MsTeamsChannelProperties no longer has parameter calling_web_hook2.0.0b3 (2022-06-27)BugfixesFix multi inheritance problem for ModelSite2.0.0b2 (2022-04-15)FeaturesModel ListChannelWithKeysResponse has a new parameter changed_timeModel ListChannelWithKeysResponse has a new parameter entity_tagModel ListChannelWithKeysResponse has a new parameter provisioning_state2.0.0b1 (2022-01-10)FeaturesAdded operation group OperationResultsOperationsAdded operation group PrivateEndpointConnectionsOperationsAdded operation group PrivateLinkResourcesOperationsModel AlexaChannel has a new parameter etagModel AlexaChannel has a new parameter locationModel AlexaChannel has a new parameter provisioning_stateModel Bot has a new parameter zonesModel BotChannel has a new parameter zonesModel BotProperties has a new parameter all_settingsModel BotProperties has a new parameter app_password_hintModel BotProperties has a new parameter cmek_encryption_statusModel BotProperties has a new parameter disable_local_authModel BotProperties has a new parameter is_developer_app_insights_api_key_setModel BotProperties has a new parameter is_streaming_supportedModel BotProperties has a new parameter manifest_urlModel BotProperties has a new parameter migration_tokenModel BotProperties has a new parameter msa_app_msi_resource_idModel BotProperties has a new parameter msa_app_tenant_idModel BotProperties has a new parameter msa_app_typeModel BotProperties has a new parameter open_with_hintModel BotProperties has a new parameter parametersModel BotProperties has a new parameter private_endpoint_connectionsModel BotProperties has a new parameter provisioning_stateModel BotProperties has a new parameter public_network_accessModel BotProperties has a new parameter publishing_credentialsModel BotProperties has a new parameter storage_resource_idModel Channel has a new parameter etagModel Channel has a new parameter locationModel Channel has a new parameter provisioning_stateModel ConnectionSetting has a new parameter zonesModel ConnectionSettingProperties has a new parameter idModel ConnectionSettingProperties has a new parameter nameModel ConnectionSettingProperties has a new parameter provisioning_stateModel DirectLineChannel has a new parameter etagModel DirectLineChannel has a new parameter locationModel DirectLineChannel has a new parameter provisioning_stateModel DirectLineChannelProperties has a new parameter direct_line_embed_codeModel DirectLineSite has a new parameter is_block_user_upload_enabledModel DirectLineSpeechChannel has a new parameter etagModel DirectLineSpeechChannel has a new parameter locationModel DirectLineSpeechChannel has a new parameter provisioning_stateModel EmailChannel has a new parameter etagModel EmailChannel has a new parameter locationModel EmailChannel has a new parameter provisioning_stateModel FacebookChannel has a new parameter etagModel FacebookChannel has a new parameter locationModel FacebookChannel has a new parameter provisioning_stateModel KikChannel has a new parameter etagModel KikChannel has a new parameter locationModel KikChannel has a new parameter provisioning_stateModel LineChannel has a new parameter etagModel LineChannel has a new parameter locationModel LineChannel has a new parameter provisioning_stateModel MsTeamsChannel has a new parameter etagModel MsTeamsChannel has a new parameter locationModel MsTeamsChannel has a new parameter provisioning_stateModel MsTeamsChannelProperties has a new parameter accepted_termsModel MsTeamsChannelProperties has a new parameter deployment_environmentModel MsTeamsChannelProperties has a new parameter incoming_call_routeModel Resource has a new parameter zonesModel ServiceProviderParameter has a new parameter metadataModel SkypeChannel has a new parameter etagModel SkypeChannel has a new parameter locationModel SkypeChannel has a new parameter provisioning_stateModel SkypeChannelProperties has a new parameter incoming_call_routeModel SlackChannel has a new parameter etagModel SlackChannel has a new parameter locationModel SlackChannel has a new parameter provisioning_stateModel SlackChannelProperties has a new parameter scopesModel SmsChannel has a new parameter etagModel SmsChannel has a new parameter locationModel SmsChannel has a new parameter provisioning_stateModel TelegramChannel has a new parameter etagModel TelegramChannel has a new parameter locationModel TelegramChannel has a new parameter provisioning_stateModel WebChatChannel has a new parameter etagModel WebChatChannel has a new parameter locationModel WebChatChannel has a new parameter provisioning_stateBreaking changesModel BotProperties no longer has parameter is_isolatedModel DirectLineSpeechChannelProperties has a new required parameter cognitive_service_regionModel DirectLineSpeechChannelProperties has a new required parameter cognitive_service_subscription_keyModel DirectLineSpeechChannelProperties no longer has parameter cognitive_services_subscription_idModel WebChatSite has a new required parameter is_webchat_preview_enabledModel WebChatSite no longer has parameter enable_preview1.0.0 (2021-05-20)FeaturesModel BotProperties has a new parameter schema_transformation_versionModel BotProperties has a new parameter cmek_key_vault_urlModel BotProperties has a new parameter is_isolatedModel BotProperties has a new parameter is_cmek_enabledAdded operation group HostSettingsOperations1.0.0b1 (2020-11-20)This is beta preview version.This version uses a next-generation code generator that introduces important breaking changes, but also important new features (like unified authentication and async programming).General breaking changesCredential system has been completly revamped:azure.common.credentialsormsrestazure.azure_active_directoryinstances are no longer supported, use theazure-identityclasses instead:https://pypi.org/project/azure-identity/credentialsparameter has been renamedcredentialTheconfigattribute no longer exists on a client, configuration should be passed as kwarg. Example:MyClient(credential, subscription_id, enable_logging=True). For a complete set of
supported options, see theparameters accept in init documentation of azure-coreYou can't import aversionmodule anymore, use__version__insteadOperations that used to return amsrest.polling.LROPollernow returns aazure.core.polling.LROPollerand are prefixed withbegin_.Exceptions tree have been simplified and most exceptions are nowazure.core.exceptions.HttpResponseError(CloudErrorhas been removed).Most of the operation kwarg have changed. Some of the most noticeable:rawhas been removed. Equivalent feature can be found usingcls, a callback that will give access to internal HTTP response for advanced userFor a complete set of
supported options, see theparameters accept in Request documentation of azure-coreGeneral new featuresType annotations support usingtyping. SDKs are mypy ready.This client has now stable and official support for async. Check theaionamespace of your package to find the async client.This client now support natively tracing library like OpenCensus or OpenTelemetry. See thistracing quickstartfor an overview.0.2.0 (2019-05-21)FeaturesModel DirectLineSite has a new parameter is_secure_site_enabledModel DirectLineSite has a new parameter trusted_originsAdded operation group EnterpriseChannelsOperations0.1.0 (2018-08-07)Initial Release