az bot

參考

管理 Microsoft Azure Bot Service。

命令

名稱	Description	類型	狀態
az bot authsetting	管理 Bot 上的 OAuth 連線設定。	核心	GA
az bot authsetting create	在 Bot 上建立 OAuth 連線設定。	核心	GA
az bot authsetting delete	刪除 Bot 上的 OAuth 連線設定。	核心	GA
az bot authsetting list	在 Bot 上顯示所有 OAuth 連線設定。	核心	GA
az bot authsetting list-providers	列出所有可用於建立 OAuth 連線設定之服務提供者的詳細資料。	核心	GA
az bot authsetting show	在 Bot 上顯示 OAuth 連線設定的詳細資料。	核心	GA
az bot create	建立新的 v4 SDK Bot。	核心	GA
az bot delete	刪除現有的 Bot。	核心	GA
az bot directline	管理 Bot 上的 Directline 通道。	核心	預覽版
az bot directline create	在僅啟用 v3 通訊協定的 Bot 上建立 DirectLine 通道。	核心	預覽版
az bot directline delete	刪除 Bot 上的 Directline 通道。	核心	預覽版
az bot directline show	取得 Bot 上 Directline 通道的詳細資料。	核心	預覽版
az bot directline update	僅啟用 v3 通訊協定的 Bot 上更新 DirectLine 通道。	核心	預覽版
az bot download	下載現有的 Bot。	核心	預覽版
az bot email	管理 Bot 上的電子郵件通道。	核心	預覽版
az bot email create	在 Bot 上建立電子郵件通道。	核心	預覽版
az bot email delete	刪除 Bot 上的電子郵件通道。	核心	預覽版
az bot email show	取得 Bot 上電子郵件通道的詳細資料。	核心	預覽版
az bot facebook	管理 Bot 上的 Facebook 頻道。	核心	預覽版
az bot facebook create	在 Bot 上建立 Facebook 通道。	核心	預覽版
az bot facebook delete	刪除 Bot 上的 Facebook 頻道。	核心	預覽版
az bot facebook show	取得 Bot 上 Facebook 頻道的詳細資料。	核心	預覽版
az bot kik	管理 Bot 上的 Kik 通道。	核心	預覽版
az bot kik create	在 Bot 上建立 Kik 通道。	核心	預覽版
az bot kik delete	刪除 Bot 上的 Kik 通道。	核心	預覽版
az bot kik show	取得 Bot 上 Kik 通道的詳細資料。	核心	預覽版
az bot msteams	管理 Bot 上的 Microsoft Teams 頻道。	核心	預覽版
az bot msteams create	在 Bot 上建立 Microsoft Teams 頻道。	核心	預覽版
az bot msteams delete	刪除 Bot 上的 Microsoft Teams 頻道。	核心	預覽版
az bot msteams show	取得 Bot 上 Microsoft Teams 頻道的詳細資料。	核心	預覽版
az bot prepare-deploy	新增腳本/組態檔，以使用 `az webapp deployment` 發佈。	核心	GA
az bot prepare-publish	（維護模式）將腳本新增至您的本機原始程式碼目錄，以便使用 `az bot publish` v3 SDK Bot 來發行。	核心	預覽版
az bot publish	發佈至 Bot 相關聯的應用程式服務。	核心	預覽版
az bot show	取得現有的 Bot。	核心	GA
az bot skype	管理 Bot 上的 Skype 通道。	核心	預覽版
az bot skype create	在 Bot 上建立 Skype 通道。	核心	預覽版
az bot skype delete	刪除 Bot 上的 Skype 通道。	核心	預覽版
az bot skype show	取得 Bot 上 Skype 通道的詳細資料。	核心	預覽版
az bot slack	管理 Bot 上的 Slack 通道。	核心	預覽版
az bot slack create	在 Bot 上建立 Slack 通道。	核心	預覽版
az bot slack delete	刪除 Bot 上的 Slack 通道。	核心	預覽版
az bot slack show	取得 Bot 上 Slack 通道的詳細資料。	核心	預覽版
az bot sms	管理 Bot 上的 SMS 通道。	核心	預覽版
az bot sms create	在 Bot 上建立 SMS 通道。	核心	預覽版
az bot sms delete	刪除 Bot 上的 SMS 通道。	核心	預覽版
az bot sms show	取得 Bot 上的 SMS 通道詳細資料。	核心	預覽版
az bot telegram	管理 Bot 上的 Telegram 通道。	核心	預覽版
az bot telegram create	在 Bot 上建立 Telegram 通道。	核心	預覽版
az bot telegram delete	刪除 Bot 上的 Telegram 通道。	核心	預覽版
az bot telegram show	取得 Bot 上的 Telegram 通道詳細資料。	核心	預覽版
az bot update	更新現有的 Bot。	核心	GA
az bot webchat	管理 Bot 上的 Webchat 通道。	核心	GA
az bot webchat show	取得 Bot 上的 Webchat 通道詳細資料。	核心	GA

