你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

az bot

参考

管理 Microsoft Azure 机器人服务。

命令

名称	说明	类型	Status
az bot authsetting	管理机器人上的 OAuth 连接设置。	核心	GA
az bot authsetting create	在机器人上创建 OAuth 连接设置。	核心	GA
az bot authsetting delete	删除机器人上的 OAuth 连接设置。	核心	GA
az bot authsetting list	显示机器人上的所有 OAuth 连接设置。	核心	GA
az bot authsetting list-providers	列出可用于创建 OAuth 连接设置的所有服务提供商的详细信息。	核心	GA
az bot authsetting show	显示机器人上的 OAuth 连接设置的详细信息。	核心	GA
az bot create	创建新的 v4 SDK 机器人。	核心	GA
az bot delete	删除现有机器人。	核心	GA
az bot directline	管理机器人上的 Directline 通道。	核心	预览
az bot directline create	在仅启用 v3 协议的机器人上创建 DirectLine 通道。	核心	预览版
az bot directline delete	删除机器人上的 Directline 通道。	核心	预览
az bot directline show	获取机器人上的 Directline 通道的详细信息。	核心	预览
az bot directline update	在仅启用 v3 协议的机器人上更新 DirectLine 通道。	核心	预览
az bot download	下载现有机器人。	核心	预览版
az bot email	在机器人上管理电子邮件频道。	核心	预览版
az bot email create	在机器人上创建电子邮件频道。	核心	预览版
az bot email delete	删除机器人上的电子邮件频道。	核心	预览
az bot email show	获取机器人上的电子邮件频道的详细信息。	核心	预览
az bot facebook	管理机器人上的 Facebook 频道。	核心	预览版
az bot facebook create	在机器人上创建 Facebook 频道。	核心	预览
az bot facebook delete	删除机器人上的 Facebook 频道。	核心	预览
az bot facebook show	获取机器人上的 Facebook 频道的详细信息。	核心	预览
az bot kik	管理机器人上的 Kik 通道。	核心	预览
az bot kik create	在机器人上创建 Kik 通道。	核心	预览
az bot kik delete	删除机器人上的 Kik 通道。	核心	预览版
az bot kik show	获取机器人上的 Kik 通道的详细信息。	核心	预览
az bot msteams	在机器人上管理 Microsoft Teams 频道。	核心	预览
az bot msteams create	在机器人上创建 Microsoft Teams 频道。	核心	预览
az bot msteams delete	删除机器人上的 Microsoft Teams 频道。	核心	预览
az bot msteams show	获取机器人上的 Microsoft Teams 频道的详细信息。	核心	预览
az bot prepare-deploy	添加用于发布脚本 `az webapp deployment`/配置文件的脚本/配置文件。	核心	GA
az bot prepare-publish	（维护模式）将脚本添加到本地源代码目录，以便能够使用 `az bot publish` v3 SDK 机器人重新发布。	核心	预览版
az bot publish	发布到机器人的关联应用服务。	核心	预览
az bot show	获取现有机器人。	核心	GA
az bot skype	管理机器人上的 Skype 频道。	核心	预览
az bot skype create	在机器人上创建 Skype 频道。	核心	预览版
az bot skype delete	删除机器人上的 Skype 频道。	核心	预览
az bot skype show	获取机器人上的 Skype 频道的详细信息。	核心	预览
az bot slack	管理机器人上的 Slack 通道。	核心	预览
az bot slack create	在机器人上创建 Slack 通道。	核心	预览
az bot slack delete	删除机器人上的 Slack 通道。	核心	预览版
az bot slack show	获取机器人上的 Slack 通道的详细信息。	核心	预览
az bot sms	管理机器人上的 SMS 通道。	核心	预览
az bot sms create	在机器人上创建 SMS 通道。	核心	预览版
az bot sms delete	删除机器人上的 SMS 通道。	核心	预览
az bot sms show	获取机器人上的短信通道的详细信息。	核心	预览
az bot telegram	管理机器人上的 Telegram 频道。	核心	预览版
az bot telegram create	在机器人上创建 Telegram 通道。	核心	预览
az bot telegram delete	删除机器人上的 Telegram 通道。	核心	预览
az bot telegram show	获取机器人上的 Telegram 频道的详细信息。	核心	预览
az bot update	更新现有机器人。	核心	GA
az bot webchat	管理机器人上的 Webchat 频道。	核心	GA
az bot webchat show	获取机器人上的 Webchat 频道的详细信息。	核心	GA

