az blueprint assignment

Note

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

ブループリントの割り当てを管理するコマンド。

コマンド

名前	説明	型	Status
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 assignment create

ブループリントの割り当てを作成します。

az blueprint assignment create --name
                               [--blueprint-version]
                               [--description]
                               [--display-name]
                               [--identity-type {None, SystemAssigned, UserAssigned}]
                               [--location]
                               [--locks-excluded-principals]
                               [--locks-mode {AllResourcesDoNotDelete, AllResourcesReadOnly, None}]
                               [--management-group]
                               [--parameters]
                               [--resource-group-value]
                               [--subscription]
                               [--user-assigned-identity]

例

システム割り当てマネージド ID を使用した割り当て

az blueprint assignment create --subscription MySubscription --name \
MyBlueprintAssignment --location eastus --identity-type SystemAssigned \
--description "Enforce pre-defined MyBlueprint to this subscription." \
--blueprint-version "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/provid \
ers/Microsoft.Blueprint/blueprints/MyBlueprint/versions/v2" \
--resource-group-value artifact_name=rg-art-1 name=rg1 location=westus \
--resource-group-value artifact_name=rg-art-2 name=rg2 location=eastus \
--parameters "path/to/parameter/file" \

ユーザー割り当てマネージド ID を使用した割り当て

az blueprint assignment create --subscription MySubscription --name \
MyBlueprintAssignment --location eastus --identity-type UserAssigned \
--user-assigned-identity "/subscriptions/00000000-0000-0000-0000-000000000000 \
/resourcegroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity"\
--description "Enforce pre-defined MyBlueprint to this subscription." \
--blueprint-version "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup \
/providers/Microsoft.Blueprint/blueprints/MyBlueprint/versions/v2" \
--resource-group-value artifact_name=rg-art-1 name=rg1 location=eastus \
--parameters "path/to/parameter/file" \

必須のパラメーター

--name -n

ブループリント割り当ての名前。

省略可能のパラメーター

--blueprint-version

ブループリント定義の発行済みバージョンのリソース ID。

--description

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

--display-name

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

--identity-type

マネージド ID の種類。

承認された値: None, SystemAssigned, UserAssigned

既定値: SystemAssigned

--location -l

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

--locks-excluded-principals

ブループリント ロックから除外された AAD プリンシパルの一覧。 最大 5 つのプリンシパルが許可されます。

--locks-mode

ロック モード。

承認された値: AllResourcesDoNotDelete, AllResourcesReadOnly, None

--management-group -m

ブループリント割り当てのターゲット スコープに管理グループを使用します。 将来使用するために予約されています。 代わりに --subscription を使用してください。

--parameters -p

ブループリント割り当てパラメーターの値。 JSON 文字列または JSON ファイル パスを指定できます。

--resource-group-value

リソース グループのキーと値のペア。 キーには、'artifact_name'(必須)、'name'、'location' があります。

--subscription -s

ブループリント割り当てのターゲット スコープにサブスクリプションを使用します。 オプションが指定されていない場合は、既定の susbcription が使用されます。

--user-assigned-identity

リソースに関連付けられているユーザー割り当てマネージド 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 blueprint assignment delete

プレビュー

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

ブループリントの割り当てを削除します。

az blueprint assignment delete --name
                               [--delete-behavior {all, none}]
                               [--management-group]
                               [--subscription]
                               [--yes]

例

割り当てを削除する

az blueprint assignment delete --subscription MySubscription --name MyBlueprintAssignment

必須のパラメーター

--name -n

ブループリント割り当ての名前。

省略可能のパラメーター

--delete-behavior

deleteBehavior=all の場合、ブループリント割り当てによって作成されたリソースは削除されます。

承認された値: all, none

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

プレビュー

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

サブスクリプション内のブループリントの割り当てを一覧表示します。

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

例

課題を一覧表示する

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

プレビュー

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

ブループリントの割り当てを取得します。

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

例

割り当てを表示する

az blueprint assignment show --subscription MySubscription --name MyBlueprintAssignment

必須のパラメーター

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

ブループリントの割り当てを更新します。

az blueprint assignment update --name
                               [--blueprint-version]
                               [--description]
                               [--display-name]
                               [--identity-type {None, SystemAssigned, UserAssigned}]
                               [--location]
                               [--locks-excluded-principals]
                               [--locks-mode {AllResourcesDoNotDelete, AllResourcesReadOnly, None}]
                               [--management-group]
                               [--parameters]
                               [--resource-group-value]
                               [--subscription]
                               [--user-assigned-identity]

必須のパラメーター

--name -n

ブループリント割り当ての名前。

省略可能のパラメーター

--blueprint-version

ブループリント定義の発行済みバージョンのリソース ID。

--description

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

--display-name

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

--identity-type

マネージド ID の種類。

承認された値: None, SystemAssigned, UserAssigned

--location -l

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

--locks-excluded-principals

ブループリント ロックから除外された AAD プリンシパルの一覧。 最大 5 つのプリンシパルが許可されます。

--locks-mode

ロック モード。

承認された値: AllResourcesDoNotDelete, AllResourcesReadOnly, None

--management-group -m

ブループリント割り当てのターゲット スコープに管理グループを使用します。 将来使用するために予約されています。 代わりに --subscription を使用してください。

--parameters -p

ブループリント割り当てパラメーターの値。 JSON 文字列または JSON ファイル パスを指定できます。

--resource-group-value

リソース グループのキーと値のペア。 キーには、'artifact_name'(必須)、'name'、'location' があります。

--subscription -s

ブループリント割り当てのターゲット スコープにサブスクリプションを使用します。 オプションが指定されていない場合は、既定の susbcription が使用されます。

--user-assigned-identity

リソースに関連付けられているユーザー割り当てマネージド 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 blueprint assignment wait

ブループリント割り当ての条件が満たされるまで、CLI を待機状態にします。

az blueprint assignment wait --name
                             [--created]
                             [--custom]
                             [--deleted]
                             [--exists]
                             [--interval]
                             [--management-group]
                             [--subscription]
                             [--timeout]
                             [--updated]

例

ブループリント割り当てが正常にプロビジョニングされるまで、CLI スクリプトの次の行の実行を一時停止します。

az blueprint assignment wait --subscription MySubscription \ --name MyBlueprintAssignment --created

必須のパラメーター

--name -n

ブループリント割り当ての名前。

省略可能のパラメーター

--created

'provisioningState' が 'Succeeded' で作成されるまで待ちます。

既定値: False

--custom

条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。

--deleted

削除されるまで待ちます。

既定値: False

--exists

リソースが存在するまで待ちます。

既定値: False

--interval

ポーリング間隔 (秒単位)。

既定値: 30

--management-group -m

ブループリント割り当てのターゲット スコープに管理グループを使用します。 将来使用するために予約されています。 代わりに --subscription を使用してください。

--subscription -s

ブループリント割り当てのターゲット スコープにサブスクリプションを使用します。 オプションが指定されていない場合は、既定の susbcription が使用されます。

--timeout

最大待機時間 (秒単位)。

既定値: 3600

--updated

provisioningState が 'Succeeded' で更新されるまで待ちます。

既定値: 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 assignment who

プレビュー

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

Blueprint Servie Principal Name objectId を取得します。

az blueprint assignment who --name
                            [--management-group]
                            [--subscription]

例

SPN objectId を取得する

az blueprint assignment who --subscription MySubscription --name MyBlueprintAssignment

必須のパラメーター

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