【Azure Bot Service】在中国区Azure上部署机器人的 Python 版配置

问题描述

在中国区Azure上使用Azure Bot Service服务，入门教程中创建机器人由四种语言的SDK可以选择（C#, Java， JavaScript 和 Python ， 并且Java SDK也已经停用），所以可选的只有三种。

当选择使用Python SDK后，根据入门文档(使用 Bot Framework SDK 创建机器人：https://docs.azure.cn/zh-cn/bot-service/bot-service-quickstart-create-bot?view=azure-bot-service-4.0&tabs=python%2Cvs)本地测试通过，当需要把配置到中国区的Azure时候，却发现没有Python的配置介绍。

不用怕，本文就是来弥补Python SDK需要设置的参数！

问题解答

根据配置Azure Bot Service的文档步骤，也是需要配置云适配器来构建 Adapter对象

第一部分：使用 CloudAdapter 并加载配置文件config.py

from botbuilder.core import (
    TurnContext,
)
from botbuilder.core.integration import aiohttp_error_middleware
from botbuilder.integration.aiohttp import CloudAdapter, ConfigurationBotFrameworkAuthentication
from botbuilder.schema import Activity, ActivityTypes
from config import DefaultConfig

....


CONFIG = DefaultConfig()
ADAPTER = CloudAdapter(ConfigurationBotFrameworkAuthentication(CONFIG))

第二部分：在 config.py 中添加如下配置项

import os

""" Bot Configuration """


class DefaultConfig:
    """ Bot Configuration """

    PORT = 3978
    
    APP_ID = os.environ.get("MicrosoftAppId", "your application id")    
    APP_PASSWORD = os.environ.get("MicrosoftAppPassword", "application secret value")
    APP_TYPE = os.environ.get("MicrosoftAppType", "MultiTenant")
    # APP_TYPE = os.environ.get("MicrosoftAppType", "SingleTenant")
    APP_TENANTID = os.environ.get("MicrosoftAppTenantId", "")

    OAUTH_URL = os.environ.get("OAuthUrl", "https://token.botframework.azure.cn/")
    TO_BOT_FROM_CHANNEL_TOKEN_ISSUER = os.environ.get("ToBotFromChannelTokenIssuer", "https://api.botframework.azure.cn")

    TO_BOT_FROM_CHANNEL_OPENID_METADATA_URL = os.environ.get("ToBotFromChannelOpenIdMetadataUrl", "https://login.botframework.azure.cn/v1/.well-known/openidconfiguration")
    TO_BOT_FROM_EMULATOR_OPENID_METADATA_URL = os.environ.get("ToBotFromEmulatorOpenIdMetadataUrl", "https://login.partner.microsoftonline.cn/<your tenant id>/v2.0/.well-known/openid-configuration")

    TO_CHANNEL_FROM_BOT_LOGIN_URL = os.environ.get("ToChannelFromBotLoginUrl","https://login.partner.microsoftonline.cn/<your tenant id>")
    #TO_CHANNEL_FROM_BOT_LOGIN_URL = os.environ.get("ToChannelFromBotLoginUrl","https://login.partner.microsoftonline.cn/microsoftservices.partner.onmschina.cn") #For Multi Tenant
    TO_CHANNEL_FROM_BOT_OAUTH_SCOPE = os.environ.get("ToChannelFromBotOAuthScope", "https://api.botframework.azure.cn")
    
    VALIDATE_AUTHORITY = os.environ.get("ValidateAuthority", "true")

以上参数的值与C#和JavaScript一样，主要的问题是需要找到正确的参数名称 （上面的参数名称均是根据SDK的源码和参考文档中寻找）

参考资料

使用 Bot Framework SDK 创建机器人：https://docs.azure.cn/zh-cn/bot-service/bot-service-quickstart-create-bot?view=azure-bot-service-4.0&tabs=python%2Cvs

在由世纪互联运营的 Microsoft Azure 中配置机器人：https://learn.microsoft.com/zh-cn/azure/bot-service/how-to-deploy-china-cloud?view=azure-bot-service-4.0&tabs=javascript#configure-multitenant-bot

BotFrameworkAuthenticationFactory 类：https://learn.microsoft.com/zh-cn/python/api/botframework-connector/botframework.connector.auth.bot_framework_authentication_factory.botframeworkauthenticationfactory?view=botbuilder-py-latest