az blueprint

Note

このリファレンスは、Azure CLI (バージョン 2.50.0 以降) のブループリント拡張機能の一部です。 拡張機能は、az blueprint コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細をご覧ください。

ブループリントを管理するコマンド。

コマンド

名前	説明	型	Status
az blueprint artifact	ブループリント アーティファクトを管理するコマンド。	拡張	GA
az blueprint artifact delete	ブループリント アーティファクトを削除します。	拡張	プレビュー
az blueprint artifact list	特定のブループリント定義の成果物を一覧表示します。	拡張	プレビュー
az blueprint artifact policy	ブループリント ポリシー割り当て成果物を管理するコマンド。	拡張	GA
az blueprint artifact policy create	ブループリント ポリシー成果物を作成します。	拡張	GA
az blueprint artifact policy update	ブループリント ポリシー成果物を更新します。	拡張	GA
az blueprint artifact role	ブループリント ロールの割り当て成果物を管理するコマンド。	拡張	GA
az blueprint artifact role create	ブループリント ロールアーティファクトを作成します。	拡張	GA
az blueprint artifact role update	ブループリント ロールアーティファクトを更新します。	拡張	GA
az blueprint artifact show	ブループリントアーティファクトを取得します。	拡張	プレビュー
az blueprint artifact template	ブループリント ARM テンプレート成果物を管理するコマンド。	拡張	GA
az blueprint artifact template create	ブループリント アームアーティファクトを作成します。	拡張	GA
az blueprint artifact template update	ブループリント アームアーティファクトを更新します。	拡張	GA
az blueprint assignment	ブループリントの割り当てを管理するコマンド。	拡張	GA
az blueprint assignment create	ブループリントの割り当てを作成します。	拡張	GA
az blueprint assignment delete	ブループリントの割り当てを削除します。	拡張	プレビュー
az blueprint assignment list	サブスクリプション内のブループリントの割り当てを一覧表示します。	拡張	プレビュー
az blueprint assignment show	ブループリントの割り当てを取得します。	拡張	プレビュー
az blueprint assignment update	ブループリントの割り当てを更新します。	拡張	GA
az blueprint assignment wait	ブループリント割り当ての条件が満たされるまで、CLI を待機状態にします。	拡張	GA
az blueprint assignment who	Blueprint Servie Principal Name objectId を取得します。	拡張	プレビュー
az blueprint create	ブループリント定義を作成します。	拡張	プレビュー
az blueprint delete	ブループリント定義を削除します。	拡張	プレビュー
az blueprint export	ブループリント定義と成果物を json ファイルにエクスポートします。	拡張	GA
az blueprint import	json ファイルの directoy からブループリント定義とアーティファクトをインポートします。	拡張	GA
az blueprint list	ブループリント定義を一覧表示します。	拡張	プレビュー
az blueprint publish	最新の成果物を使用して、ブループリント定義の新しいバージョンを発行します。 発行されたブループリント定義は不変です。	拡張	プレビュー
az blueprint resource-group	ブループリント リソース グループ成果物を管理するコマンド。	拡張	GA
az blueprint resource-group add	リソース グループアーティファクトをブループリントに追加します。	拡張	GA
az blueprint resource-group list	ブループリント リソース グループの成果物を一覧表示します。	拡張	GA
az blueprint resource-group remove	ブループリント リソース グループ成果物を削除します。	拡張	GA
az blueprint resource-group show	ブループリント リソース グループの成果物を表示します。	拡張	GA
az blueprint resource-group update	ブループリント リソース グループ成果物を更新します。	拡張	GA
az blueprint show	ブループリント定義を取得します。	拡張	プレビュー
az blueprint update	ブループリント定義を更新します。	拡張	プレビュー
az blueprint version	発行されたブループリント バージョンを管理するコマンド。	拡張	プレビュー
az blueprint version artifact	発行されたブループリント アーティファクトを管理するコマンド。	拡張	プレビュー
az blueprint version artifact list	発行されたブループリントのバージョンの成果物を一覧表示します。	拡張	プレビュー
az blueprint version artifact show	発行されたブループリントの成果物を表示します。	拡張	プレビュー
az blueprint version delete	ブループリントの発行済みバージョンを削除します。	拡張	プレビュー
az blueprint version list	特定のブループリント定義の発行済みバージョンを一覧表示します。	拡張	プレビュー
az blueprint version show	ブループリントの発行済みバージョンを取得します。	拡張	プレビュー