az bot create

编辑

创建新的 v4 SDK 机器人。

az bot create --app-type
              --appid
              --name
              --resource-group
              [--cmk]
              [--description]
              [--display-name]
              [--endpoint]
              [--location]
              [--msi-resource-id]
              [--sku {F0, S1}]
              [--tags]
              [--tenant-id]

必需参数

--app-type

机器人的 Microsoft 应用类型。可能的值包括：“UserAssignedMSI”、“SingleTenant”、“MultiTenant”。

--appid

可以与机器人配合使用的 Microsoft 帐户 ID (MSA ID)。

--name -n

机器人的资源名称。机器人名称必须为 4 到 42 个字符长。机器人名称只能有以下字符：-、a - z、A - Z、0 - 9 和 _。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

可选参数

--cmk --cmk-key-vault-key-url

用于启用客户托管密钥加密的密钥保管库密钥 URL。

--description -d

机器人的说明。

--display-name

机器人的显示名称。如果未指定，则默认为机器人的名称。

--endpoint -e

机器人的消息传送终结点。

--location -l

位置。 az account list-locations 中的值。可以使用 az configure --defaults location=<location> 配置默认位置。

默认值: global

--msi-resource-id

机器人的 Microsoft 应用托管标识资源 ID。

--sku

机器人的 SKU。

接受的值: F0, S1

默认值: F0

--tags

空格分隔标记：key[=value] [key[=value] ...]。使用“”清除现有标记。

--tenant-id

机器人的 Microsoft 应用租户 ID。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az bot delete

编辑

删除现有机器人。

az bot delete --name
              --resource-group

必需参数

--name -n

机器人的资源名称。机器人名称必须为 4 到 42 个字符长。机器人名称只能有以下字符：-、a - z、A - Z、0 - 9 和 _。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az bot download

编辑

预览

此命令处于预览阶段，正在开发中。参考和支持级别： https://aka.ms/CLI_refstatus

下载现有机器人。

源代码是从与机器人关联的 Web 应用下载的。然后，可以对其进行更改并将其发布回应用。

az bot download --name
                --resource-group
                [--save-path]

必需参数

--name -n

机器人的资源名称。机器人名称必须为 4 到 42 个字符长。机器人名称只能有以下字符：-、a - z、A - Z、0 - 9 和 _。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

可选参数

--save-path

要下载机器人代码的目录。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az bot prepare-deploy

编辑

添加用于发布脚本 az webapp deployment/配置文件的脚本/配置文件。

将脚本或配置文件添加到本地源代码目录的根目录，以便能够使用 az webapp deployment。将代码部署到App 服务时，生成的脚本或配置文件应显示在 App 服务 Kudu 网页的 D：\home\site\wwwroot 中。

az bot prepare-deploy --lang {Csharp, Javascript, Typescript}
                      [--code-dir]
                      [--proj-file-path]

示例

准备使用“az webapp”通过提取 Node.js IIS web.config 文件来部署 Javascript 机器人。

az bot prepare-deploy --lang Javascript --code-dir "MyBotCode"

准备使用“az webapp”通过创建 .deployment 文件来部署 Csharp 机器人。

az bot prepare-deploy --lang Csharp --code-dir "." --proj-file-path "MyBot.csproj"

必需参数

--lang

机器人的语言或运行时。

接受的值: Csharp, Javascript, Typescript

可选参数

--code-dir

要在其中放置生成的部署文件的目录。默认为从中调用命令的当前目录。

--proj-file-path

相对于 --code-dir 的 .csproj 文件的路径。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az bot prepare-publish

编辑

预览

此命令处于预览阶段，正在开发中。参考和支持级别： https://aka.ms/CLI_refstatus

（维护模式）将脚本添加到本地源代码目录，以便能够使用 az bot publish v3 SDK 机器人重新发布。

az bot prepare-publish --name
                       --proj-file-path
                       --resource-group
                       --sln-name
                       [--code-dir]
                       [--version {v3, v4}]

必需参数

--name -n

机器人的资源名称。机器人名称必须为 4 到 42 个字符长。机器人名称只能有以下字符：-、a - z、A - Z、0 - 9 和 _。

--proj-file-path

启动项目文件名的路径。（例如“./EchoBotWithCounter.csproj”）仅适用于 C# 。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

--sln-name

启动解决方案文件名的名称。仅适用于 C# 。

可选参数

--code-dir

要将部署脚本下载到的目录。

--version -v

