PolicyAssignmentsOperations interface
PolicyAssignments操作を表すインターフェース。
プロパティ
| create | この操作は、指定されたスコープと名前でポリシー割り当てを作成または更新します。 ポリシーの割り当ては、スコープ内に含まれるすべてのリソースに適用されます。 たとえば、リソース グループ スコープでポリシーを割り当てると、そのポリシーはグループ内のすべてのリソースに適用されます。 |
| delete | |
| get | この操作は、その名前と作成されたスコープを与えた単一のポリシー割り当てを取得します。 |
| list | この操作は、任意の$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}であるすべてのポリシー割り当てが含まれます。 特定のリソースを識別するには、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()』、または『policyDefinitionId eq 『{value}』です。 $filterが提供されていない場合、フィルターされていないリストにはリソースグループに関連付けられたすべてのポリシー割り当てが含まれ、直接適用されるものや含むスコープから適用されるもの、さらにリソースグループ内に適用されるリソースに適用されるものも含まれます。 $filter=atScope()が提供されている場合、返されるリストにはリソースグループに適用されるすべてのポリシー割り当てが含まれ、リソースグループ内のリソースに適用されるポリシー割り当てを除く、フィルターされていないリストのすべてが含まれます。 $filter=atExactScope()が提供されている場合、返されるリストにはリソースグループにあるすべてのポリシー割り当てのみが含まれます。 $filter=policyDefinitionId eq '{value}'が提供されている場合、返されるリストにはリソースグループに適用されるポリシー定義の{value} IDを持つすべてのポリシー割り当てが含まれます。 |
| update | この操作により、指定されたスコープと名前でポリシーの割り当てが更新されます。 ポリシーの割り当ては、スコープ内に含まれるすべてのリソースに適用されます。 たとえば、リソース グループ スコープでポリシーを割り当てると、そのポリシーはグループ内のすべてのリソースに適用されます。 |
プロパティの詳細
create
この操作は、指定されたスコープと名前でポリシー割り当てを作成または更新します。 ポリシーの割り当ては、スコープ内に含まれるすべてのリソースに適用されます。 たとえば、リソース グループ スコープでポリシーを割り当てると、そのポリシーはグループ内のすべてのリソースに適用されます。
create: (scope: string, policyAssignmentName: string, parameters: PolicyAssignment, options?: PolicyAssignmentsCreateOptionalParams) => Promise<PolicyAssignment>
プロパティ値
(scope: string, policyAssignmentName: string, parameters: PolicyAssignment, options?: PolicyAssignmentsCreateOptionalParams) => Promise<PolicyAssignment>
delete
delete: (scope: string, policyAssignmentName: string, options?: PolicyAssignmentsDeleteOptionalParams) => Promise<PolicyAssignment>
プロパティ値
(scope: string, policyAssignmentName: string, options?: PolicyAssignmentsDeleteOptionalParams) => Promise<PolicyAssignment>
get
この操作は、その名前と作成されたスコープを与えた単一のポリシー割り当てを取得します。
get: (scope: string, policyAssignmentName: string, options?: PolicyAssignmentsGetOptionalParams) => Promise<PolicyAssignment>
プロパティ値
(scope: string, policyAssignmentName: string, options?: PolicyAssignmentsGetOptionalParams) => Promise<PolicyAssignment>
list
この操作は、任意の$filterに一致するサブスクリプションに関連するすべてのポリシー割り当てのリストを取得します。 有効な$filter値は、『atScope()』、『atExactScope()』、または『policyDefinitionId eq 『{value}』です。 $filterが提供されていない場合、フィルターなしのリストにはサブスクリプションに関連するすべてのポリシー割り当てが含まれ、直接適用されるものや、そのサブスクリプションを含む管理グループからのもの、さらにサブスクリプション内のオブジェクトに適用されるものも含まれます。 $filter=atScope()が提供されている場合、返されるリストにはサブスクリプションに適用されるすべてのポリシー割り当てが含まれ、これはサブスクリプション内のオブジェクトに適用されるポリシーを除く非フィルターリストのすべてです。 $filter=atExactScope()が提供されている場合、返送されるリストにはサブスクリプションにあるすべてのポリシー割り当てのみが含まれます。 $filter=policyDefinitionId eq '{value}'が提供されている場合、返されるリストには id が {value} のポリシー定義のすべてのポリシー割り当てが含まれます。
list: (options?: PolicyAssignmentsListOptionalParams) => PagedAsyncIterableIterator<PolicyAssignment, PolicyAssignment[], PageSettings>
プロパティ値
(options?: PolicyAssignmentsListOptionalParams) => PagedAsyncIterableIterator<PolicyAssignment, PolicyAssignment[], PageSettings>
listForManagementGroup
この操作は、管理グループに適用されるすべてのポリシー割り当てのリストを取得し、与えられた$filterに一致します。 有効な$filter値は、『atScope()』、『atExactScope()』、または『policyDefinitionId eq 『{value}』です。 $filter=atScope()が提供されている場合、返されるリストには管理グループまたは管理グループの祖先に割り当てられたすべてのポリシー割り当てが含まれます。 $filter=atExactScope()が提供されている場合、返されるリストには管理グループにあるすべてのポリシー割り当てのみが含まれます。 $filter=policyDefinitionId eq '{value}'が提供されている場合、返されるリストには管理グループに適用されるポリシー定義のidが{value}であるすべてのポリシー割り当てが含まれます。
listForManagementGroup: (managementGroupId: string, options?: PolicyAssignmentsListForManagementGroupOptionalParams) => PagedAsyncIterableIterator<PolicyAssignment, PolicyAssignment[], PageSettings>
プロパティ値
(managementGroupId: string, options?: PolicyAssignmentsListForManagementGroupOptionalParams) => PagedAsyncIterableIterator<PolicyAssignment, PolicyAssignment[], PageSettings>
listForResource
この操作は、指定されたリソースグループおよびサブスクリプションに関連するすべてのポリシー割り当てのリストを取得し、オプションの$filterに一致します。 有効な$filter値は、『atScope()』、『atExactScope()』、または『policyDefinitionId eq 『{value}』です。 $filterが提供されていない場合、フィルターなしのリストにはリソースに関連するすべてのポリシー割り当てが含まれており、直接適用されるものやすべての含むスコープから適用されるもの、さらにリソース内に適用されるリソースに適用されるものも含まれます。 $filter=atScope()が提供されている場合、返されるリストにはリソースに適用されるすべてのポリシー割り当てが含まれ、これはリソース内に適用されるリソースに適用されるポリシーを除く、フィルターされていないリスト内のすべてのものを指します。 $filter=atExactScope()が提供されている場合、返されるリストにはリソースレベルでのすべてのポリシー割り当てのみが含まれます。 $filter=policyDefinitionId eq '{value}'が提供されている場合、返されるリストにはリソースに適用されるポリシー定義のidが{value}であるすべてのポリシー割り当てが含まれます。 特定のリソースを識別するには、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') の両方を指定することをお勧めします。
listForResource: (resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, options?: PolicyAssignmentsListForResourceOptionalParams) => PagedAsyncIterableIterator<PolicyAssignment, PolicyAssignment[], PageSettings>
プロパティ値
(resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, options?: PolicyAssignmentsListForResourceOptionalParams) => PagedAsyncIterableIterator<PolicyAssignment, PolicyAssignment[], PageSettings>
listForResourceGroup
この操作は、特定のサブスクリプション内のリソースグループに関連付けられ、任意の$filterに一致するすべてのポリシー割り当てのリストを取得します。 有効な$filter値は、『atScope()』、『atExactScope()』、または『policyDefinitionId eq 『{value}』です。 $filterが提供されていない場合、フィルターされていないリストにはリソースグループに関連付けられたすべてのポリシー割り当てが含まれ、直接適用されるものや含むスコープから適用されるもの、さらにリソースグループ内に適用されるリソースに適用されるものも含まれます。 $filter=atScope()が提供されている場合、返されるリストにはリソースグループに適用されるすべてのポリシー割り当てが含まれ、リソースグループ内のリソースに適用されるポリシー割り当てを除く、フィルターされていないリストのすべてが含まれます。 $filter=atExactScope()が提供されている場合、返されるリストにはリソースグループにあるすべてのポリシー割り当てのみが含まれます。 $filter=policyDefinitionId eq '{value}'が提供されている場合、返されるリストにはリソースグループに適用されるポリシー定義の{value} IDを持つすべてのポリシー割り当てが含まれます。
listForResourceGroup: (resourceGroupName: string, options?: PolicyAssignmentsListForResourceGroupOptionalParams) => PagedAsyncIterableIterator<PolicyAssignment, PolicyAssignment[], PageSettings>
プロパティ値
(resourceGroupName: string, options?: PolicyAssignmentsListForResourceGroupOptionalParams) => PagedAsyncIterableIterator<PolicyAssignment, PolicyAssignment[], PageSettings>
update
この操作により、指定されたスコープと名前でポリシーの割り当てが更新されます。 ポリシーの割り当ては、スコープ内に含まれるすべてのリソースに適用されます。 たとえば、リソース グループ スコープでポリシーを割り当てると、そのポリシーはグループ内のすべてのリソースに適用されます。
update: (scope: string, policyAssignmentName: string, parameters: PolicyAssignmentUpdate, options?: PolicyAssignmentsUpdateOptionalParams) => Promise<PolicyAssignment>
プロパティ値
(scope: string, policyAssignmentName: string, parameters: PolicyAssignmentUpdate, options?: PolicyAssignmentsUpdateOptionalParams) => Promise<PolicyAssignment>