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} 且適用於該資源的政策指派。 三個參數加上資源名稱可用來識別特定資源。 如果資源不是父資源的一部分(較常見的情況),則不應該提供父資源路徑(或提供為 '')。 例如,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}',回傳清單包含所有政策定義中 id 為 {value} 且適用於資源群組的政策指派。 |
| 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} 且適用於該資源的政策指派。 三個參數加上資源名稱可用來識別特定資源。 如果資源不是父資源的一部分(較常見的情況),則不應該提供父資源路徑(或提供為 '')。 例如,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}',回傳清單包含所有政策定義中 id 為 {value} 且適用於資源群組的政策指派。
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>