你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

RoleAssignments interface

表示 RoleAssignments 的接口。

方法

create(string, string, RoleAssignmentCreateParameters, RoleAssignmentsCreateOptionalParams)

创建角色分配。

createById(string, RoleAssignmentCreateParameters, RoleAssignmentsCreateByIdOptionalParams)

按 ID 创建角色分配。

delete(string, string, RoleAssignmentsDeleteOptionalParams)

删除角色分配。

deleteById(string, RoleAssignmentsDeleteByIdOptionalParams)

删除角色分配。

get(string, string, RoleAssignmentsGetOptionalParams)

获取指定的角色分配。

getById(string, RoleAssignmentsGetByIdOptionalParams)

按 ID 获取角色分配。

list(RoleAssignmentsListOptionalParams)

获取订阅的所有角色分配。

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

获取资源的角色分配。

listForResourceGroup(string, RoleAssignmentsListForResourceGroupOptionalParams)

获取资源组的角色分配。

listForScope(string, RoleAssignmentsListForScopeOptionalParams)

获取范围的角色分配。

方法详细信息

create(string, string, RoleAssignmentCreateParameters, RoleAssignmentsCreateOptionalParams)

创建角色分配。

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

参数

scope

string

要创建的角色分配的范围。 范围可以是任何 REST 资源实例。 例如,对资源组使用“/subscriptions/{subscription-id}/”、“/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}”和“/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider}/{resource-type}/{resource-name}”。

roleAssignmentName

string

要创建的角色分配的 GUID。 每个角色分配的名称必须唯一且不同。

parameters
RoleAssignmentCreateParameters

角色分配的参数。

options
RoleAssignmentsCreateOptionalParams

选项参数。

返回

Promise<RoleAssignment>

createById(string, RoleAssignmentCreateParameters, RoleAssignmentsCreateByIdOptionalParams)

按 ID 创建角色分配。

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

参数

roleAssignmentId

string

角色分配的完全限定 ID,包括范围、资源名称和资源类型。 使用格式 /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}。 示例:/subscriptions/{subId}/resourcegroups/{rgname}//providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}。

parameters
RoleAssignmentCreateParameters

角色分配的参数。

options
RoleAssignmentsCreateByIdOptionalParams

选项参数。

返回

Promise<RoleAssignment>

delete(string, string, RoleAssignmentsDeleteOptionalParams)

删除角色分配。

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

参数

scope

string

要删除的角色分配的范围。

roleAssignmentName

string

要删除的角色分配的名称。

options
RoleAssignmentsDeleteOptionalParams

选项参数。

返回

Promise<RoleAssignment>

deleteById(string, RoleAssignmentsDeleteByIdOptionalParams)

删除角色分配。

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

参数

roleAssignmentId

string

角色分配的完全限定 ID,包括范围、资源名称和资源类型。 使用格式 /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}。 示例:/subscriptions/{subId}/resourcegroups/{rgname}//providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}。

options
RoleAssignmentsDeleteByIdOptionalParams

选项参数。

返回

Promise<RoleAssignment>

get(string, string, RoleAssignmentsGetOptionalParams)

获取指定的角色分配。

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

参数

scope

string

角色分配的范围。

roleAssignmentName

string

要获取的角色分配的名称。

options
RoleAssignmentsGetOptionalParams

选项参数。

返回

Promise<RoleAssignment>

getById(string, RoleAssignmentsGetByIdOptionalParams)

按 ID 获取角色分配。

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

参数

roleAssignmentId

string

角色分配的完全限定 ID,包括范围、资源名称和资源类型。 使用格式 /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}。 示例:/subscriptions/{subId}/resourcegroups/{rgname}//providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}。

options
RoleAssignmentsGetByIdOptionalParams

选项参数。

返回

Promise<RoleAssignment>

list(RoleAssignmentsListOptionalParams)

获取订阅的所有角色分配。

function list(options?: RoleAssignmentsListOptionalParams): PagedAsyncIterableIterator<RoleAssignment, RoleAssignment[], PageSettings>

参数

options
RoleAssignmentsListOptionalParams

选项参数。

返回

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

获取资源的角色分配。

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

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

resourceProviderNamespace

string

资源提供程序的命名空间。

parentResourcePath

string

父资源标识。

resourceType

string

资源的资源类型。

resourceName

string

要为其获取角色分配的资源的名称。

返回

listForResourceGroup(string, RoleAssignmentsListForResourceGroupOptionalParams)

获取资源组的角色分配。

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

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

返回

listForScope(string, RoleAssignmentsListForScopeOptionalParams)

获取范围的角色分配。

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

参数

scope

string

角色分配的范围。

返回