你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
PolicyAssignments interface
表示 PolicyAssignments 的接口。
方法
| create(string, string, Policy |
此作使用给定的范围和名称创建或更新策略分配。 策略分配适用于其范围内包含的所有资源。 例如，在资源组范围内分配策略时，该策略将应用于该组中的所有资源。 |
| create |
此作使用给定 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(string, string, Policy |
此作会删除策略分配，给定其名称和创建范围。 策略分配的范围是其 ID 前面的“/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}”的一部分。 |
| delete |
此作将删除具有给定 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(string, string, Policy |
此作检索单个策略分配，给定其名称和创建范围。 |
| get |
该作检索具有给定 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(Policy |
此作检索与给定订阅关联的与给定订阅关联的所有策略分配的列表，这些分配与可选的给定$filter匹配。 $filter的有效值为：“atScope（）”、“atExactScope（）”或“policyDefinitionId eq”{value}”。 如果未提供$filter，则未筛选的列表包括与订阅关联的所有策略分配，包括直接应用或来自包含给定订阅的管理组的策略分配，以及应用于订阅中包含的对象的任何策略分配。 如果提供了 $filter=atScope（），则返回的列表包括应用于订阅的所有策略分配，这是未筛选列表中的所有内容，但应用于订阅中包含的对象除外。 如果提供了 $filter=atExactScope（），则返回的列表仅包括订阅中的所有策略分配。 如果提供了 $filter=policyDefinitionId eq “{value}”，则返回的列表包括 ID 为 {value} 的策略定义的所有策略分配。 |
| list |
此作检索适用于与给定$filter匹配的管理组的所有策略分配的列表。 $filter的有效值为：“atScope（）”、“atExactScope（）”或“policyDefinitionId eq”{value}”。 如果提供了 $filter=atScope（），则返回的列表包括分配给管理组或管理组的上级的所有策略分配。 如果提供了 $filter=atExactScope（），则返回的列表仅包括管理组中的所有策略分配。 如果提供了 $filter=policyDefinitionId eq “{value}”，则返回的列表包括应用于管理组的策略定义的所有策略分配，其 ID 为 {value} 。 |
| list |
此作检索与给定资源组和订阅中与指定资源关联的所有策略分配的列表，这些分配与可选给定$filter匹配。 $filter的有效值为：“atScope（）”、“atExactScope（）”或“policyDefinitionId eq”{value}”。 如果未提供$filter，则未筛选列表包括与资源关联的所有策略分配，包括直接应用或从所有包含范围应用的策略分配，以及应用于资源中包含的资源的任何分配。 如果提供了 $filter=atScope（），则返回的列表包括应用于资源的所有策略分配，这是未筛选列表中的所有内容，但应用于资源中包含的资源除外。 如果提供了 $filter=atExactScope（），则返回的列表仅包括资源级别的所有策略分配。 如果提供了 $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} == ''， {resourceType} == 'Microsoft.Web/sites'， {resourceName} == 'MyWebApp'） 中提供这两者。 |
| list |
此作检索与给定订阅中给定资源组关联的所有策略分配的列表，该组与可选给定$filter匹配。 $filter的有效值为：“atScope（）”、“atExactScope（）”或“policyDefinitionId eq”{value}”。 如果未提供$filter，则未筛选的列表包括与资源组关联的所有策略分配，包括直接应用或从包含范围应用的策略分配，以及应用于资源组中包含的资源的任何分配。 如果提供了 $filter=atScope（），则返回的列表包括应用于资源组的所有策略分配，这是未筛选列表中的所有内容，但应用于资源组中包含的资源除外。 如果提供了 $filter=atExactScope（），则返回的列表仅包括资源组中的所有策略分配。 如果提供了 $filter=policyDefinitionId eq “{value}”，则返回的列表包括应用于资源组的策略定义的所有策略分配，其 ID 为 {value} 。 |
| update(string, string, Policy |
此作使用给定的范围和名称更新策略分配。 策略分配适用于其范围内包含的所有资源。 例如，在资源组范围内分配策略时，该策略将应用于该组中的所有资源。 |
| update |
此作使用给定 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(string, string, PolicyAssignment, PolicyAssignmentsCreateOptionalParams)
此作使用给定的范围和名称创建或更新策略分配。 策略分配适用于其范围内包含的所有资源。 例如，在资源组范围内分配策略时，该策略将应用于该组中的所有资源。
function create(scope: string, policyAssignmentName: string, parameters: PolicyAssignment, options?: PolicyAssignmentsCreateOptionalParams): Promise<PolicyAssignment>参数
- scope
-
string
策略分配的范围。 有效范围包括：管理组（格式：'/providers/Microsoft.Management/managementGroups/{managementGroup}'）、订阅（格式：'/subscriptions/{subscriptionId}'）、资源组（格式：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'， 或资源（格式：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'
- policyAssignmentName
-
string
策略分配的名称。
- parameters
- PolicyAssignment
策略分配的参数。
选项参数。
返回
Promise<PolicyAssignment>
createById(string, PolicyAssignment, PolicyAssignmentsCreateByIdOptionalParams)
此作使用给定 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}'。
function createById(policyAssignmentId: string, parameters: PolicyAssignment, options?: PolicyAssignmentsCreateByIdOptionalParams): Promise<PolicyAssignment>参数
- policyAssignmentId
-
string
要创建的策略分配的 ID。 使用格式“{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}”。
- parameters
- PolicyAssignment
策略分配的参数。
选项参数。
返回
Promise<PolicyAssignment>
delete(string, string, PolicyAssignmentsDeleteOptionalParams)
此作会删除策略分配，给定其名称和创建范围。 策略分配的范围是其 ID 前面的“/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}”的一部分。
function delete(scope: string, policyAssignmentName: string, options?: PolicyAssignmentsDeleteOptionalParams): Promise<PolicyAssignment>参数
- scope
-
string
策略分配的范围。 有效范围包括：管理组（格式：'/providers/Microsoft.Management/managementGroups/{managementGroup}'）、订阅（格式：'/subscriptions/{subscriptionId}'）、资源组（格式：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'， 或资源（格式：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'
- policyAssignmentName
-
string
要删除的策略分配的名称。
选项参数。
返回
Promise<PolicyAssignment>
deleteById(string, PolicyAssignmentsDeleteByIdOptionalParams)
此作将删除具有给定 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}“（资源）。
function deleteById(policyAssignmentId: string, options?: PolicyAssignmentsDeleteByIdOptionalParams): Promise<PolicyAssignment>参数
- policyAssignmentId
-
string
要删除的策略分配的 ID。 使用格式“{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}”。
选项参数。
返回
Promise<PolicyAssignment>
get(string, string, PolicyAssignmentsGetOptionalParams)
此作检索单个策略分配，给定其名称和创建范围。
function get(scope: string, policyAssignmentName: string, options?: PolicyAssignmentsGetOptionalParams): Promise<PolicyAssignment>参数
- scope
-
string
策略分配的范围。 有效范围包括：管理组（格式：'/providers/Microsoft.Management/managementGroups/{managementGroup}'）、订阅（格式：'/subscriptions/{subscriptionId}'）、资源组（格式：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'， 或资源（格式：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'
- policyAssignmentName
-
string
要获取的策略分配的名称。
选项参数。
返回
Promise<PolicyAssignment>
getById(string, PolicyAssignmentsGetByIdOptionalParams)
该作检索具有给定 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}'。
function getById(policyAssignmentId: string, options?: PolicyAssignmentsGetByIdOptionalParams): Promise<PolicyAssignment>参数
- policyAssignmentId
-
string
要获取的策略分配的 ID。 使用格式“{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}”。
选项参数。
返回
Promise<PolicyAssignment>
list(PolicyAssignmentsListOptionalParams)
此作检索与给定订阅关联的与给定订阅关联的所有策略分配的列表，这些分配与可选的给定$filter匹配。 $filter的有效值为：“atScope（）”、“atExactScope（）”或“policyDefinitionId eq”{value}”。 如果未提供$filter，则未筛选的列表包括与订阅关联的所有策略分配，包括直接应用或来自包含给定订阅的管理组的策略分配，以及应用于订阅中包含的对象的任何策略分配。 如果提供了 $filter=atScope（），则返回的列表包括应用于订阅的所有策略分配，这是未筛选列表中的所有内容，但应用于订阅中包含的对象除外。 如果提供了 $filter=atExactScope（），则返回的列表仅包括订阅中的所有策略分配。 如果提供了 $filter=policyDefinitionId eq “{value}”，则返回的列表包括 ID 为 {value} 的策略定义的所有策略分配。
function list(options?: PolicyAssignmentsListOptionalParams): PagedAsyncIterableIterator<PolicyAssignment, PolicyAssignment[], PageSettings>参数
选项参数。
返回
listForManagementGroup(string, PolicyAssignmentsListForManagementGroupOptionalParams)
此作检索适用于与给定$filter匹配的管理组的所有策略分配的列表。 $filter的有效值为：“atScope（）”、“atExactScope（）”或“policyDefinitionId eq”{value}”。 如果提供了 $filter=atScope（），则返回的列表包括分配给管理组或管理组的上级的所有策略分配。 如果提供了 $filter=atExactScope（），则返回的列表仅包括管理组中的所有策略分配。 如果提供了 $filter=policyDefinitionId eq “{value}”，则返回的列表包括应用于管理组的策略定义的所有策略分配，其 ID 为 {value} 。
function listForManagementGroup(managementGroupId: string, options?: PolicyAssignmentsListForManagementGroupOptionalParams): PagedAsyncIterableIterator<PolicyAssignment, PolicyAssignment[], PageSettings>参数
- managementGroupId
-
string
管理组的 ID。
选项参数。
返回
listForResource(string, string, string, string, string, PolicyAssignmentsListForResourceOptionalParams)
此作检索与给定资源组和订阅中与指定资源关联的所有策略分配的列表，这些分配与可选给定$filter匹配。 $filter的有效值为：“atScope（）”、“atExactScope（）”或“policyDefinitionId eq”{value}”。 如果未提供$filter，则未筛选列表包括与资源关联的所有策略分配，包括直接应用或从所有包含范围应用的策略分配，以及应用于资源中包含的资源的任何分配。 如果提供了 $filter=atScope（），则返回的列表包括应用于资源的所有策略分配，这是未筛选列表中的所有内容，但应用于资源中包含的资源除外。 如果提供了 $filter=atExactScope（），则返回的列表仅包括资源级别的所有策略分配。 如果提供了 $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} == ''， {resourceType} == 'Microsoft.Web/sites'， {resourceName} == 'MyWebApp'） 中提供这两者。
function listForResource(resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, options?: PolicyAssignmentsListForResourceOptionalParams): PagedAsyncIterableIterator<PolicyAssignment, PolicyAssignment[], PageSettings>参数
- resourceGroupName
-
string
包含资源的资源组的名称。
- resourceProviderNamespace
-
string
资源提供程序的命名空间。 例如，虚拟机的命名空间Microsoft.Compute（来自 Microsoft.Compute/virtualMachines）
- parentResourcePath
-
string
父资源路径。 如果没有，请使用空字符串。
- resourceType
-
string
资源类型名称。 例如，Web 应用的类型名称为“sites”（来自 Microsoft.Web/sites）。
- resourceName
-
string
资源的名称。
选项参数。
返回
listForResourceGroup(string, PolicyAssignmentsListForResourceGroupOptionalParams)
此作检索与给定订阅中给定资源组关联的所有策略分配的列表，该组与可选给定$filter匹配。 $filter的有效值为：“atScope（）”、“atExactScope（）”或“policyDefinitionId eq”{value}”。 如果未提供$filter，则未筛选的列表包括与资源组关联的所有策略分配，包括直接应用或从包含范围应用的策略分配，以及应用于资源组中包含的资源的任何分配。 如果提供了 $filter=atScope（），则返回的列表包括应用于资源组的所有策略分配，这是未筛选列表中的所有内容，但应用于资源组中包含的资源除外。 如果提供了 $filter=atExactScope（），则返回的列表仅包括资源组中的所有策略分配。 如果提供了 $filter=policyDefinitionId eq “{value}”，则返回的列表包括应用于资源组的策略定义的所有策略分配，其 ID 为 {value} 。
function listForResourceGroup(resourceGroupName: string, options?: PolicyAssignmentsListForResourceGroupOptionalParams): PagedAsyncIterableIterator<PolicyAssignment, PolicyAssignment[], PageSettings>参数
- resourceGroupName
-
string
包含策略分配的资源组的名称。
选项参数。
返回
update(string, string, PolicyAssignmentUpdate, PolicyAssignmentsUpdateOptionalParams)
此作使用给定的范围和名称更新策略分配。 策略分配适用于其范围内包含的所有资源。 例如，在资源组范围内分配策略时，该策略将应用于该组中的所有资源。
function update(scope: string, policyAssignmentName: string, parameters: PolicyAssignmentUpdate, options?: PolicyAssignmentsUpdateOptionalParams): Promise<PolicyAssignment>参数
- scope
-
string
策略分配的范围。 有效范围包括：管理组（格式：'/providers/Microsoft.Management/managementGroups/{managementGroup}'）、订阅（格式：'/subscriptions/{subscriptionId}'）、资源组（格式：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'， 或资源（格式：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'
- policyAssignmentName
-
string
策略分配的名称。
- parameters
- PolicyAssignmentUpdate
策略分配修补请求的参数。
选项参数。
返回
Promise<PolicyAssignment>
updateById(string, PolicyAssignmentUpdate, PolicyAssignmentsUpdateByIdOptionalParams)
此作使用给定 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}'。
function updateById(policyAssignmentId: string, parameters: PolicyAssignmentUpdate, options?: PolicyAssignmentsUpdateByIdOptionalParams): Promise<PolicyAssignment>参数
- policyAssignmentId
-
string
要更新的策略分配的 ID。 使用格式“{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}”。
- parameters
- PolicyAssignmentUpdate
策略分配修补请求的参数。
选项参数。
返回
Promise<PolicyAssignment>