az bot

Microsoft Azure Bot Service を管理します。

コマンド

名前	説明	型	状態
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	(メンテナンス モード)v3 SDK ボットを使用して az bot publish 発行し直すことができるように、スクリプトをローカル ソース コード ディレクトリに追加します。	コア	プレビュー
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	ボットの SMS チャネルの詳細を取得します。	コア	プレビュー
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	ボットで Web チャット チャネルを管理します。	コア	GA
az bot webchat show	ボット上の Web チャット チャネルの詳細を取得します。	コア	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 リソース 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 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

省略可能のパラメーター

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

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

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 に発行する場合は推奨されなくなりました。 代わりに、v4 ボットを使用 az bot prepare-deploy して az webapp deployment デプロイします。 詳細については、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 Service では実行 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 アプリアプリケーション 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 を使います。