通过

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

PolicyAssignmentsOperations 类

  • 参考

警告

请勿直接实例化此类。

相反，应通过以下方式访问以下操作：

PolicyClient's

<xref:policy_assignments> 属性。

继承
builtins.object
PolicyAssignmentsOperations

构造函数

PolicyAssignmentsOperations(*args, **kwargs)

方法

create

创建或更新策略分配。

此操作会创建或更新具有给定范围和名称的策略分配。 策略分配适用于其范围内包含的所有资源。 例如，在资源组范围内分配策略时，该策略将应用于组中的所有资源。
create_by_id

创建或更新策略分配。

此操作使用给定 ID 创建或更新策略分配。 对某个范围所做的策略分配适用于该范围中包含的所有资源。 例如，将策略分配给资源组时，该策略将应用于该组中的所有资源。 策略分配 ID 采用以下格式：“{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}”。 有效作用域为：管理组 (格式：'/providers/Microsoft.Management/managementGroups/{managementGroup}') ， 订阅 (格式：“/subscriptions/{subscriptionId}”) 、资源组 (格式：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}”或资源 (格式：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}”。
delete

删除策略分配。

此操作会删除策略分配，给定策略分配的名称和创建范围。 策略分配的范围是其 ID 前面“/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}”的部分。
delete_by_id

删除策略分配。

此操作会删除具有给定 ID 的策略。 策略分配 ID 采用以下格式：“{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}”。 {scope} 的有效格式为：“/providers/Microsoft.Management/managementGroups/{managementGroup}” (管理组) 、“/subscriptions/{subscriptionId}” (订阅) ， “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}” (资源组) ，或“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}” (资源) 。
get

检索策略分配。

此操作检索单个策略分配，给定其名称和创建范围。
get_by_id

检索具有给定 ID 的策略分配。

该操作检索具有给定 ID 的策略分配。 策略分配 ID 采用以下格式：“{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}”。 有效作用域为：管理组 (格式：'/providers/Microsoft.Management/managementGroups/{managementGroup}') ， 订阅 (格式：“/subscriptions/{subscriptionId}”) 、资源组 (格式：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}”或资源 (格式：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}”。
list

检索应用于订阅的所有策略分配。

此操作检索与给定订阅关联的与可选给定$filter匹配的所有策略分配的列表。 $filter的有效值为：“atScope () ”或“policyDefinitionId eq'{value}”。 如果未提供$filter，则未筛选列表包括与订阅关联的所有策略分配，包括直接应用或从包含给定订阅的管理组应用的策略分配，以及应用于订阅中包含的对象的任何策略分配。 如果提供了 $filter=atScope () ，则返回的列表包括应用于订阅的所有策略分配，该分配是未筛选列表中除应用于订阅中包含的对象以外的所有策略分配。 如果提供了 $filter=policyDefinitionId eq“{value}”，则返回的列表包括其 ID 为 {value} 的策略定义的所有策略分配。
list_for_resource

检索应用于资源的所有策略分配。

此操作检索与给定资源组和订阅中与可选给定$filter匹配的指定资源关联的所有策略分配的列表。 $filter的有效值为：“atScope () ”或“policyDefinitionId eq '{value}'”。 如果未提供$filter，则未筛选列表包括与资源关联的所有策略分配，包括直接应用或从所有包含范围应用的策略分配，以及应用于资源中包含的资源的任何策略分配。 如果提供了 $filter=atScope () ，则返回的列表将包括应用于资源的所有策略分配，即未筛选列表中除应用于资源中包含的资源以外的所有策略分配。 如果提供了 $filter=policyDefinitionId eq “{value}”，则返回的列表包括策略定义的所有策略分配，其 ID 为 {value}，应用于资源。 三个参数加上资源名称用于标识特定资源。 如果资源不是父资源的一部分 (更常见的情况) ，则父资源路径不应 (提供或作为“”) 提供。 例如，可以将 Web 应用指定为 ({resourceProviderNamespace} == 'Microsoft.Web'， {parentResourcePath} == ''， {resourceType} == 'sites'， {resourceName} == 'MyWebApp') 。 如果资源是父资源的一部分，则应提供所有参数。 例如，可以将虚拟机 DNS 名称指定为 ({resourceProviderNamespace} == 'Microsoft.Compute'， {parentResourcePath} == 'virtualMachines/MyVirtualMachine'， {resourceType} == 'domainNames'， {resourceName} == 'MyComputerName') 。 单独提供命名空间和类型名称的一种便捷替代方法是采用 {resourceType} 参数格式提供： ({resourceProviderNamespace} == ''、{parentResourcePath} == ''、{resourceType} == 'Microsoft.Web/sites'、{resourceName} == 'MyWebApp') 。
list_for_resource_group

