你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

az blueprint assignment

参考

注意

此参考是 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 主体名称 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]

示例

使用系统分配的托管标识进行分配

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

使用用户分配的托管标识进行分配

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

单行字符串解释此资源。

--identity-type

托管标识的类型。

接受的值: None, SystemAssigned, UserAssigned

默认值: SystemAssigned

--location -l

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

与资源关联的用户分配的托管标识。

全局参数

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

单行字符串解释此资源。

--identity-type

托管标识的类型。

接受的值: None, SystemAssigned, UserAssigned

--location -l

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

与资源关联的用户分配的托管标识。

全局参数

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

等待在“Succeeded”中使用“provisioningState”创建。

默认值: 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 主体名称 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 获取完整的调试日志。

通过

az blueprint assignment

命令

az blueprint assignment create

示例

必需参数

可选参数

az blueprint assignment delete

示例

必需参数

可选参数

az blueprint assignment list

示例

可选参数

az blueprint assignment show

示例

必需参数

可选参数

az blueprint assignment update

必需参数

可选参数

az blueprint assignment wait

示例

必需参数

可选参数

az blueprint assignment who

示例

必需参数

可选参数

其他资源