PolicyAssignments interface
代表 PolicyAssignments 的介面。
方法
| create(string, string, Policy |
此作業會建立或更新具有指定範圍和名稱的原則指派。 原則指派會套用至其範圍內所包含的所有資源。 例如，當您在資源群組範圍指派原則時，該原則會套用至群組中的所有資源。 |
| create |
此作業會建立或更新具有指定標識符的原則指派。 在範圍上所做的原則指派會套用至該範圍中包含的所有資源。 例如，當您將原則指派給資源群組時，該原則會套用至群組中的所有資源。 原則指派標識符的格式如下：『{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, Policy |
此作業會刪除原則指派，並指定其名稱及其建立範圍。 原則指派的範圍是其標識符前面 '/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}' 的一部分。 |
| delete |
此作業會刪除具有指定標識符的原則。 原則指派標識符的格式如下：『{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}』。 {scope} 的有效格式包括：'/providers/Microsoft.Management/managementGroups/{managementGroup}' （管理群組）、'/subscriptions/{subscriptionId}' （subscription）、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName }' （資源群組），或 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}' （resource）。 |
| get(string, string, Policy |
此作業會擷取單一原則指派，並指定其名稱及其建立範圍。 |
| get |
作業會擷取具有指定標識符的原則指派。 原則指派標識符的格式如下：『{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(Policy |
此作業會擷取與指定訂用帳戶相關聯的所有原則指派清單，這些指派符合選擇性指定$filter。 $filter的有效值為：'atScope（）'、'atExactScope（）' 或 'policyDefinitionId eq '{value}''。 如果未提供$filter，未篩選的清單會包含與訂用帳戶相關聯的所有原則指派，包括直接套用或從包含指定訂用帳戶的管理群組，以及套用至訂用帳戶內包含之物件的任何原則指派。 如果提供 $filter=atScope（） ，則傳回的清單會包含套用至訂用帳戶的所有原則指派，這是未篩選清單中的所有專案，但套用至訂用帳戶中包含的物件除外。 如果提供 $filter=atExactScope（） ，傳回的清單只會包含訂用帳戶上的所有原則指派。 如果提供 $filter=policyDefinitionId eq '{value}'，則傳回的清單會包含標識符為 {value} 的原則定義的所有原則指派。 |
| list |
此作業會擷取所有適用於符合指定$filter之管理群組的原則指派清單。 $filter的有效值為：'atScope（）'、'atExactScope（）' 或 'policyDefinitionId eq '{value}''。 如果提供 $filter=atScope（） ，傳回的清單會包含指派給管理群組或管理群組上階的所有原則指派。 如果提供 $filter=atExactScope（） ，傳回的清單只會包含管理群組的所有原則指派。 如果提供 $filter=policyDefinitionId eq '{value}'，傳回的列表會包含套用至管理群組之標識符為 {value} 的原則定義的所有原則指派。 |
| list |
此作業會擷取與指定資源群組和訂用帳戶中指定資源相關聯的所有原則指派清單，這些指派符合選擇性指定$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'）。 |
| list |
此作業會擷取指定訂用帳戶中與指定資源群組相關聯的所有原則指派清單，該群組符合選擇性指定$filter。 $filter的有效值為：'atScope（）'、'atExactScope（）' 或 'policyDefinitionId eq '{value}''。 如果未提供$filter，未篩選的清單會包含與資源群組相關聯的所有原則指派，包括直接套用或套用自包含範圍的原則指派，以及套用至資源群組內所含資源的任何指派。 如果提供 $filter=atScope（） ，則傳回的清單會包含套用至資源群組的所有原則指派，這是未篩選清單中的所有專案，但套用至資源群組中包含的資源除外。 如果提供 $filter=atExactScope（） ，則傳回的清單只會包含資源群組的所有原則指派。 如果提供 $filter=policyDefinitionId eq '{value}'，傳回的列表會包含套用至資源群組之標識符為 {value} 的原則定義的所有原則指派。 |
| update(string, string, Policy |
此作業會以指定的範圍和名稱更新原則指派。 原則指派會套用至其範圍內所包含的所有資源。 例如，當您在資源群組範圍指派原則時，該原則會套用至群組中的所有資源。 |
| update |
此作業會使用指定的標識碼來更新原則指派。 在範圍上所做的原則指派會套用至該範圍中包含的所有資源。 例如，當您將原則指派給資源群組時，該原則會套用至群組中的所有資源。 原則指派標識符的格式如下：『{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
原則指派的參數。
選項參數。
傳回
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
要刪除的原則指派名稱。
選項參數。
傳回
Promise<PolicyAssignment>
deleteById(string, PolicyAssignmentsDeleteByIdOptionalParams)
此作業會刪除具有指定標識符的原則。 原則指派標識符的格式如下：『{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}』。 {scope} 的有效格式包括：'/providers/Microsoft.Management/managementGroups/{managementGroup}' （管理群組）、'/subscriptions/{subscriptionId}' （subscription）、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName }' （資源群組），或 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}' （resource）。
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
要取得的原則指派名稱。
選項參數。
傳回
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}'。
選項參數。
傳回
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>參數
選項參數。
傳回
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 （從 Microsoft.Compute/virtualMachines）
- parentResourcePath
-
string
父資源路徑。 如果沒有，請使用空字串。
- resourceType
-
string
資源類型名稱。 例如，Web 應用程式的類型名稱是 'sites' （從 Microsoft.Web/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
原則指派修補程式要求的參數。
選項參數。
傳回
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>