检索应用于资源组的所有策略分配。

此操作检索与给定订阅中给定资源组关联的与可选给定$filter匹配的所有策略分配的列表。 $filter的有效值为：“atScope () ”或“policyDefinitionId eq '{value}'”。 如果未提供$filter，则未筛选列表包括与资源组关联的所有策略分配，包括直接应用或从包含范围应用的策略分配，以及应用于资源组中包含的资源的任何策略分配。 如果提供了 $filter=atScope () ，则返回的列表包括应用于资源组的所有策略分配，该分配是未筛选列表中除应用于资源组中包含的资源以外的所有策略分配。 如果提供了 $filter=policyDefinitionId eq “{value}”，则返回的列表包括策略定义的所有策略分配，其 ID 为 {value}，适用于资源组。

create

创建或更新策略分配。

此操作会创建或更新具有给定范围和名称的策略分配。 策略分配适用于其范围内包含的所有资源。 例如，在资源组范围内分配策略时，该策略将应用于组中的所有资源。

create(scope: str, policy_assignment_name: str, parameters: _models.PolicyAssignment, *, content_type: str = 'application/json', **kwargs: Any) -> _models.PolicyAssignment

参数

scope
str
必需

策略分配的范围。 有效作用域为：管理组 (格式：'/providers/Microsoft.Management/managementGroups/{managementGroup}') ， 订阅 (格式：“/subscriptions/{subscriptionId}”) 、资源组 (格式：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}”或资源 (格式：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}”。 必需。

policy_assignment_name
str
必需

策略分配的名称。 必需。

parameters
PolicyAssignment 或 IO
必需

策略分配的参数。 是 PolicyAssignment 类型或 IO 类型。 必需。

content_type
str

正文参数内容类型。 已知值为：“application/json”。 默认值为 None。

cls
callable

将传递直接响应的自定义类型或函数

返回

PolicyAssignment 或 cls 的结果 (响应)

返回类型

PolicyAssignment

例外

HttpResponseError

create_by_id

创建或更新策略分配。

此操作使用给定 ID 创建或更新策略分配。 对某个范围所做的策略分配适用于该范围中包含的所有资源。 例如，将策略分配给资源组时，该策略将应用于该组中的所有资源。 策略分配 ID 采用以下格式：“{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}”。 有效作用域为：管理组 (格式：'/providers/Microsoft.Management/managementGroups/{managementGroup}') ， 订阅 (格式：“/subscriptions/{subscriptionId}”) 、资源组 (格式：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}”或资源 (格式：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}”。

create_by_id(policy_assignment_id: str, parameters: _models.PolicyAssignment, *, content_type: str = 'application/json', **kwargs: Any) -> _models.PolicyAssignment

参数

policy_assignment_id
str
必需

要创建的策略分配的 ID。 使用格式“{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}”。 必需。

parameters
PolicyAssignment 或 IO
必需

策略分配的参数。 是 PolicyAssignment 类型或 IO 类型。 必需。

content_type
str

正文参数内容类型。 已知值为：“application/json”。 默认值为 None。

cls
callable

将传递直接响应的自定义类型或函数

返回

PolicyAssignment 或 cls 的结果 (响应)

返回类型

PolicyAssignment

例外

HttpResponseError

delete

删除策略分配。

此操作会删除策略分配，给定策略分配的名称和创建范围。 策略分配的范围是其 ID 前面“/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}”的部分。

delete(scope: str, policy_assignment_name: str, **kwargs: Any) -> PolicyAssignment | None

参数

scope
str
必需

策略分配的范围。 有效作用域为：管理组 (格式：'/providers/Microsoft.Management/managementGroups/{managementGroup}') ， 订阅 (格式：“/subscriptions/{subscriptionId}”) 、资源组 (格式：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}”或资源 (格式：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}”。 必需。

