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

az policy assignment

管理策略分配。

策略分配用于将策略定义或策略集定义应用于给定的资源范围。

命令

名称 说明 类型 Status
az policy assignment create

创建策略分配。

Core GA
az policy assignment delete

删除策略分配。

Core GA
az policy assignment identity

策略分配的托管标识。

Core GA
az policy assignment identity assign

分配托管标识。

Core GA
az policy assignment identity remove

删除托管标识。

Core GA
az policy assignment identity show

检索托管标识。

Core GA
az policy assignment list

检索所有适用的策略分配。

Core GA
az policy assignment non-compliance-message

策略分配使用的不符合性消息。

Core GA
az policy assignment non-compliance-message create

创建不符合性消息。

Core GA
az policy assignment non-compliance-message delete

删除不符合性消息。

Core GA
az policy assignment non-compliance-message list

检索不符合性消息。

Core GA
az policy assignment non-compliance-message show

检索不符合性消息。

Core GA
az policy assignment non-compliance-message update

更新不符合性消息。

Core GA
az policy assignment show

检索策略分配。

Core GA
az policy assignment update

更新策略分配。

Core GA

az policy assignment create

创建策略分配。

使用给定的范围和名称创建策略分配。 策略分配适用于其范围内包含的所有资源。 例如,在资源组范围内分配策略时,该策略将应用于该组中的所有资源。

az policy assignment create [--assign-identity --mi-system-assigned --system-assigned]
                            [--definition-version]
                            [--description]
                            [--display-name]
                            [--enforcement-mode {Default, DoNotEnforce}]
                            [--identity-scope]
                            [--location]
                            [--metadata]
                            [--mi-user-assigned --user-assigned]
                            [--name]
                            [--non-compliance-messages]
                            [--not-scopes]
                            [--overrides]
                            [--params]
                            [--policy]
                            [--policy-set-definition]
                            [--resource-group]
                            [--resource-selectors]
                            [--role]
                            [--scope]

示例

在范围内创建资源策略分配

az policy assignment create --scope "/providers/Microsoft.Management/managementGroups/{managementGroupName}" --policy {policyName} -p "{ 'allowedLocations': { 'value': [ 'australiaeast', 'eastus', 'japaneast' ] } }"

创建资源策略分配并提供规则参数值

az Create a resource policy assignment and provide rule parameter values policy assignment create --policy {policyName} -p "{ 'allowedLocations': { 'value': [ 'australiaeast', 'eastus', 'japaneast' ] } }"

使用系统分配的标识创建资源策略分配

az policy assignment create --name myPolicy --policy {policyName} --mi-system-assigned --location eastus

使用具有参与者角色访问权限的系统分配标识创建资源策略分配

az policy assignment create --name myPolicy --policy {policyName} --mi-system-assigned --identity-scope /subscriptions/{subscriptionId} --role Contributor --location eastus

使用用户分配的标识创建资源策略分配

az policy assignment create --name myPolicy --policy {policyName} -g MyResourceGroup --mi-user-assigned myAssignedId --location westus

使用强制模式创建资源策略分配

az policy assignment create --name myPolicy --policy {policyName} --enforcement-mode DoNotEnforce

可选参数

以下参数是可选的,但根据上下文,命令可能需要一个或多个参数才能成功执行。

--assign-identity --mi-system-assigned --system-assigned

设置系统分配的托管标识。

属性
参数组: Identity Arguments
--definition-version

要分配的策略版本。

属性
参数组: Properties Arguments
--description

策略分配说明。

属性
参数组: Properties Arguments
--display-name

策略分配的显示名称。

属性
参数组: Properties Arguments
--enforcement-mode -e

策略分配强制模式。

属性
参数组: Properties Arguments
默认值: Default
接受的值: Default, DoNotEnforce
--identity-scope

系统分配的标识可以访问的范围。

--location -l

策略分配的位置。

属性
参数组: Parameters Arguments
--metadata

策略分配元数据。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

属性
参数组: Properties Arguments
--mi-user-assigned --user-assigned

设置用户分配的托管标识。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

属性
参数组: Identity Arguments
--name -n

策略分配的名称。

--non-compliance-messages -m

描述资源不符合策略的原因的消息。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

属性
参数组: non-compliance-message Arguments
--not-scopes

策略分配排除的范围。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

属性
参数组: Properties Arguments
--overrides

策略替代。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

属性
参数组: Properties Arguments
--params -p

分配的策略规则的参数值。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

属性
参数组: Properties Arguments
--policy

要分配的策略定义或策略集定义的名称或资源 ID。

--policy-set-definition -d

要分配的策略定义或策略集定义。

属性
参数组: Properties Arguments
--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

--resource-selectors

按资源属性筛选策略的资源选择器列表。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

属性
参数组: Properties Arguments
--role

将分配给托管标识的角色名称或 ID。

--scope

策略分配的范围。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误,禁止显示警告。

属性
默认值: False
--output -o

输出格式。

属性
默认值: 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 policy assignment delete

删除策略分配。

删除具有给定名称和作用域的策略分配。

az policy assignment delete --name
                            [--resource-group]
                            [--scope]

示例

在范围内删除策略分配

az policy assignment delete --scope subscriptions/{subscriptionId} --name EnforceNaming

删除策略分配

az policy assignment delete --name MyPolicyAssignment

必需参数

