RoleAssignments interface

套件:

@azure/arm-authorization

代表 RoleAssignments 的介面。

方法

create(string, string, RoleAssignmentCreateParameters, RoleAssignmentsCreateOptionalParams)	依範圍和名稱建立或更新角色指派。
createById(string, RoleAssignmentCreateParameters, RoleAssignmentsCreateByIdOptionalParams)	依識別碼建立或更新角色指派。
delete(string, string, RoleAssignmentsDeleteOptionalParams)	依範圍和名稱刪除角色指派。
deleteById(string, RoleAssignmentsDeleteByIdOptionalParams)	依識別碼刪除角色指派。
get(string, string, RoleAssignmentsGetOptionalParams)	依範圍和名稱取得角色指派。
getById(string, RoleAssignmentsGetByIdOptionalParams)	依識別碼取得角色指派。
listForResource(string, string, string, string, RoleAssignmentsListForResourceOptionalParams)	列出套用至資源的所有角色指派。
listForResourceGroup(string, RoleAssignmentsListForResourceGroupOptionalParams)	列出套用至資源群組的所有角色指派。
listForScope(string, RoleAssignmentsListForScopeOptionalParams)	列出套用至範圍的所有角色指派。
listForSubscription(RoleAssignmentsListForSubscriptionOptionalParams)	列出套用至訂用帳戶的所有角色指派。

方法詳細資料

create(string, string, RoleAssignmentCreateParameters, RoleAssignmentsCreateOptionalParams)

依範圍和名稱建立或更新角色指派。

function create(scope: string, roleAssignmentName: string, parameters: RoleAssignmentCreateParameters, options?: RoleAssignmentsCreateOptionalParams): Promise<RoleAssignment>

參數

scope

string

