你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
PolicyExemptions interface
表示 PolicyExemptions 的接口。
方法
create |
此操作会创建或更新具有给定范围和名称的策略豁免。 策略豁免适用于其范围内包含的所有资源。 例如,在资源组范围内为相同或更高级别的策略分配创建策略豁免时,该豁免将免除资源组中的所有适用资源。 |
delete(string, string, Policy |
此操作会根据策略豁免的名称和创建范围删除策略豁免。 策略豁免的范围是其 ID 前面“/providers/Microsoft.Authorization/policyExemptions/{policyExemptionName}”的一部分。 |
get(string, string, Policy |
此操作检索单个策略豁免,给定其名称和创建范围。 |
list(Policy |
此操作检索与给定订阅关联的与可选给定$filter匹配的所有策略豁免列表。 $filter的有效值为:“atScope () ”、“atExactScope () ”、“excludeExpired () ”或“policyAssignmentId eq '{value}'”。 如果未提供$filter,则未筛选列表包括与订阅关联的所有策略豁免,包括直接应用或来自包含给定订阅的管理组的策略豁免,以及应用于订阅中包含的对象的任何策略豁免。 |
list |
此操作检索适用于与给定$filter匹配的管理组的所有策略豁免列表。 $filter的有效值为:“atScope () ”、“atExactScope () ”、“excludeExpired () ”或“policyAssignmentId eq '{value}'”。 如果提供了 $filter=atScope () ,则返回的列表包括分配给管理组或管理组的上级的所有策略豁免。 |
list |
此操作检索与给定资源组和订阅中与可选给定$filter匹配的指定资源关联的所有策略豁免列表。 $filter的有效值为:“atScope () ”、“atExactScope () ”、“excludeExpired () ”或“policyAssignmentId eq '{value}'”。 如果未提供$filter,则未筛选列表包括与资源关联的所有策略豁免,包括直接应用或从所有包含作用域应用的豁免,以及应用于资源中包含的资源的任何策略豁免。 三个参数加上资源名称用于标识特定资源。 如果资源不是父资源的一部分 (更常见的情况) ,则父资源路径不应 (提供或作为“”) 提供。 例如,可以将 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 |
此操作检索与给定订阅中给定资源组关联的与可选给定$filter匹配的所有策略豁免列表。 $filter的有效值为:“atScope () ”、“atExactScope () ”、“excludeExpired () ”或“policyAssignmentId eq '{value}'”。 如果未提供$filter,则未筛选列表包括与资源组关联的所有策略豁免,包括直接应用或从包含范围应用的策略豁免,以及应用于资源组中包含的资源的任何策略豁免。 |
方法详细信息
createOrUpdate(string, string, PolicyExemption, PolicyExemptionsCreateOrUpdateOptionalParams)
此操作会创建或更新具有给定范围和名称的策略豁免。 策略豁免适用于其范围内包含的所有资源。 例如,在资源组范围内为相同或更高级别的策略分配创建策略豁免时,该豁免将免除资源组中的所有适用资源。
function createOrUpdate(scope: string, policyExemptionName: string, parameters: PolicyExemption, options?: PolicyExemptionsCreateOrUpdateOptionalParams): Promise<PolicyExemption>
参数
- scope
-
string
策略豁免的范围。 有效作用域为:管理组 (格式:'/providers/Microsoft.Management/managementGroups/{managementGroup}') , 订阅 (格式:“/subscriptions/{subscriptionId}”) ,资源组 (格式:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}”,或资源 (格式:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}”
- policyExemptionName
-
string
要删除的策略豁免的名称。
- parameters
- PolicyExemption
策略豁免的参数。
选项参数。
返回
Promise<PolicyExemption>
delete(string, string, PolicyExemptionsDeleteOptionalParams)
此操作会根据策略豁免的名称和创建范围删除策略豁免。 策略豁免的范围是其 ID 前面“/providers/Microsoft.Authorization/policyExemptions/{policyExemptionName}”的一部分。
function delete(scope: string, policyExemptionName: string, options?: PolicyExemptionsDeleteOptionalParams): Promise<void>
参数
- scope
-
string
策略豁免的范围。 有效作用域为:管理组 (格式:'/providers/Microsoft.Management/managementGroups/{managementGroup}') , 订阅 (格式:“/subscriptions/{subscriptionId}”) ,资源组 (格式:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}”,或资源 (格式:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}”
- policyExemptionName
-
string
要删除的策略豁免的名称。
选项参数。
返回
Promise<void>
get(string, string, PolicyExemptionsGetOptionalParams)
此操作检索单个策略豁免,给定其名称和创建范围。
function get(scope: string, policyExemptionName: string, options?: PolicyExemptionsGetOptionalParams): Promise<PolicyExemption>
参数
- scope
-
string
策略豁免的范围。 有效作用域为:管理组 (格式:'/providers/Microsoft.Management/managementGroups/{managementGroup}') , 订阅 (格式:“/subscriptions/{subscriptionId}”) ,资源组 (格式:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}”,或资源 (格式:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}”
- policyExemptionName
-
string
要删除的策略豁免的名称。
选项参数。
返回
Promise<PolicyExemption>
list(PolicyExemptionsListOptionalParams)
此操作检索与给定订阅关联的与可选给定$filter匹配的所有策略豁免列表。 $filter的有效值为:“atScope () ”、“atExactScope () ”、“excludeExpired () ”或“policyAssignmentId eq '{value}'”。 如果未提供$filter,则未筛选列表包括与订阅关联的所有策略豁免,包括直接应用或来自包含给定订阅的管理组的策略豁免,以及应用于订阅中包含的对象的任何策略豁免。
function list(options?: PolicyExemptionsListOptionalParams): PagedAsyncIterableIterator<PolicyExemption, PolicyExemption[], PageSettings>
参数
选项参数。
返回
listForManagementGroup(string, PolicyExemptionsListForManagementGroupOptionalParams)
此操作检索适用于与给定$filter匹配的管理组的所有策略豁免列表。 $filter的有效值为:“atScope () ”、“atExactScope () ”、“excludeExpired () ”或“policyAssignmentId eq '{value}'”。 如果提供了 $filter=atScope () ,则返回的列表包括分配给管理组或管理组的上级的所有策略豁免。
function listForManagementGroup(managementGroupId: string, options?: PolicyExemptionsListForManagementGroupOptionalParams): PagedAsyncIterableIterator<PolicyExemption, PolicyExemption[], PageSettings>
参数
- managementGroupId
-
string
管理组的 ID。
选项参数。
返回
listForResource(string, string, string, string, string, PolicyExemptionsListForResourceOptionalParams)
此操作检索与给定资源组和订阅中与可选给定$filter匹配的指定资源关联的所有策略豁免列表。 $filter的有效值为:“atScope () ”、“atExactScope () ”、“excludeExpired () ”或“policyAssignmentId eq '{value}'”。 如果未提供$filter,则未筛选列表包括与资源关联的所有策略豁免,包括直接应用或从所有包含作用域应用的豁免,以及应用于资源中包含的资源的任何策略豁免。 三个参数加上资源名称用于标识特定资源。 如果资源不是父资源的一部分 (更常见的情况) ,则父资源路径不应 (提供或作为“”) 提供。 例如,可以将 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') 。
function listForResource(resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, options?: PolicyExemptionsListForResourceOptionalParams): PagedAsyncIterableIterator<PolicyExemption, PolicyExemption[], PageSettings>
参数
- resourceGroupName
-
string
包含资源的资源组的名称。
- resourceProviderNamespace
-
string
资源提供程序的命名空间。 例如,虚拟机的命名空间是 Microsoft.Compute/virtualMachines) 中的 Microsoft.Compute (
- parentResourcePath
-
string
父资源路径。 如果没有,请使用空字符串。
- resourceType
-
string
资源类型名称。 例如,Web 应用的类型名称是 Microsoft.Web/sites) (的“sites”。
- resourceName
-
string
资源的名称。
选项参数。
返回
listForResourceGroup(string, PolicyExemptionsListForResourceGroupOptionalParams)
此操作检索与给定订阅中给定资源组关联的与可选给定$filter匹配的所有策略豁免列表。 $filter的有效值为:“atScope () ”、“atExactScope () ”、“excludeExpired () ”或“policyAssignmentId eq '{value}'”。 如果未提供$filter,则未筛选列表包括与资源组关联的所有策略豁免,包括直接应用或从包含范围应用的策略豁免,以及应用于资源组中包含的资源的任何策略豁免。
function listForResourceGroup(resourceGroupName: string, options?: PolicyExemptionsListForResourceGroupOptionalParams): PagedAsyncIterableIterator<PolicyExemption, PolicyExemption[], PageSettings>
参数
- resourceGroupName
-
string
包含资源的资源组的名称。
选项参数。