PolicyExemptions interface

套件:

@azure/arm-policy

代表 PolicyExemptions 的介面。

方法

createOrUpdate(string, string, PolicyExemption, PolicyExemptionsCreateOrUpdateOptionalParams)	此作業會建立或更新具有指定範圍和名稱的原則豁免。 原則豁免適用於其範圍內所包含的所有資源。 例如，當您在相同或更高層級的原則指派資源群組範圍建立原則豁免時，豁免會豁免資源群組中的所有適用資源。
delete(string, string, PolicyExemptionsDeleteOptionalParams)	此作業會刪除原則豁免，並指定其名稱及其建立範圍。 原則豁免的範圍是其標識符前面 '/providers/Microsoft.Authorization/policyExemptions/{policyExemptionName}' 的一部分。
get(string, string, PolicyExemptionsGetOptionalParams)	此作業會擷取單一原則豁免，並指定其名稱及其建立範圍。
list(PolicyExemptionsListOptionalParams)	此作業會擷取與指定訂用帳戶相關聯的所有原則豁免清單，該訂用帳戶符合選擇性指定$filter。 $filter的有效值為：'atScope（）'、'atExactScope（）'、'excludeExpired（）' 或 'policyAssignmentId eq '{value}''。 如果未提供$filter，未篩選的清單會包含與訂用帳戶相關聯的所有原則豁免，包括直接套用或從包含指定訂用帳戶的管理群組，以及套用至訂用帳戶內包含之物件的任何原則豁免。
listForManagementGroup(string, PolicyExemptionsListForManagementGroupOptionalParams)	此作業會擷取適用於符合指定$filter之管理群組的所有原則豁免清單。 $filter的有效值為：'atScope（）'、'atExactScope（）'、'excludeExpired（）' 或 'policyAssignmentId eq '{value}''。 如果提供 $filter=atScope（） ，傳回的清單會包含指派給管理群組或管理群組上階的所有原則豁免。
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'）。
listForResourceGroup(string, PolicyExemptionsListForResourceGroupOptionalParams)	此作業會擷取與指定訂用帳戶中指定資源群組相關聯的所有原則豁免清單，該群組符合選擇性指定$filter。 $filter的有效值為：'atScope（）'、'atExactScope（）'、'excludeExpired（）' 或 'policyAssignmentId eq '{value}''。 如果未提供$filter，未篩選的清單會包含與資源群組相關聯的所有原則豁免，包括直接套用或套用自包含範圍的原則豁免，以及套用至資源群組內所含資源的任何原則豁免。
update(string, string, PolicyExemptionUpdate, PolicyExemptionsUpdateOptionalParams)	此作業會更新具有指定範圍和名稱的原則豁免。

方法詳細資料

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

原則豁免的參數。

options

PolicyExemptionsCreateOrUpdateOptionalParams

選項參數。

傳回

Promise<PolicyExemption>

delete(string, string, PolicyExemptionsDeleteOptionalParams)

此作業會刪除原則豁免，並指定其名稱及其建立範圍。 原則豁免的範圍是其標識符前面 '/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

要刪除的原則豁免名稱。

options

PolicyExemptionsDeleteOptionalParams

選項參數。

傳回

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

要刪除的原則豁免名稱。

options

PolicyExemptionsGetOptionalParams

選項參數。

傳回

Promise<PolicyExemption>

list(PolicyExemptionsListOptionalParams)

此作業會擷取與指定訂用帳戶相關聯的所有原則豁免清單，該訂用帳戶符合選擇性指定$filter。 $filter的有效值為：'atScope（）'、'atExactScope（）'、'excludeExpired（）' 或 'policyAssignmentId eq '{value}''。 如果未提供$filter，未篩選的清單會包含與訂用帳戶相關聯的所有原則豁免，包括直接套用或從包含指定訂用帳戶的管理群組，以及套用至訂用帳戶內包含之物件的任何原則豁免。

function list(options?: PolicyExemptionsListOptionalParams): PagedAsyncIterableIterator<PolicyExemption, PolicyExemption[], PageSettings>

參數

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

管理群組的標識碼。

options

PolicyExemptionsListForManagementGroupOptionalParams

選項參數。

傳回

PagedAsyncIterableIterator<PolicyExemption, PolicyExemption[], PageSettings>

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 （從 Microsoft.Compute/virtualMachines）

parentResourcePath

string

父資源路徑。 如果沒有，請使用空字串。

resourceType

string

資源類型名稱。 例如，Web 應用程式的類型名稱是 'sites' （從 Microsoft.Web/sites）。

resourceName

string

資源的名稱。

options

PolicyExemptionsListForResourceOptionalParams

選項參數。

傳回

PagedAsyncIterableIterator<PolicyExemption, PolicyExemption[], PageSettings>

listForResourceGroup(string, PolicyExemptionsListForResourceGroupOptionalParams)

此作業會擷取與指定訂用帳戶中指定資源群組相關聯的所有原則豁免清單，該群組符合選擇性指定$filter。 $filter的有效值為：'atScope（）'、'atExactScope（）'、'excludeExpired（）' 或 'policyAssignmentId eq '{value}''。 如果未提供$filter，未篩選的清單會包含與資源群組相關聯的所有原則豁免，包括直接套用或套用自包含範圍的原則豁免，以及套用至資源群組內所含資源的任何原則豁免。

function listForResourceGroup(resourceGroupName: string, options?: PolicyExemptionsListForResourceGroupOptionalParams): PagedAsyncIterableIterator<PolicyExemption, PolicyExemption[], PageSettings>

參數

resourceGroupName

string

包含資源的資源群組名稱。

options

PolicyExemptionsListForResourceGroupOptionalParams

選項參數。

傳回

PagedAsyncIterableIterator<PolicyExemption, PolicyExemption[], PageSettings>

update(string, string, PolicyExemptionUpdate, PolicyExemptionsUpdateOptionalParams)

此作業會更新具有指定範圍和名稱的原則豁免。

function update(scope: string, policyExemptionName: string, parameters: PolicyExemptionUpdate, options?: PolicyExemptionsUpdateOptionalParams): 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

PolicyExemptionUpdate

原則豁免修補程式要求的參數。

options

PolicyExemptionsUpdateOptionalParams

選項參數。

傳回

Promise<PolicyExemption>