PolicyAssignments interface

代表 PolicyAssignments 的介面。

方法

create(string, string, PolicyAssignment, PolicyAssignmentsCreateOptionalParams)

此作業會建立或更新具有指定範圍和名稱的原則指派。 原則指派會套用至其範圍內所包含的所有資源。 例如,當您在資源群組範圍指派原則時,該原則會套用至群組中的所有資源。

createById(string, PolicyAssignment, PolicyAssignmentsCreateByIdOptionalParams)

此作業會使用指定的識別碼建立或更新原則指派。 在範圍上所做的原則指派會套用至該範圍中包含的所有資源。 例如,當您將原則指派給套用至群組中所有資源的資源群組時。 原則指派識別碼的格式如下:'{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'。 有效的範圍包括:管理群組 (格式:'/providers/Microsoft.Management/managementGroups/{managementGroup}') , 訂用帳戶 (格式:'/subscriptions/{subscriptionId}') 、資源群組 (格式:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}',或資源 (格式:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'。

delete(string, string, PolicyAssignmentsDeleteOptionalParams)

此作業會刪除原則指派,並指定其名稱及其建立範圍。 原則指派的範圍是其識別碼在 '/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}' 之前的一部分。

deleteById(string, PolicyAssignmentsDeleteByIdOptionalParams)

此作業會刪除具有指定識別碼的原則。 原則指派識別碼的格式如下:'{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'。 {scope} 的有效格式為:'/providers/Microsoft.Management/managementGroups/{managementGroup}' (管理群組) ,'/subscriptions/{subscriptionId}' (訂閱) , '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' (資源群組) ,或 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}' (資源) 。

get(string, string, PolicyAssignmentsGetOptionalParams)

此作業會擷取單一原則指派,並指定其名稱及其建立所在的範圍。

getById(string, PolicyAssignmentsGetByIdOptionalParams)

作業會擷取具有指定識別碼的原則指派。 原則指派識別碼的格式如下:'{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'。 有效的範圍包括:管理群組 (格式:'/providers/Microsoft.Management/managementGroups/{managementGroup}') , 訂用帳戶 (格式:'/subscriptions/{subscriptionId}') 、資源群組 (格式:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}',或資源 (格式:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'。

list(PolicyAssignmentsListOptionalParams)

這項作業會擷取與指定訂用帳戶相關聯的所有原則指派清單,這些指派符合選擇性指定$filter。 $filter的有效值為:'atScope () '、'atExactScope () ' 或 'policyDefinitionId eq '{value}''。 如果未提供$filter,未篩選清單會包含與訂用帳戶相關聯的所有原則指派,包括直接套用或套用自包含指定訂用帳戶的管理群組,以及套用至包含在訂用帳戶內之物件的任何原則指派。 如果提供 $filter=atScope () ,則傳回的清單會包含套用至訂用帳戶的所有原則指派,這是未篩選清單中的所有內容,但套用至訂用帳戶內包含的物件除外。 如果提供 $filter=atExactScope () ,傳回的清單只會包含訂用帳戶上的所有原則指派。 如果提供 $filter=policyDefinitionId eq '{value}',傳回的清單會包含識別碼為 {value} 的原則定義的所有原則指派。

listForManagementGroup(string, PolicyAssignmentsListForManagementGroupOptionalParams)

這項作業會擷取適用于所有符合指定$filter之管理群組的原則指派清單。 $filter的有效值為:'atScope () '、'atExactScope () ' 或 'policyDefinitionId eq '{value}''。 如果提供 $filter=atScope () ,傳回的清單會包含指派給管理群組或管理群組上階的所有原則指派。 如果提供 $filter=atExactScope () ,傳回的清單只會包含管理群組中的所有原則指派。 如果提供 $filter=policyDefinitionId eq '{value}',傳回的清單會包含套用至管理群組的原則定義識別碼為 {value} 的所有原則指派。

listForResource(string, string, string, string, string, PolicyAssignmentsListForResourceOptionalParams)