az blueprint create

プレビュー

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

ブループリント定義を作成します。

az blueprint create --name
                    --target-scope {managementGroup, subscription}
                    [--description]
                    [--display-name]
                    [--management-group]
                    [--parameters]
                    [--resource-groups]
                    [--subscription]

例

サブスクリプション ブループリントを作成する

az blueprint create --subscription MySubscription --name MyBlueprint --description "blueprint contains all artifacts" --target-scope subscription

管理グループブループリントを作成する

az blueprint create --management-group MyManagementGroup --name MyBlueprint --description "blueprint contains all artifact" --target-scope subscription

必須のパラメーター

--name -n

ブループリント定義の名前。

--target-scope

このブループリント定義を割り当てることができるスコープ。

承認された値: managementGroup, subscription

省略可能のパラメーター

--description

複数行でこのリソースについて説明します。

--display-name

このリソースを説明する 1 行の文字列。

--management-group -m

ブループリントのスコープには管理グループを使用します。

--parameters -p

このブループリント定義に必要なパラメーター。 JSON 文字列または JSON ファイル パスを指定できます。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--resource-groups

このブループリント定義で定義されているリソース グループ プレースホルダー。 予期される値: json-string/@json-file。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--subscription -s

ブループリントのスコープにはサブスクリプションを使用します。 --management-group が指定されていない場合、--subscription 値または既定のサブスクリプションがスコープとして使用されます。

グローバル パラメーター

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

プレビュー

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

ブループリント定義を削除します。

az blueprint delete --name
                    [--management-group]
                    [--subscription]
                    [--yes]

例

管理グループブループリントを削除する

az blueprint delete --management-group MyManagementGroup --name MyBlueprint

サブスクリプション ブループリントを削除する

az blueprint delete --subscription MySubscription --name MyBlueprint

必須のパラメーター

--name -n

ブループリント定義の名前。

省略可能のパラメーター

--management-group -m

ブループリントのスコープには管理グループを使用します。

--subscription -s

ブループリントのスコープにはサブスクリプションを使用します。 --management-group が指定されていない場合、--subscription 値または既定のサブスクリプションがスコープとして使用されます。

--yes -y

確認のダイアログを表示しません。

既定値: False

グローバル パラメーター

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

ブループリント定義と成果物を json ファイルにエクスポートします。

az blueprint export --name
                    --output-path
                    [--management-group]
                    [--subscription]
                    [--yes]

例

ブループリント定義と成果物をエクスポートする

az blueprint export --name MyBlueprint \
--output-path "path/to/blueprint/directory"

必須のパラメーター

--name -n

エクスポートするブループリント定義の名前。

--output-path

ブループリントと成果物の json 定義のディレクトリ パス。 ブループリント定義ファイルには blueprint.json という名前が付けられます。 アーティファクトの json ファイルは、artifacts という名前のサブディレクトリにあります。

省略可能のパラメーター

--management-group -m

ブループリントのスコープには管理グループを使用します。

--subscription -s

ブループリントのスコープにはサブスクリプションを使用します。 --management-group が指定されていない場合、--subscription 値または既定のサブスクリプションがスコープとして使用されます。

--yes -y

ユーザーの確認をスキップします。 設定すると、ディレクトリが存在しない場合は作成されます。 ディレクトリが存在し、内容がある場合は上書きされます。 設定されていない場合、ユーザーは続行するアクセス許可を求められます。

既定値: False

グローバル パラメーター

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

json ファイルの directoy からブループリント定義とアーティファクトをインポートします。

az blueprint import --input-path
                    --name
                    [--management-group]
                    [--subscription]
                    [--yes]

例

ブループリント定義とアーティファクトをインポートする

az blueprint import --name MyBlueprint \
--input-path "path/to/blueprint/directory"

必須のパラメーター

--input-path

ブループリントと成果物の json 定義のディレクトリ パス。 ブループリント定義ファイルには blueprint.json という名前を付ける必要があります。 成果物の json ファイルは、artifacts という名前のサブディレクトリに存在する必要があります。

--name -n

ブループリント定義の名前。

省略可能のパラメーター

--management-group -m

ブループリントのスコープには管理グループを使用します。

--subscription -s

ブループリントのスコープにはサブスクリプションを使用します。 --management-group が指定されていない場合、--subscription 値または既定のサブスクリプションがスコープとして使用されます。