policy_assignment_name
str
必需

要删除的策略分配的名称。 必需。

cls
callable

将传递直接响应的自定义类型或函数

返回

PolicyAssignment 或 None 或 cls 的结果 (响应)

返回类型

PolicyAssignment,
None

例外

HttpResponseError

delete_by_id

删除策略分配。

此操作会删除具有给定 ID 的策略。 策略分配 ID 采用以下格式：“{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}”。 {scope} 的有效格式为：“/providers/Microsoft.Management/managementGroups/{managementGroup}” (管理组) 、“/subscriptions/{subscriptionId}” (订阅) ， “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}” (资源组) ，或“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}” (资源) 。

delete_by_id(policy_assignment_id: str, **kwargs: Any) -> PolicyAssignment | None

参数

policy_assignment_id
str
必需

要删除的策略分配的 ID。 使用格式“{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}”。 必需。

cls
callable

将传递直接响应的自定义类型或函数

返回

PolicyAssignment 或 None 或 cls 的结果 (响应)

返回类型

PolicyAssignment,
None

例外

HttpResponseError

get

检索策略分配。

此操作检索单个策略分配，给定其名称和创建范围。

get(scope: str, policy_assignment_name: str, **kwargs: Any) -> PolicyAssignment

参数

scope
str
必需

策略分配的范围。 有效作用域为：管理组 (格式：'/providers/Microsoft.Management/managementGroups/{managementGroup}') ， 订阅 (格式：“/subscriptions/{subscriptionId}”) 、资源组 (格式：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}”或资源 (格式：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}”。 必需。

policy_assignment_name
str
必需

要获取的策略分配的名称。 必需。

cls
callable

将传递直接响应的自定义类型或函数

返回

PolicyAssignment 或 cls 的结果 (响应)

返回类型

PolicyAssignment

例外

HttpResponseError

get_by_id

检索具有给定 ID 的策略分配。

该操作检索具有给定 ID 的策略分配。 策略分配 ID 采用以下格式：“{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}”。 有效作用域为：管理组 (格式：'/providers/Microsoft.Management/managementGroups/{managementGroup}') ， 订阅 (格式：“/subscriptions/{subscriptionId}”) 、资源组 (格式：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}”或资源 (格式：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}”。

get_by_id(policy_assignment_id: str, **kwargs: Any) -> PolicyAssignment

参数

policy_assignment_id
str
必需

要获取的策略分配的 ID。 使用格式“{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}”。 必需。

cls
callable

将传递直接响应的自定义类型或函数

返回

PolicyAssignment 或 cls 的结果 (响应)

返回类型

PolicyAssignment

例外

HttpResponseError

list

检索应用于订阅的所有策略分配。

此操作检索与给定订阅关联的与可选给定$filter匹配的所有策略分配的列表。 $filter的有效值为：“atScope () ”或“policyDefinitionId eq'{value}”。 如果未提供$filter，则未筛选列表包括与订阅关联的所有策略分配，包括直接应用或从包含给定订阅的管理组应用的策略分配，以及应用于订阅中包含的对象的任何策略分配。 如果提供了 $filter=atScope () ，则返回的列表包括应用于订阅的所有策略分配，该分配是未筛选列表中除应用于订阅中包含的对象以外的所有策略分配。 如果提供了 $filter=policyDefinitionId eq“{value}”，则返回的列表包括其 ID 为 {value} 的策略定义的所有策略分配。

list(filter: str | None = None, **kwargs: Any) -> Iterable[PolicyAssignment]

参数

filter
str
必需

要应用于操作的筛选器。 $filter的有效值为：“atScope () ”或“policyDefinitionId eq'{value}”。 如果未提供$filter，则不执行筛选。 默认值为 None。

cls
callable

将传递直接响应的自定义类型或函数

返回

一个迭代器，如 PolicyAssignment 的实例或 cls 的结果 (响应)

返回类型

ItemPaged[PolicyAssignment]

例外

HttpResponseError

list_for_resource

检索应用于资源的所有策略分配。