此作業會擷取與指定資源群組和訂用帳戶中指定資源相關聯的所有原則指派清單,這些指派符合選擇性指定$filter。 $filter的有效值為:'atScope () '、'atExactScope () ' 或 'policyDefinitionId eq '{value}''。 如果未提供$filter,未篩選清單會包含與資源相關聯的所有原則指派,包括直接套用或套用自所有包含範圍的原則指派,以及套用至資源內含資源內含的任何原則指派。 如果提供 $filter=atScope () ,則傳回的清單會包含套用至資源的所有原則指派,這是未篩選清單中所有專案,但套用至資源內含資源的資源除外。 如果提供 $filter=atExactScope () ,傳回的清單只會包含資源層級的所有原則指派。 如果提供 $filter=policyDefinitionId eq '{value}',傳回的清單會包含套用至資源的原則定義識別碼為 {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') 。

listForResourceGroup(string, PolicyAssignmentsListForResourceGroupOptionalParams)

此作業會擷取指定訂用帳戶中與指定資源群組相關聯的所有原則指派清單,此清單符合選擇性的指定$filter。 $filter的有效值為:'atScope () '、'atExactScope () ' 或 'policyDefinitionId eq '{value}''。 如果未提供$filter,未篩選清單會包含與資源群組相關聯的所有原則指派,包括直接套用或套用自包含範圍的指派,以及套用至資源群組內所含資源的任何原則指派。 如果提供 $filter=atScope () ,則傳回的清單會包含套用至資源群組的所有原則指派,這是未篩選清單中所有專案,但套用至資源群組內所含資源以外的所有原則指派。 如果提供 $filter=atExactScope () ,傳回的清單只會包含資源群組的所有原則指派。 如果提供 $filter=policyDefinitionId eq '{value}',傳回的清單會包含套用至資源群組的原則定義識別碼為 {value} 的所有原則指派。

update(string, string, PolicyAssignmentUpdate, PolicyAssignmentsUpdateOptionalParams)

這項作業會以指定的範圍和名稱更新原則指派。 原則指派會套用至其範圍內所包含的所有資源。 例如,當您在資源群組範圍指派原則時,該原則會套用至群組中的所有資源。

updateById(string, PolicyAssignmentUpdate, PolicyAssignmentsUpdateByIdOptionalParams)

這項作業會以指定的識別碼更新原則指派。 在範圍上所做的原則指派會套用至該範圍中包含的所有資源。 例如,當您將原則指派給套用至群組中所有資源的資源群組時。 原則指派識別碼的格式如下:'{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'。 有效的範圍包括:管理群組 (格式:'/providers/Microsoft.Management/managementGroups/{managementGroup}') , 訂用帳戶 (格式:'/subscriptions/{subscriptionId}') 、資源群組 (格式:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}',或資源 (格式:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'。

方法詳細資料

create(string, string, PolicyAssignment, PolicyAssignmentsCreateOptionalParams)

此作業會建立或更新具有指定範圍和名稱的原則指派。 原則指派會套用至其範圍內所包含的所有資源。 例如,當您在資源群組範圍指派原則時,該原則會套用至群組中的所有資源。

function create(scope: string, policyAssignmentName: string, parameters: PolicyAssignment, options?: PolicyAssignmentsCreateOptionalParams): Promise<PolicyAssignment>

參數

scope

string

原則指派的範圍。 有效的範圍包括:管理群組 (格式:'/providers/Microsoft.Management/managementGroups/{managementGroup}') , 訂閱 (格式:'/subscriptions/{subscriptionId}') 、資源群組 (格式:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}',或資源 (格式:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'

policyAssignmentName

string

原則指派的名稱。

parameters
PolicyAssignment

原則指派的參數。

options
PolicyAssignmentsCreateOptionalParams

選項參數。

傳回

Promise<PolicyAssignment>

createById(string, PolicyAssignment, PolicyAssignmentsCreateByIdOptionalParams)

此作業會使用指定的識別碼建立或更新原則指派。 在範圍上所做的原則指派會套用至該範圍中包含的所有資源。 例如,當您將原則指派給套用至群組中所有資源的資源群組時。 原則指派識別碼的格式如下:'{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'。 有效的範圍包括:管理群組 (格式:'/providers/Microsoft.Management/managementGroups/{managementGroup}') , 訂用帳戶 (格式:'/subscriptions/{subscriptionId}') 、資源群組 (格式:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}',或資源 (格式:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'。

function createById(policyAssignmentId: string, parameters: PolicyAssignment, options?: PolicyAssignmentsCreateByIdOptionalParams): Promise<PolicyAssignment>

參數

policyAssignmentId

string

要建立的原則指派識別碼。 使用格式 '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'。

parameters
PolicyAssignment

原則指派的參數。

傳回

Promise<PolicyAssignment>

delete(string, string, PolicyAssignmentsDeleteOptionalParams)

此作業會刪除原則指派,並指定其名稱及其建立範圍。 原則指派的範圍是其識別碼在 '/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}' 之前的一部分。

function delete(scope: string, policyAssignmentName: string, options?: PolicyAssignmentsDeleteOptionalParams): Promise<PolicyAssignment>

參數

scope

string

原則指派的範圍。 有效的範圍包括:管理群組 (格式:'/providers/Microsoft.Management/managementGroups/{managementGroup}') , 訂閱 (格式:'/subscriptions/{subscriptionId}') 、資源群組 (格式:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}',或資源 (格式:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'

policyAssignmentName

string

要刪除的原則指派名稱。

options
PolicyAssignmentsDeleteOptionalParams

選項參數。

傳回

Promise<PolicyAssignment>

deleteById(string, PolicyAssignmentsDeleteByIdOptionalParams)

此作業會刪除具有指定識別碼的原則。 原則指派識別碼的格式如下:'{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'。 {scope} 的有效格式為:'/providers/Microsoft.Management/managementGroups/{managementGroup}' (管理群組) ,'/subscriptions/{subscriptionId}' (訂閱) , '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' (資源群組) ,或 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}' (資源) 。