--yes -y

確認のダイアログを表示しません。

既定値: False

グローバル パラメーター

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

プレビュー

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

ブループリント定義を一覧表示します。

az blueprint list [--management-group]
                  [--max-items]
                  [--next-token]
                  [--subscription]

例

管理グループ内のブループリントを一覧表示する

az blueprint list --management-group MyManagementGroup

サブスクリプション内のブループリントを一覧表示する

az blueprint list --subscription MySubscription

省略可能のパラメーター

--management-group -m

ブループリントのスコープには管理グループを使用します。

--max-items

コマンドの出力で返される項目の合計数。 使用可能な項目の合計数が指定された値を超える場合は、コマンドの出力にトークンが提供されます。 改ページ位置の変更を再開するには、後続のコマンドの引数に --next-token トークン値を指定します。

--next-token

ページ分割を開始する場所を指定するトークン。 これは、以前に切り捨てられた応答からのトークン値です。

--subscription -s

ブループリントのスコープにはサブスクリプションを使用します。 --management-group が指定されていない場合、--subscription 値または既定のサブスクリプションがスコープとして使用されます。

グローバル パラメーター

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

プレビュー

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

最新の成果物を使用して、ブループリント定義の新しいバージョンを発行します。 発行されたブループリント定義は不変です。

az blueprint publish --blueprint-name
                     --version
                     [--change-notes]
                     [--management-group]
                     [--subscription]

例

管理グループのブループリントを発行する

az blueprint publish --management-group MyManagementGroup --blueprint-name MyBlueprint --version v2

サブスクリプションブループリントを発行する

az blueprint publish --subscription MySubscription --blueprint-name MyBlueprint --version v2

必須のパラメーター

--blueprint-name

ブループリント定義の名前。

--version

発行されたブループリント定義のバージョン。

省略可能のパラメーター

--change-notes

バージョン固有の変更に関するメモ。

--management-group -m

ブループリントのスコープには管理グループを使用します。

--subscription -s

ブループリントのスコープにはサブスクリプションを使用します。 --management-group が指定されていない場合、--subscription 値または既定のサブスクリプションがスコープとして使用されます。

グローバル パラメーター

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

プレビュー

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

ブループリント定義を取得します。

az blueprint show --name
                  [--management-group]
                  [--subscription]

例

管理グループのブループリントを表示する

az blueprint show --management-group MyManagementGroup --name MyBlueprint

サブスクリプションブループリントを表示する

az blueprint show --subscription MySubscription --name MyBlueprint

必須のパラメーター

--name -n

ブループリント定義の名前。

省略可能のパラメーター

--management-group -m

ブループリントのスコープには管理グループを使用します。

--subscription -s

ブループリントのスコープにはサブスクリプションを使用します。 --management-group が指定されていない場合、--subscription 値または既定のサブスクリプションがスコープとして使用されます。

グローバル パラメーター

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

プレビュー

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

ブループリント定義を更新します。

az blueprint update --name
                    [--add]
                    [--description]
                    [--display-name]
                    [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                    [--management-group]
                    [--parameters]
                    [--remove]
                    [--resource-groups]
                    [--set]
                    [--subscription]
                    [--target-scope {managementGroup, subscription}]

必須のパラメーター

--name -n

ブループリント定義の名前。

省略可能のパラメーター

--add

パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。 例: --add property.listProperty <key=value、string、または JSON 文字列>。

--description

複数行でこのリソースについて説明します。

--display-name

このリソースを説明する 1 行の文字列。

--force-string

'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。

承認された値: 0, 1, f, false, n, no, t, true, y, yes

--management-group -m

ブループリントのスコープには管理グループを使用します。

--parameters -p

このブループリント定義に必要なパラメーター。 JSON 文字列または JSON ファイル パスを指定できます。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--remove

リストからプロパティまたは要素を削除します。 例: --remove property.list OR --remove propertyToRemove。

--resource-groups

このブループリント定義で定義されているリソース グループ プレースホルダー。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--set

設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=。

--subscription -s

ブループリントのスコープにはサブスクリプションを使用します。 --management-group が指定されていない場合、--subscription 値または既定のサブスクリプションがスコープとして使用されます。

--target-scope

このブループリント定義を割り当てることができるスコープ。

承認された値: managementGroup, subscription

グローバル パラメーター

--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 を使います。