你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
PolicyAssignmentsOperations 类
- 继承
-
builtins.objectPolicyAssignmentsOperations
构造函数
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_management_group |
检索应用于管理组的所有策略分配。 此操作检索适用于与给定$filter匹配的管理组的所有策略分配的列表。 $filter的有效值为:“atScope () ”或“policyDefinitionId eq '{value}'”。 如果提供了 $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}”。 必需。
- content_type
- str
Body 参数内容类型。 已知值为:“application/json”。 默认值为 None。
- cls
- callable
将传递直接响应的自定义类型或函数
返回
PolicyAssignment 或 cls 的结果 (响应)
返回类型
例外
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}”。 必需。
- content_type
- str
Body 参数内容类型。 已知值为:“application/json”。 默认值为 None。
- cls
- callable
将传递直接响应的自定义类型或函数
返回
PolicyAssignment 或 cls 的结果 (响应)
返回类型
例外
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}”。 必需。
- cls
- callable
将传递直接响应的自定义类型或函数
返回
PolicyAssignment 或 None 或 cls 的结果 (响应)
返回类型
例外
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 的结果 (响应)
返回类型
例外
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}”。 必需。
- cls
- callable
将传递直接响应的自定义类型或函数
返回
PolicyAssignment 或 cls 的结果 (响应)
返回类型
例外
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 的结果 (响应)
返回类型
例外
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 (响应)
返回类型
例外
list_for_management_group
检索应用于管理组的所有策略分配。
此操作检索适用于与给定$filter匹配的管理组的所有策略分配的列表。 $filter的有效值为:“atScope () ”或“policyDefinitionId eq '{value}'”。 如果提供了 $filter=atScope () ,则返回的列表包括分配给管理组或管理组的上级的所有策略分配。 如果提供了 $filter=policyDefinitionId eq “{value}”,则返回的列表包括策略定义的所有策略分配,其 ID 为 {value},适用于管理组。
list_for_management_group(management_group_id: str, filter: str, **kwargs: Any) -> Iterable[PolicyAssignment]
参数
- filter
- str
要应用于操作的筛选器。 $filter的有效值为:“atScope () ”或“policyDefinitionId eq '{value}'”。 在管理组范围内列出策略分配时,需要筛选器。 必需。
- cls
- callable
将传递直接响应的自定义类型或函数
返回
迭代器,例如 PolicyAssignment 的实例或 cls (响应)
返回类型
例外
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_provider_namespace
- str
资源提供程序的命名空间。 例如,虚拟机的命名空间是 Microsoft.Compute/virtualMachines) 中的 Microsoft.Compute (。 必需。
- filter
- str
要应用于操作的筛选器。 $filter的有效值为:“atScope () ”或“policyDefinitionId eq '{value}'”。 如果未提供$filter,则不执行筛选。 默认值为 None。
- cls
- callable
将传递直接响应的自定义类型或函数
返回
迭代器,例如 PolicyAssignment 的实例或 cls (响应)
返回类型
例外
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]
参数
- filter
- str
要应用于操作的筛选器。 $filter的有效值为:“atScope () ”或“policyDefinitionId eq '{value}'”。 如果未提供$filter,则不执行筛选。 默认值为 None。
- cls
- callable
将传递直接响应的自定义类型或函数
返回
迭代器,例如 PolicyAssignment 的实例或 cls (响应)
返回类型
例外
属性
models
models = <module 'azure.mgmt.resource.policy.v2019_09_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\resource\\policy\\v2019_09_01\\models\\__init__.py'>
反馈
https://aka.ms/ContentUserFeedback。
即将发布:在整个 2024 年,我们将逐步淘汰作为内容反馈机制的“GitHub 问题”,并将其取代为新的反馈系统。 有关详细信息,请参阅:提交和查看相关反馈