function deleteById(policyAssignmentId: string, options?: PolicyAssignmentsDeleteByIdOptionalParams): Promise<PolicyAssignment>

參數

policyAssignmentId

string

要刪除的原則指派識別碼。 使用格式 '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'。

傳回

Promise<PolicyAssignment>

get(string, string, PolicyAssignmentsGetOptionalParams)

此作業會擷取單一原則指派,並指定其名稱及其建立所在的範圍。

function get(scope: string, policyAssignmentName: string, options?: PolicyAssignmentsGetOptionalParams): Promise<PolicyAssignment>

參數

scope

string

原則指派的範圍。 有效的範圍包括:管理群組 (格式:'/providers/Microsoft.Management/managementGroups/{managementGroup}') , 訂閱 (格式:'/subscriptions/{subscriptionId}') 、資源群組 (格式:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}',或資源 (格式:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'

policyAssignmentName

string

要取得的原則指派名稱。

options
PolicyAssignmentsGetOptionalParams

選項參數。

傳回

Promise<PolicyAssignment>

getById(string, PolicyAssignmentsGetByIdOptionalParams)

作業會擷取具有指定識別碼的原則指派。 原則指派識別碼的格式如下:'{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'。 有效的範圍包括:管理群組 (格式:'/providers/Microsoft.Management/managementGroups/{managementGroup}') , 訂用帳戶 (格式:'/subscriptions/{subscriptionId}') 、資源群組 (格式:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}',或資源 (格式:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'。

function getById(policyAssignmentId: string, options?: PolicyAssignmentsGetByIdOptionalParams): Promise<PolicyAssignment>

參數

policyAssignmentId

string

要取得的原則指派識別碼。 使用格式 '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'。

options
PolicyAssignmentsGetByIdOptionalParams

選項參數。

傳回

Promise<PolicyAssignment>

list(PolicyAssignmentsListOptionalParams)

這項作業會擷取與指定訂用帳戶相關聯的所有原則指派清單,這些指派符合選擇性指定$filter。 $filter的有效值為:'atScope () '、'atExactScope () ' 或 'policyDefinitionId eq '{value}''。 如果未提供$filter,未篩選清單會包含與訂用帳戶相關聯的所有原則指派,包括直接套用或套用自包含指定訂用帳戶的管理群組,以及套用至包含在訂用帳戶內之物件的任何原則指派。 如果提供 $filter=atScope () ,則傳回的清單會包含套用至訂用帳戶的所有原則指派,這是未篩選清單中的所有內容,但套用至訂用帳戶內包含的物件除外。 如果提供 $filter=atExactScope () ,傳回的清單只會包含訂用帳戶上的所有原則指派。 如果提供 $filter=policyDefinitionId eq '{value}',傳回的清單會包含識別碼為 {value} 的原則定義的所有原則指派。

function list(options?: PolicyAssignmentsListOptionalParams): PagedAsyncIterableIterator<PolicyAssignment, PolicyAssignment[], PageSettings>

參數

options
PolicyAssignmentsListOptionalParams

選項參數。

傳回

listForManagementGroup(string, PolicyAssignmentsListForManagementGroupOptionalParams)

這項作業會擷取適用于所有符合指定$filter之管理群組的原則指派清單。 $filter的有效值為:'atScope () '、'atExactScope () ' 或 'policyDefinitionId eq '{value}''。 如果提供 $filter=atScope () ,傳回的清單會包含指派給管理群組或管理群組上階的所有原則指派。 如果提供 $filter=atExactScope () ,傳回的清單只會包含管理群組中的所有原則指派。 如果提供 $filter=policyDefinitionId eq '{value}',傳回的清單會包含套用至管理群組的原則定義識別碼為 {value} 的所有原則指派。

function listForManagementGroup(managementGroupId: string, options?: PolicyAssignmentsListForManagementGroupOptionalParams): PagedAsyncIterableIterator<PolicyAssignment, PolicyAssignment[], PageSettings>

參數

managementGroupId

string

管理群組的識別碼。

傳回

listForResource(string, string, string, string, string, PolicyAssignmentsListForResourceOptionalParams)

