az bot

Microsoft Azure Bot Service を管理します。

コマンド

名前	説明	型	状態
az bot authsetting	ボットの OAuth 接続設定を管理します。	Core	GA
az bot authsetting create	ボットに OAuth 接続設定を作成します。	Core	GA
az bot authsetting delete	ボットの OAuth 接続設定を削除します。	Core	GA
az bot authsetting list	ボットのすべての OAuth 接続設定を表示します。	Core	GA
az bot authsetting list-providers	OAuth 接続設定の作成に使用できるすべてのサービスプロバイダーの詳細を一覧表示します。	Core	GA
az bot authsetting show	ボットの OAuth 接続設定の詳細を表示します。	Core	GA
az bot create	新しい v4 SDK ボットを作成します。	Core	GA
az bot delete	既存のボットを削除します。	Core	GA
az bot directline	ボットで Directline チャネルを管理します。	Core	Preview
az bot directline create	v3 プロトコルのみが有効になっているボットに DirectLine チャネルを作成します。	Core	Preview
az bot directline delete	ボットの Directline チャネルを削除します。	Core	Preview
az bot directline show	ボットの Directline チャネルの詳細を取得します。	Core	Preview
az bot directline update	v3 プロトコルのみを有効にして、ボットの DirectLine チャネルを更新します。	Core	Preview
az bot download	既存のボットをダウンロードします。	Core	Preview
az bot email	ボットで電子メールチャネルを管理します。	Core	Preview
az bot email create	ボットで電子メールチャネルを作成します。	Core	Preview
az bot email delete	ボットの電子メールチャネルを削除します。	Core	Preview
az bot email show	ボットの電子メールチャネルの詳細を取得します。	Core	Preview
az bot facebook	ボットで Facebook チャネルを管理します。	Core	Preview
az bot facebook create	ボットで Facebook チャネルを作成します。	Core	Preview
az bot facebook delete	ボットの Facebook チャネルを削除します。	Core	Preview
az bot facebook show	ボットの Facebook チャネルの詳細を取得します。	Core	Preview
az bot kik	ボットで Kik チャネルを管理します。	Core	Preview
az bot kik create	ボットで Kik チャネルを作成します。	Core	Preview
az bot kik delete	ボットの Kik チャネルを削除します。	Core	Preview
az bot kik show	ボットの Kik チャネルの詳細を取得します。	Core	Preview
az bot msteams	ボットでMicrosoft Teams チャネルを管理します。	Core	Preview
az bot msteams create	ボットにMicrosoft Teams チャネルを作成します。	Core	Preview
az bot msteams delete	ボットのMicrosoft Teams チャネルを削除します。	Core	Preview
az bot msteams show	ボットのMicrosoft Teams チャネルの詳細を取得します。	Core	Preview
az bot prepare-deploy	`az webapp deployment`を使用して発行するためのスクリプト/構成ファイルを追加します。	Core	GA
az bot prepare-publish	(メンテナンスモード)v3 SDK ボットの `az bot publish` を使用して発行できるように、ローカルソースコードディレクトリにスクリプトを追加します。	Core	Preview
az bot publish	ボットに関連付けられているアプリサービスに発行します。	Core	Preview
az bot show	既存のボットを取得します。	Core	GA
az bot skype	ボットで Skype チャネルを管理します。	Core	Preview
az bot skype create	ボットで Skype チャネルを作成します。	Core	Preview
az bot skype delete	ボットの Skype チャネルを削除します。	Core	Preview
az bot skype show	ボットの Skype チャネルの詳細を取得します。	Core	Preview
az bot slack	ボットで Slack チャネルを管理します。	Core	Preview
az bot slack create	ボットで Slack チャネルを作成します。	Core	Preview
az bot slack delete	ボットの Slack チャネルを削除します。	Core	Preview
az bot slack show	ボットの Slack チャネルの詳細を取得します。	Core	Preview
az bot sms	ボットで SMS チャネルを管理します。	Core	Preview
az bot sms create	ボットに SMS チャネルを作成します。	Core	Preview
az bot sms delete	ボットの SMS チャネルを削除します。	Core	Preview
az bot sms show	ボットの SMS チャネルの詳細を取得します。	Core	Preview
az bot telegram	ボットで Telegram チャネルを管理します。	Core	Preview
az bot telegram create	ボットで Telegram チャネルを作成します。	Core	Preview
az bot telegram delete	ボットの Telegram チャネルを削除します。	Core	Preview
az bot telegram show	ボットの Telegram チャネルの詳細を取得します。	Core	Preview
az bot update	既存のボットを更新します。	Core	GA
az bot webchat	ボットで Web チャットチャネルを管理します。	Core	GA
az bot webchat show	ボット上の Web チャットチャネルの詳細を取得します。	Core	GA

az bot create

編集

新しい v4 SDK ボットを作成します。