--name -n

策略分配的名称。

可选参数

以下参数是可选的,但根据上下文,命令可能需要一个或多个参数才能成功执行。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

--scope

策略分配的范围。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误,禁止显示警告。

属性
默认值: False
--output -o

输出格式。

属性
默认值: 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 policy assignment list

检索所有适用的策略分配。

检索适用于给定订阅或管理组的所有策略分配的列表。

az policy assignment list [--disable-scope-strict-match {0, 1, f, false, n, no, t, true, y, yes}]
                          [--expand]
                          [--filter]
                          [--management-group]
                          [--max-items]
                          [--next-token]
                          [--resource-group]
                          [--scope]

示例

列出应用于资源组的策略分配

az policy assignment list --resource-group TestResourceGroup --filter atScope() --expand LatestDefinitionVersion, EffectiveDefinitionVersion

列出应用于管理组的策略分配

az policy assignment list --management-group TestManagementGroup --filter atScope()

列出应用于订阅的策略分配

az policy assignment list --filter atScope()

可选参数

以下参数是可选的,但根据上下文,命令可能需要一个或多个参数才能成功执行。

--disable-scope-strict-match -d

包括从父范围继承或子范围继承的策略分配。

属性
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--expand

要包含在输出中的其他属性。

--filter

筛选列表结果。

--management-group

管理组。

--max-items

命令输出中要返回的项总数。 如果可用的项总数大于指定的值,则会在命令的输出中提供令牌。 若要恢复分页,请在后续命令的 --next-token 参数中提供令牌值。

属性
参数组: Pagination Arguments
--next-token

用于指定开始分页的位置的令牌。 这是先前截断的响应中的令牌值。

属性
参数组: Pagination Arguments
--resource-group -g

资源组。

--scope

列出适用策略分配的范围。 如果未提供范围,范围将是隐含的或指定的订阅。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误,禁止显示警告。

属性
默认值: False
--output -o

输出格式。

属性
默认值: 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 policy assignment show

检索策略分配。

检索并显示具有给定名称和范围的单个策略分配的详细信息。

az policy assignment show --name
                          [--expand]
                          [--resource-group]
                          [--scope]

示例

显示资源策略分配

az policy assignment show --name MyPolicyAssignment

必需参数

--name -n

策略分配的名称。

可选参数

以下参数是可选的,但根据上下文,命令可能需要一个或多个参数才能成功执行。

--expand

要包含在输出中的其他属性。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

--scope

策略分配的范围。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误,禁止显示警告。

属性
默认值: False
--output -o

输出格式。

属性
默认值: 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 policy assignment update

更新策略分配。

通过应用给定属性值,使用给定名称和范围更新策略分配。

az policy assignment update --name
                            [--add]
                            [--definition-version]
                            [--description]
                            [--display-name]
                            [--enforcement-mode {Default, DoNotEnforce}]
                            [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                            [--location]
                            [--metadata]
                            [--non-compliance-messages]
                            [--not-scopes]
                            [--overrides]
                            [--params]
                            [--policy]
                            [--policy-set-definition]
                            [--remove]
                            [--resource-group]
                            [--resource-selectors]
                            [--scope]
                            [--set]

示例

更新资源策略分配的说明

az policy assignment update --name myPolicy --description 'My policy description'

必需参数

--name -n

策略分配的名称。

可选参数

以下参数是可选的,但根据上下文,命令可能需要一个或多个参数才能成功执行。

--add

通过指定路径和键值对将对象添加到对象列表。 示例:--add property.listProperty <key=value, string or JSON string>

属性
参数组: Generic Update Arguments
--definition-version

要分配的策略版本。

属性
参数组: Properties Arguments
--description

策略分配说明。

属性
参数组: Properties Arguments
--display-name

策略分配的显示名称。

属性
参数组: Properties Arguments
--enforcement-mode -e

策略分配强制模式。

属性
参数组: Properties Arguments
接受的值: Default, DoNotEnforce
--force-string

使用“set”或“add”时,保留字符串文本,而不是尝试转换为 JSON。

属性
参数组: Generic Update Arguments
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--location -l

策略分配的位置。

属性
参数组: Parameters Arguments
--metadata

策略分配元数据。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

属性
参数组: Properties Arguments
--non-compliance-messages -m

描述资源不符合策略的原因的消息。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

属性
参数组: non-compliance-message Arguments
--not-scopes

策略分配排除的范围。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

属性
参数组: Properties Arguments
--overrides

策略属性值重写。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

属性
参数组: Properties Arguments
--params -p

分配的策略规则的参数值。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

属性
参数组: Properties Arguments
--policy

要分配的策略定义或策略集定义的名称或资源 ID。

--policy-set-definition -d

要分配的策略定义或策略集定义。

属性
参数组: Properties Arguments
--remove

从列表中删除属性或元素。 示例: --remove property.list <indexToRemove> OR --remove propertyToRemove.

属性
参数组: Generic Update Arguments
--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

--resource-selectors

按资源属性筛选策略的资源选择器列表。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

属性
参数组: Properties Arguments
--scope

策略分配的范围。

--set

通过指定要设置的属性路径和值来更新对象。 示例:--set property1.property2=<value>

属性
参数组: Generic Update Arguments
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误,禁止显示警告。

属性
默认值: False
--output -o

输出格式。

属性
默认值: 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