此作業會擷取與指定資源群組和訂用帳戶中指定資源相關聯的所有原則指派清單,這些指派符合選擇性指定$filter。 $filter的有效值為:'atScope () '、'atExactScope () ' 或 'policyDefinitionId eq '{value}''。 如果未提供$filter,未篩選清單會包含與資源相關聯的所有原則指派,包括直接套用或套用自所有包含範圍的原則指派,以及套用至資源內含資源內含的任何原則指派。 如果提供 $filter=atScope () ,則傳回的清單會包含套用至資源的所有原則指派,這是未篩選清單中所有專案,但套用至資源內含資源的資源除外。 如果提供 $filter=atExactScope () ,傳回的清單只會包含資源層級的所有原則指派。 如果提供 $filter=policyDefinitionId eq '{value}',傳回的清單會包含套用至資源的原則定義識別碼為 {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') 。

function listForResource(resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, options?: PolicyAssignmentsListForResourceOptionalParams): PagedAsyncIterableIterator<PolicyAssignment, PolicyAssignment[], PageSettings>

參數

resourceGroupName

string

包含資源的資源組名。

resourceProviderNamespace

string

資源提供者的命名空間。 例如,虛擬機器的命名空間是 Microsoft.Compute/virtualMachines) 的 Microsoft.Compute (

parentResourcePath

string

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

resourceType

string

資源類型名稱。 例如,Web 應用程式的類型名稱是從 Microsoft.Web/sites) (的'sites'。

resourceName

string

資源名稱。

傳回

listForResourceGroup(string, PolicyAssignmentsListForResourceGroupOptionalParams)

此作業會擷取指定訂用帳戶中與指定資源群組相關聯的所有原則指派清單,此清單符合選擇性的指定$filter。 $filter的有效值為:'atScope () '、'atExactScope () ' 或 'policyDefinitionId eq '{value}''。 如果未提供$filter,未篩選清單會包含與資源群組相關聯的所有原則指派,包括直接套用或套用自包含範圍的指派,以及套用至資源群組內所含資源的任何原則指派。 如果提供 $filter=atScope () ,則傳回的清單會包含套用至資源群組的所有原則指派,這是未篩選清單中所有專案,但套用至資源群組內所含資源以外的所有原則指派。 如果提供 $filter=atExactScope () ,傳回的清單只會包含資源群組的所有原則指派。 如果提供 $filter=policyDefinitionId eq '{value}',傳回的清單會包含套用至資源群組的原則定義識別碼為 {value} 的所有原則指派。

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

參數

resourceGroupName

string

包含原則指派的資源組名。

傳回

update(string, string, PolicyAssignmentUpdate, PolicyAssignmentsUpdateOptionalParams)

這項作業會以指定的範圍和名稱更新原則指派。 原則指派會套用至其範圍內所包含的所有資源。 例如,當您在資源群組範圍指派原則時,該原則會套用至群組中的所有資源。

function update(scope: string, policyAssignmentName: string, parameters: PolicyAssignmentUpdate, options?: PolicyAssignmentsUpdateOptionalParams): Promise<PolicyAssignment>

參數

scope

string

原則指派的範圍。 有效的範圍包括:管理群組 (格式:'/providers/Microsoft.Management/managementGroups/{managementGroup}') , 訂閱 (格式:'/subscriptions/{subscriptionId}') 、資源群組 (格式:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}',或資源 (格式:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'

policyAssignmentName

string

原則指派的名稱。

parameters
PolicyAssignmentUpdate

原則指派修補程式要求的參數。

options
PolicyAssignmentsUpdateOptionalParams

選項參數。

傳回

Promise<PolicyAssignment>

updateById(string, PolicyAssignmentUpdate, PolicyAssignmentsUpdateByIdOptionalParams)

這項作業會以指定的識別碼更新原則指派。 在範圍上所做的原則指派會套用至該範圍中包含的所有資源。 例如,當您將原則指派給套用至群組中所有資源的資源群組時。 原則指派識別碼的格式如下:'{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'。 有效的範圍包括:管理群組 (格式:'/providers/Microsoft.Management/managementGroups/{managementGroup}') , 訂用帳戶 (格式:'/subscriptions/{subscriptionId}') 、資源群組 (格式:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}',或資源 (格式:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'。

function updateById(policyAssignmentId: string, parameters: PolicyAssignmentUpdate, options?: PolicyAssignmentsUpdateByIdOptionalParams): Promise<PolicyAssignment>

參數

policyAssignmentId

string

要更新的原則指派識別碼。 使用格式 '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'。

parameters
PolicyAssignmentUpdate

原則指派修補程式要求的參數。

傳回

Promise<PolicyAssignment>