az bot create --app-type
              --appid
              --name
              --resource-group
              [--cmk --cmk-key-vault-key-url]
              [--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>を使用して既定のグループを構成できます。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

カスタマーマネージドキーの暗号化を有効にするキーコンテナーのキー URL。

--description -d

ボットの説明。

プロパティ	値
Parameter group:	Registration Bot Specific Arguments

--display-name

ボットの表示名。指定しない場合、既定ではボットの名前が使用されます。

プロパティ	値
Parameter group:	Registration Bot Specific Arguments

--endpoint -e

ボットのメッセージングエンドポイント。

プロパティ	値
Parameter group:	Registration Bot Specific Arguments

--location -l

Location. 値のソース: az account list-locations az configure --defaults location=<location>を使用して、既定の場所を構成できます。

プロパティ	値
規定値:	global

--msi-resource-id

ボットの Microsoft アプリマネージド ID リソース ID。

--sku

ボットの SKU。

プロパティ	値
Parameter group:	Registration Bot Specific Arguments
規定値:	F0
指定可能な値:	F0, S1

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

--tenant-id

ボットの Microsoft アプリテナント ID。

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

az bot delete

編集

既存のボットを削除します。

az bot delete --name
              --resource-group

必須のパラメーター

--name -n

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

az bot download

編集

プレビュー

このコマンドはプレビュー段階であり、開発中です。参照レベルとサポートレベル: https://aka.ms/CLI_refstatus

既存のボットをダウンロードします。

ソースコードは、ボットに関連付けられている Web アプリからダウンロードされます。その後、変更を加えて、アプリに発行し直すことができます。

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

必須のパラメーター

--name -n

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--save-path

ボットコードをダウンロードするディレクトリ。

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

az bot prepare-deploy

編集

az webapp deploymentを使用して発行するためのスクリプト/構成ファイルを追加します。

az webapp deploymentを使用して発行できるように、ローカルソースコードディレクトリのルートにスクリプトまたは構成ファイルを追加します。コードが App Service にデプロイされると、生成されたスクリプトまたは構成ファイルが、App Service の Kudu Web ページの D:\home\site\wwwroot に表示されます。

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

例

Node.js IIS web.config ファイルをフェッチして、'az webapp' を使用して Javascript ボットをデプロイする準備をします。

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

.deployment ファイルを作成して、'az webapp' を使用して Csharp ボットをデプロイする準備をします。

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

必須のパラメーター

--lang

ボットの言語またはランタイム。

プロパティ	値
指定可能な値:	Csharp, Javascript, Typescript

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--code-dir

生成されたデプロイファイルを配置するディレクトリ。既定では、コマンドの呼び出し先の現在のディレクトリが使用されます。

--proj-file-path

--code-dir を基準とした .csproj ファイルへのパス。

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

az bot prepare-publish

編集

プレビュー

このコマンドはプレビュー段階であり、開発中です。参照レベルとサポートレベル: https://aka.ms/CLI_refstatus

(メンテナンスモード)v3 SDK ボットの az bot publish を使用して発行できるように、ローカルソースコードディレクトリにスクリプトを追加します。

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

必須のパラメーター

--name -n

--proj-file-path

スタートアッププロジェクトファイル名へのパス。 (例: "./EchoBotWithCounter.csproj")C# にのみ必要です。

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--sln-name

スタートアップソリューションファイル名の名前。 C# にのみ必要です。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--code-dir

デプロイスクリプトをダウンロードするディレクトリ。

--version -v

作成されるボットテンプレートで使用される Microsoft Bot Builder SDK バージョン。

プロパティ	値
Parameter group:	Web/Function bot Specific Arguments
規定値:	v3
指定可能な値:	v3, v4

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

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

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--code-dir

ボットコードをアップロードするディレクトリ。

--keep-node-modules

フォルダー node_modules保持し、App Service で npm install を実行しないでください。これにより、Node.js SDK ボットの発行コマンドが大幅に高速化されます。

プロパティ	値
指定可能な値:	false, true

--proj-file-path

スタートアッププロジェクトファイル名へのパス。 (E.g. "./EchoBotWithCounter.csproj").

--timeout -t

デプロイの状態を確認するための構成可能なタイムアウト (秒単位)。

--version -v

ボットの Microsoft Bot Builder SDK バージョン。

プロパティ	値
規定値:	v4

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

az bot show

編集

既存のボットを取得します。

既存のボットに関する情報を取得します。ボットに接続するために必要な情報を取得するには、コマンドで --msbot フラグを使用します。

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

例

Azure 上の既存のボットに接続するために必要な情報を取得する

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

必須のパラメーター

--name -n

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--msbot

出力を .bot ファイルと互換性のある JSON として表示します。

プロパティ	値
指定可能な値:	false, true

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

az bot update

編集

既存のボットを更新します。

az bot update --name
              --resource-group
              [--ai-api-key --app-insights-api-key]
              [--ai-app-id --app-insights-app-id]
              [--ai-key --app-insights-key]
              [--cmk --cmk-key-vault-key-url]
              [--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

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

ボット分析データの読み取りに使用される Azure Application Insights API キー。 [分析] ブレードでボットに関する分析を表示する場合は、キーを指定します。

プロパティ	値
Parameter group:	Bot Analytics/Application Insights Arguments

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

ボット分析データの読み取りに使用される Azure Application Insights アプリケーション ID。 [分析] ブレードでボットに関する分析を表示する場合は、ID を指定します。

プロパティ	値
Parameter group:	Bot Analytics/Application Insights Arguments

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

ボット分析データの書き込みに使用される Azure Application Insights キー。ボット分析を受け取る場合は、キーを指定します。

プロパティ	値
Parameter group:	Bot Analytics/Application Insights Arguments

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

カスタマーマネージドキーの暗号化を有効にするキーコンテナーのキー URL。

--cmk-off

暗号化を Microsoft-Managed キーに設定します。

--description

ボットの新しい説明。

--display-name -d

ボットの新しい表示名。

--endpoint -e

ボットの新しいエンドポイント。 "https://" で始まる必要があります。

--icon-url

ボットアバターのアイコン URL。ファイルサイズ制限が 30 KB の PNG ファイルを受け入れます。

--sku

ボットの SKU。

プロパティ	値
指定可能な値:	F0, S1

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

次の方法で共有

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

例

必須のパラメーター

省略可能のパラメーター

フィードバック