PolicyExemptions interface
PolicyExemptions を表すインターフェイス。
メソッド
| create |
この操作により、指定されたスコープと名前でポリシーの除外が作成または更新されます。 ポリシーの除外は、スコープ内に含まれるすべてのリソースに適用されます。 たとえば、同じレベル以上のレベルでポリシー割り当てのリソース グループ スコープでポリシーの除外を作成すると、その除外はリソース グループ内のすべての適用可能なリソースに対して除外されます。 |
| delete(string, string, Policy |
この操作は、ポリシーの名前と作成されたスコープを指定して、ポリシーの除外を削除します。 ポリシー除外のスコープは、'/providers/Microsoft.Authorization/policyExemptions/{policyExemptionName}' の前の ID の一部です。 |
| get(string, string, Policy |
この操作は、名前と作成されたスコープを指定して、1 つのポリシー除外を取得します。 |
| 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指定されていない場合、フィルター処理されていないリストには、リソースに関連付けられているすべてのポリシー除外が含まれます。これには、直接適用されるポリシーや、スコープを含むすべてのスコープから適用されるもの、およびリソース内に含まれるリソースに適用されるものも含まれます。 特定のリソースを識別するには、3 つのパラメーターとリソース名が使用されます。 リソースが親リソースの一部でない場合 (より一般的なケース)、親リソース パスを指定 (または '' として指定) しないでください。 たとえば、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指定されていない場合、フィルター処理されていない一覧には、リソース グループに関連付けられているすべてのポリシー除外が含まれます。これには、直接適用されるポリシーや、スコープを含む対象から適用されるもの、およびリソース グループ内に含まれるリソースに適用されるものも含まれます。 |
| update(string, string, Policy |
この操作により、指定されたスコープと名前でポリシーの除外が更新されます。 |
メソッドの詳細
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)
この操作は、ポリシーの名前と作成されたスコープを指定して、ポリシーの除外を削除します。 ポリシー除外のスコープは、'/providers/Microsoft.Authorization/policyExemptions/{policyExemptionName}' の前の ID の一部です。
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)
この操作は、名前と作成されたスコープを指定して、1 つのポリシー除外を取得します。
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指定されていない場合、フィルター処理されていないリストには、リソースに関連付けられているすべてのポリシー除外が含まれます。これには、直接適用されるポリシーや、スコープを含むすべてのスコープから適用されるもの、およびリソース内に含まれるリソースに適用されるものも含まれます。 特定のリソースを識別するには、3 つのパラメーターとリソース名が使用されます。 リソースが親リソースの一部でない場合 (より一般的なケース)、親リソース パスを指定 (または '' として指定) しないでください。 たとえば、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
リソースの名前。
オプション パラメーター。
戻り値
listForResourceGroup(string, PolicyExemptionsListForResourceGroupOptionalParams)
この操作では、指定したサブスクリプション内の特定のリソース グループに関連付けられている、オプションの$filterと一致するすべてのポリシー除外の一覧が取得されます。 $filterの有効な値は、'atScope()'、'atExactScope()'、'excludeExpired()' または 'policyAssignmentId eq '{value}' です。 $filter指定されていない場合、フィルター処理されていない一覧には、リソース グループに関連付けられているすべてのポリシー除外が含まれます。これには、直接適用されるポリシーや、スコープを含む対象から適用されるもの、およびリソース グループ内に含まれるリソースに適用されるものも含まれます。
function listForResourceGroup(resourceGroupName: string, options?: PolicyExemptionsListForResourceGroupOptionalParams): PagedAsyncIterableIterator<PolicyExemption, PolicyExemption[], PageSettings>パラメーター
- resourceGroupName
-
string
リソースを含むリソース グループの名前。
オプション パラメーター。
戻り値
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
ポリシー除外パッチ要求のパラメーター。
オプション パラメーター。
戻り値
Promise<PolicyExemption>