az bot create

編輯

建立新的 v4 SDK Bot。

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

適用于 Bot 的 Microsoft 應用程式類型。可能的值包括：「UserAssignedMSI」、「SingleTenant」、「MultiTenant」。

--appid

要與 Bot 搭配使用的 Microsoft 帳戶識別碼（MSA ID）。

--name -n

Bot 的資源名稱。 Bot 名稱長度必須介於 4 到 42 個字元之間。 Bot 名稱只能包含下列字元：-、a 到 z、A 到 Z、0 到 9 和 _。

--resource-group -g

資源組名。您可以使用來設定預設群組 az configure --defaults group=<name> 。

選擇性參數

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

用來啟用客戶自控金鑰加密的金鑰保存庫金鑰 URL。

--description -d

Bot 的描述。

--display-name

Bot 的顯示名稱。如果未指定，則預設為 Bot 的名稱。

--endpoint -e

Bot 的傳訊端點。

--location -l

位置。來自的值： az account list-locations 。您可以使用 az configure --defaults location=<location> 設定預設位置。

預設值: global

--msi-resource-id

Bot 的 Microsoft 應用程式受控識別資源識別碼。

--sku

Bot 的 Sku。

接受的值: F0, S1

預設值: F0

--tags

以空格分隔的標記：key[=value] [key[=value] ...]。使用「」清除現有的標記。

--tenant-id

Bot 的 Microsoft 應用程式租使用者識別碼。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

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

預設值: json

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。您可以使用來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。使用 --debug 來取得完整偵錯記錄。

az bot delete

編輯

刪除現有的 Bot。

az bot delete --name
              --resource-group

必要參數

--name -n

Bot 的資源名稱。 Bot 名稱長度必須介於 4 到 42 個字元之間。 Bot 名稱只能包含下列字元：-、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

訂用帳戶的名稱或識別碼。您可以使用來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。使用 --debug 來取得完整偵錯記錄。

az bot download

編輯

預覽

此命令處於預覽狀態，且正在開發中。參考和支援層級： https://aka.ms/CLI_refstatus

下載現有的 Bot。

原始程式碼會從與 Bot 相關聯的 Web 應用程式下載。然後，您可以進行變更，並將它發佈回您的應用程式。

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

必要參數

--name -n

Bot 的資源名稱。 Bot 名稱長度必須介於 4 到 42 個字元之間。 Bot 名稱只能包含下列字元：-、a 到 z、A 到 Z、0 到 9 和 _。

--resource-group -g

資源組名。您可以使用來設定預設群組 az configure --defaults group=<name> 。

選擇性參數

--save-path

要下載 Bot 程式碼的目錄。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

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

預設值: json

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。您可以使用來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。使用 --debug 來取得完整偵錯記錄。

az bot prepare-deploy

編輯

新增腳本/組態檔，以使用 az webapp deployment 發佈。

將腳本或組態檔新增至本機原始程式碼目錄的根目錄，以使用 az webapp deployment 發佈。當您的程式碼部署至 App Service 時，產生的腳本或組態檔應該會出現在 App Service 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 Bot。

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

準備使用 'az webapp' 建立 .deployment 檔案來部署 Csharp Bot。

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

必要參數

--lang

Bot 的語言或執行時間。

接受的值: 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

訂用帳戶的名稱或識別碼。您可以使用來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。使用 --debug 來取得完整偵錯記錄。

az bot prepare-publish

編輯

預覽

此命令處於預覽狀態，且正在開發中。參考和支援層級： https://aka.ms/CLI_refstatus