将在要创建的机器人模板中使用的 Microsoft Bot Builder SDK 版本。

接受的值: v3, v4

默认值: v3

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az bot publish

编辑

预览

此命令处于预览阶段，正在开发中。参考和支持级别： https://aka.ms/CLI_refstatus

发布到机器人的关联应用服务。

将源代码发布到机器人的关联应用服务。这已弃用 v4 机器人，不再建议将 v4 机器人发布到 Azure。请改用 az bot prepare-deploy 并 az webapp deployment 部署 v4 机器人。有关详细信息，请参阅 https://aka.ms/deploy-your-bot。

az bot publish --name
               --resource-group
               [--code-dir]
               [--keep-node-modules {false, true}]
               [--proj-file-path]
               [--timeout]
               [--version]

示例

从机器人代码文件夹中将源代码发布到Azure 应用

az bot publish -n botName -g MyResourceGroup

必需参数

--name -n

机器人的资源名称。机器人名称必须为 4 到 42 个字符长。机器人名称只能有以下字符：-、a - z、A - Z、0 - 9 和 _。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

可选参数

--code-dir

一个目录，可以从其上传机器人代码。

--keep-node-modules

保留node_modules文件夹，但不在App 服务上运行npm install。这可以大大加快 Node.js SDK 机器人的发布命令的速度。

接受的值: false, true

--proj-file-path

启动项目文件名的路径。（例如“./EchoBotWithCounter.csproj”）。

--timeout -t

检查部署状态的可配置超时（以秒为单位）。

--version -v

机器人的 Microsoft Bot Builder SDK 版本。

默认值: v4

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az bot show

编辑

获取现有机器人。

获取有关现有机器人的信息。若要获取连接到机器人所需的信息，请使用 --msbot 标志和命令。

az bot show --name
            --resource-group
            [--msbot {false, true}]

示例

获取连接到 Azure 上现有机器人所需的信息

az bot show -n botName -g MyResourceGroup --msbot

必需参数

--name -n

机器人的资源名称。机器人名称必须为 4 到 42 个字符长。机器人名称只能有以下字符：-、a - z、A - Z、0 - 9 和 _。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

可选参数

--msbot

将输出显示为与 .bot 文件兼容的 JSON。

接受的值: false, true

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az bot update

编辑

更新现有机器人。

az bot update --name
              --resource-group
              [--ai-api-key]
              [--ai-app-id]
              [--ai-key]
              [--cmk]
              [--cmk-off]
              [--description]
              [--display-name]
              [--endpoint]
              [--icon-url]
              [--sku {F0, S1}]
              [--tags]

示例

更新机器人的说明

az bot update -n botName -g MyResourceGroup --endpoint "https://bing.com/api/messages" --display-name "Hello World"

必需参数

--name -n

机器人的资源名称。机器人名称必须为 4 到 42 个字符长。机器人名称只能有以下字符：-、a - z、A - Z、0 - 9 和 _。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

可选参数

--ai-api-key --app-insights-api-key

Azure 应用程序用于读取机器人分析数据的见解 API 密钥。如果要在“分析”边栏选项卡中查看有关机器人的分析，请提供密钥。

--ai-app-id --app-insights-app-id

Azure 应用程序用于读取机器人分析数据的 Insights 应用程序 ID。如果要在“分析”边栏选项卡中查看有关机器人的分析，请提供 ID。

--ai-key --app-insights-key

Azure 应用程序用于写入机器人分析数据的见解密钥。如果要接收机器人分析，请提供密钥。

--cmk --cmk-key-vault-key-url

用于启用客户托管密钥加密的密钥保管库密钥 URL。

--cmk-off

将加密设置为 Microsoft 管理的密钥。

--description

机器人的新说明。

--display-name -d

机器人的新显示名称。

--endpoint -e

机器人的新终结点。必须以“https://”开头。

--icon-url

机器人头像的图标 URL。接受文件大小限制为 30知识库(KB) 的 PNG 文件。

--sku

机器人的 SKU。

接受的值: F0, S1

--tags

空格分隔标记：key[=value] [key[=value] ...]。使用“”清除现有标记。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

通过

az bot

命令

az bot create

必需参数

可选参数

az bot delete

必需参数

az bot download

必需参数

可选参数

az bot prepare-deploy

示例

必需参数

可选参数

az bot prepare-publish

必需参数

可选参数

az bot publish

示例

必需参数

可选参数

az bot show

示例

必需参数

可选参数

az bot update

示例

必需参数

可选参数

其他资源