此操作检索与给定资源组和订阅中与可选给定$filter匹配的指定资源关联的所有策略分配的列表。 $filter的有效值为：“atScope () ”或“policyDefinitionId eq '{value}'”。 如果未提供$filter，则未筛选列表包括与资源关联的所有策略分配，包括直接应用或从所有包含范围应用的策略分配，以及应用于资源中包含的资源的任何策略分配。 如果提供了 $filter=atScope () ，则返回的列表将包括应用于资源的所有策略分配，即未筛选列表中除应用于资源中包含的资源以外的所有策略分配。 如果提供了 $filter=policyDefinitionId eq “{value}”，则返回的列表包括策略定义的所有策略分配，其 ID 为 {value}，应用于资源。 三个参数加上资源名称用于标识特定资源。 如果资源不是父资源的一部分 (更常见的情况) ，则父资源路径不应 (提供或作为“”) 提供。 例如，可以将 Web 应用指定为 ({resourceProviderNamespace} == 'Microsoft.Web'， {parentResourcePath} == ''， {resourceType} == 'sites'， {resourceName} == 'MyWebApp') 。 如果资源是父资源的一部分，则应提供所有参数。 例如，可以将虚拟机 DNS 名称指定为 ({resourceProviderNamespace} == 'Microsoft.Compute'， {parentResourcePath} == 'virtualMachines/MyVirtualMachine'， {resourceType} == 'domainNames'， {resourceName} == 'MyComputerName') 。 单独提供命名空间和类型名称的一种便捷替代方法是采用 {resourceType} 参数格式提供： ({resourceProviderNamespace} == ''、{parentResourcePath} == ''、{resourceType} == 'Microsoft.Web/sites'、{resourceName} == 'MyWebApp') 。

list_for_resource(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, filter: str | None = None, **kwargs: Any) -> Iterable[PolicyAssignment]

参数

resource_group_name
str
必需

包含资源的资源组的名称。 必需。

resource_provider_namespace
str
必需

资源提供程序的命名空间。 例如，虚拟机的命名空间是 Microsoft.Compute/virtualMachines) 中的 Microsoft.Compute (。 必需。

parent_resource_path
str
必需

父资源路径。 如果没有，请使用空字符串。 必需。

resource_type
str
必需

资源类型名称。 例如，Web 应用的类型名称是 Microsoft.Web/sites) (的“sites”。 必需。

resource_name
str
必需

资源的名称。 必需。

filter
str
必需

要应用于操作的筛选器。 $filter的有效值为：“atScope () ”或“policyDefinitionId eq '{value}'”。 如果未提供$filter，则不执行筛选。 默认值为 None。

cls
callable

将传递直接响应的自定义类型或函数

返回

迭代器，例如 PolicyAssignment 的实例或 cls (响应)

返回类型

ItemPaged[PolicyAssignment]

例外

HttpResponseError

list_for_resource_group

检索应用于资源组的所有策略分配。

此操作检索与给定订阅中给定资源组关联的与可选给定$filter匹配的所有策略分配的列表。 $filter的有效值为：“atScope () ”或“policyDefinitionId eq '{value}'”。 如果未提供$filter，则未筛选列表包括与资源组关联的所有策略分配，包括直接应用或从包含范围应用的策略分配，以及应用于资源组中包含的资源的任何策略分配。 如果提供了 $filter=atScope () ，则返回的列表包括应用于资源组的所有策略分配，该分配是未筛选列表中除应用于资源组中包含的资源以外的所有策略分配。 如果提供了 $filter=policyDefinitionId eq “{value}”，则返回的列表包括策略定义的所有策略分配，其 ID 为 {value}，适用于资源组。

list_for_resource_group(resource_group_name: str, filter: str | None = None, **kwargs: Any) -> Iterable[PolicyAssignment]

参数

resource_group_name
str
必需

包含策略分配的资源组的名称。 必需。

filter
str
必需

要应用于操作的筛选器。 $filter的有效值为：“atScope () ”或“policyDefinitionId eq '{value}'”。 如果未提供$filter，则不执行筛选。 默认值为 None。

cls
callable

将传递直接响应的自定义类型或函数

返回

迭代器，例如 PolicyAssignment 的实例或 cls (响应)

返回类型

ItemPaged[PolicyAssignment]

例外

HttpResponseError

属性

models 

models = <module 'azure.mgmt.resource.policy.v2019_06_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\resource\\policy\\v2019_06_01\\models\\__init__.py'>