（維護模式）將腳本新增至您的本機原始程式碼目錄，以便使用 az bot publish v3 SDK Bot 來發行。

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

必要參數

--name -n

Bot 的資源名稱。 Bot 名稱長度必須介於 4 到 42 個字元之間。 Bot 名稱只能包含下列字元：-、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

要用於要建立之 Bot 範本中的 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

訂用帳戶的名稱或識別碼。您可以使用來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。使用 --debug 來取得完整偵錯記錄。

az bot publish

編輯

預覽

此命令處於預覽狀態，且正在開發中。參考和支援層級： https://aka.ms/CLI_refstatus

發佈至 Bot 相關聯的應用程式服務。

將您的原始程式碼發佈至 Bot 相關聯的 App Service。這已針對 v4 Bot 淘汰，不再建議將 v4 Bot 發佈至 Azure。請改用 az bot prepare-deploy 和 az webapp deployment 來部署 v4 Bot。如需詳細資訊，請參閱：https://aka.ms/deploy-your-bot。

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

範例

從 Bot 程式碼資料夾內，將原始程式碼發佈至您的 Azure 應用程式

az bot publish -n botName -g MyResourceGroup

必要參數

--name -n

Bot 的資源名稱。 Bot 名稱長度必須介於 4 到 42 個字元之間。 Bot 名稱只能包含下列字元：-、a 到 z、A 到 Z、0 到 9 和 _。

--resource-group -g

資源組名。您可以使用來設定預設群組 az configure --defaults group=<name> 。

選擇性參數

--code-dir

要上傳 Bot 程式碼的來原始目錄。

--keep-node-modules

請保留node_modules資料夾，且不會在 App Service 上執行 npm install 。這可大幅加速 Node.js SDK Bot 的發佈命令。

接受的值: false, true

--proj-file-path

啟動專案檔名稱的路徑。（例如「./EchoBotWithCounter.csproj）。

--timeout -t

可設定的逾時，以秒為單位來檢查部署狀態。

--version -v

Bot 的 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

訂用帳戶的名稱或識別碼。您可以使用來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。使用 --debug 來取得完整偵錯記錄。

az bot show

編輯

取得現有的 Bot。

取得現有 Bot 的相關資訊。若要取得連線至 Bot 所需的資訊，請使用 --msbot 旗標搭配命令。

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

範例

取得連線至 Azure 上現有 Bot 所需的資訊

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

必要參數

--name -n

Bot 的資源名稱。 Bot 名稱長度必須介於 4 到 42 個字元之間。 Bot 名稱只能包含下列字元：-、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

訂用帳戶的名稱或識別碼。您可以使用來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。使用 --debug 來取得完整偵錯記錄。

az bot update

編輯

更新現有的 Bot。

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]

範例

更新 Bot 的描述

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

必要參數

--name -n

Bot 的資源名稱。 Bot 名稱長度必須介於 4 到 42 個字元之間。 Bot 名稱只能包含下列字元：-、a 到 z、A 到 Z、0 到 9 和 _。

--resource-group -g

資源組名。您可以使用來設定預設群組 az configure --defaults group=<name> 。

選擇性參數

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

Azure 應用程式用來讀取 Bot 分析資料的深入解析 API 金鑰。如果您想要在 [分析] 刀鋒視窗中檢視 Bot 的相關分析，請提供金鑰。

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

Azure 應用程式用來讀取 Bot 分析資料的 Insights 應用程式識別碼。如果您想要在 [分析] 刀鋒視窗中檢視 Bot 的相關分析，請提供識別碼。

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

Azure 應用程式用來撰寫 Bot 分析資料的深入解析金鑰。如果您想要接收 Bot 分析，請提供金鑰。

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

用來啟用客戶自控金鑰加密的金鑰保存庫金鑰 URL。

--cmk-off

將加密設定為 Microsoft 管理的金鑰。

--description

Bot 的新描述。

--display-name -d

Bot 的新顯示名稱。

--endpoint -e

Bot 的新端點。必須以「HTTPs://」開頭。

--icon-url

Bot 虛擬人偶的圖示 URL。接受檔案大小限制為 30KB 的 PNG 檔案。

--sku

Bot 的 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

訂用帳戶的名稱或識別碼。您可以使用來設定預設訂用 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

範例

必要參數

選擇性參數

其他資源