作業或資源的範圍。 有效範圍包括：訂用帳戶 (格式：'/subscriptions/{subscriptionId}') ， 資源群組 (格式：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'或資源 (格式：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'

roleAssignmentName

string

角色指派的名稱。 它可以是任何有效的 GUID。

parameters

RoleAssignmentCreateParameters

角色指派的參數。

options

RoleAssignmentsCreateOptionalParams

選項參數。

傳回

Promise<RoleAssignment>

createById(string, RoleAssignmentCreateParameters, RoleAssignmentsCreateByIdOptionalParams)

依識別碼建立或更新角色指派。

function createById(roleAssignmentId: string, parameters: RoleAssignmentCreateParameters, options?: RoleAssignmentsCreateByIdOptionalParams): Promise<RoleAssignment>

參數

roleAssignmentId

string

角色指派的完整識別碼，包括範圍、資源名稱和資源類型。 格式：/{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}。 範例：/subscriptions/ < SUB_ID > /resourcegroups/ < RESOURCE_GROUP > /providers/Microsoft.Authorization/roleAssignments/ < ROLE_ASSIGNMENT_NAME>

parameters

RoleAssignmentCreateParameters

角色指派的參數。

options

RoleAssignmentsCreateByIdOptionalParams

選項參數。

傳回

Promise<RoleAssignment>

delete(string, string, RoleAssignmentsDeleteOptionalParams)

依範圍和名稱刪除角色指派。

function delete(scope: string, roleAssignmentName: string, options?: RoleAssignmentsDeleteOptionalParams): Promise<RoleAssignment>

參數

scope

string

作業或資源的範圍。 有效範圍包括：訂用帳戶 (格式：'/subscriptions/{subscriptionId}') ， 資源群組 (格式：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'或資源 (格式：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'

roleAssignmentName

string

角色指派的名稱。 它可以是任何有效的 GUID。

options

RoleAssignmentsDeleteOptionalParams

選項參數。

傳回

Promise<RoleAssignment>

deleteById(string, RoleAssignmentsDeleteByIdOptionalParams)

依識別碼刪除角色指派。

function deleteById(roleAssignmentId: string, options?: RoleAssignmentsDeleteByIdOptionalParams): Promise<RoleAssignment>

參數

roleAssignmentId

string

角色指派的完整識別碼，包括範圍、資源名稱和資源類型。 格式：/{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}。 範例：/subscriptions/ < SUB_ID > /resourcegroups/ < RESOURCE_GROUP > /providers/Microsoft.Authorization/roleAssignments/ < ROLE_ASSIGNMENT_NAME>

options

RoleAssignmentsDeleteByIdOptionalParams

選項參數。

傳回

Promise<RoleAssignment>

get(string, string, RoleAssignmentsGetOptionalParams)

依範圍和名稱取得角色指派。

function get(scope: string, roleAssignmentName: string, options?: RoleAssignmentsGetOptionalParams): Promise<RoleAssignment>

參數

scope

string

作業或資源的範圍。 有效範圍包括：訂用帳戶 (格式：'/subscriptions/{subscriptionId}') ， 資源群組 (格式：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'或資源 (格式：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'

roleAssignmentName

string

角色指派的名稱。 它可以是任何有效的 GUID。

options

RoleAssignmentsGetOptionalParams

選項參數。

傳回

Promise<RoleAssignment>

getById(string, RoleAssignmentsGetByIdOptionalParams)

依識別碼取得角色指派。

function getById(roleAssignmentId: string, options?: RoleAssignmentsGetByIdOptionalParams): Promise<RoleAssignment>

參數

roleAssignmentId

string

角色指派的完整識別碼，包括範圍、資源名稱和資源類型。 格式：/{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}。 範例：/subscriptions/ < SUB_ID > /resourcegroups/ < RESOURCE_GROUP > /providers/Microsoft.Authorization/roleAssignments/ < ROLE_ASSIGNMENT_NAME>

options

RoleAssignmentsGetByIdOptionalParams

選項參數。

傳回

Promise<RoleAssignment>

listForResource(string, string, string, string, RoleAssignmentsListForResourceOptionalParams)

列出套用至資源的所有角色指派。

function listForResource(resourceGroupName: string, resourceProviderNamespace: string, resourceType: string, resourceName: string, options?: RoleAssignmentsListForResourceOptionalParams): PagedAsyncIterableIterator<RoleAssignment, RoleAssignment[], PageSettings>

參數

resourceGroupName

string

資源群組的名稱。 名稱不區分大小寫。

resourceProviderNamespace

string

資源提供者的命名空間。

resourceType

string

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

resourceName

string

資源名稱。

options

RoleAssignmentsListForResourceOptionalParams

選項參數。

傳回

PagedAsyncIterableIterator<RoleAssignment, RoleAssignment[], PageSettings>

listForResourceGroup(string, RoleAssignmentsListForResourceGroupOptionalParams)

列出套用至資源群組的所有角色指派。

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

參數

resourceGroupName

string

資源群組的名稱。 名稱不區分大小寫。

options

RoleAssignmentsListForResourceGroupOptionalParams

選項參數。

傳回

PagedAsyncIterableIterator<RoleAssignment, RoleAssignment[], PageSettings>

listForScope(string, RoleAssignmentsListForScopeOptionalParams)

列出套用至範圍的所有角色指派。

function listForScope(scope: string, options?: RoleAssignmentsListForScopeOptionalParams): PagedAsyncIterableIterator<RoleAssignment, RoleAssignment[], PageSettings>

參數

scope

string

作業或資源的範圍。 有效範圍包括：訂用帳戶 (格式：'/subscriptions/{subscriptionId}') ， 資源群組 (格式：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'或資源 (格式：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'

options

RoleAssignmentsListForScopeOptionalParams

選項參數。

傳回

PagedAsyncIterableIterator<RoleAssignment, RoleAssignment[], PageSettings>

listForSubscription(RoleAssignmentsListForSubscriptionOptionalParams)

列出套用至訂用帳戶的所有角色指派。

function listForSubscription(options?: RoleAssignmentsListForSubscriptionOptionalParams): PagedAsyncIterableIterator<RoleAssignment, RoleAssignment[], PageSettings>

參數

options

RoleAssignmentsListForSubscriptionOptionalParams

選項參數。

傳回

PagedAsyncIterableIterator<RoleAssignment, RoleAssignment[], PageSettings>