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

New-AzSynapseRoleAssignment

创建 Synapse Analytics 角色分配。

语法

New-AzSynapseRoleAssignment
   -WorkspaceName <String>
   -RoleDefinitionName <String>
   -SignInName <String>
   [-ItemType <WorkspaceItemType>]
   [-Item <String>]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzSynapseRoleAssignment
   -WorkspaceName <String>
   -RoleDefinitionName <String>
   -ObjectId <String>
   [-ItemType <WorkspaceItemType>]
   [-Item <String>]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzSynapseRoleAssignment
   -WorkspaceName <String>
   -RoleDefinitionId <String>
   -ObjectId <String>
   [-ItemType <WorkspaceItemType>]
   [-Item <String>]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzSynapseRoleAssignment
   -WorkspaceName <String>
   -RoleDefinitionName <String>
   -ServicePrincipalName <String>
   [-ItemType <WorkspaceItemType>]
   [-Item <String>]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzSynapseRoleAssignment
   -WorkspaceObject <PSSynapseWorkspace>
   -RoleDefinitionName <String>
   -SignInName <String>
   [-ItemType <WorkspaceItemType>]
   [-Item <String>]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzSynapseRoleAssignment
   -WorkspaceObject <PSSynapseWorkspace>
   -RoleDefinitionName <String>
   -ObjectId <String>
   [-ItemType <WorkspaceItemType>]
   [-Item <String>]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzSynapseRoleAssignment
   -WorkspaceObject <PSSynapseWorkspace>
   -RoleDefinitionId <String>
   -ObjectId <String>
   [-ItemType <WorkspaceItemType>]
   [-Item <String>]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzSynapseRoleAssignment
   -WorkspaceObject <PSSynapseWorkspace>
   -RoleDefinitionName <String>
   -ServicePrincipalName <String>
   [-ItemType <WorkspaceItemType>]
   [-Item <String>]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

说明

New-AzSynapseRoleAssignment cmdlet 创建 Azure Synapse Analytics 角色分配。

cmdlet 可以根据输入参数调用以下Microsoft图形 API:

  • GET /users/{id}
  • GET /servicePrincipals/{id}

注意

若要为服务主体创建角色分配,请在 ObjectId 参数中传递主体的对象 ID。 如果你是有权在工作区上管理 Azure RBAC 角色分配但无权管理 Synapse 管理员的用户, 请直接通过 -RoleDefinitionId 和 -ObjectId 创建 Synapse 管理员角色,但不能由 -RoleDefinitionName 创建 Synapse Administrator 角色,RoleDefinitionId 为“000011111-aaaa-2222-bbbb-33333cccc44444”,请采用以下示例 5 作为参考。 原因是,当你尝试添加“Synapse Administrator”角色时,cmdlet 需要从需要工作区读取权限的角色名称(当前用户没有)获取角色 ID。

示例

示例 1

New-AzSynapseRoleAssignment -WorkspaceName ContosoWorkspace -RoleDefinitionName ContosoRole -SignInName ContosoName

此命令将 ContosoRole 分配给其主体名称为 ContosoName 的用户。

示例 2

New-AzSynapseRoleAssignment -WorkspaceName ContosoWorkspace -RoleDefinitionName ContosoRole -SignInName ContosoName -ItemType ContosoItemType -Item ContosoItem

此命令将 ContosoRole 分配给其主体名称为 ContosoName 且项类型为 ContosoItemType 的用户,项为 ContosoItem。

示例 3

New-AzSynapseRoleAssignment -WorkspaceName ContosoWorkspace -RoleDefinitionName ContosoRole -SignInName ContosoName -ItemType ContosoItemType -Item ContosoItem

此命令将 ContosoRole 分配给其主体名称为 ContosoName 且项类型为 ContosoItemType 的用户,项为 ContosoItem。

示例 4

$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | New-AzSynapseRoleAssignment -RoleDefinitionName ContosoRole -SignInName ContosoName

此命令将 ContosoRole 分配给其主体名称通过管道为 ContosoName 的用户。

示例 5

$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | New-AzSynapseRoleAssignment -RoleDefinitionId "00001111-aaaa-2222-bbbb-3333cccc4444" -ObjectId ContosoObjectId

此命令将 Synapse 管理员角色分配给通过管道的对象 ID 为 ContosoObjectId 的用户。

参数

-AsJob

在后台运行 cmdlet

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Confirm

提示你在运行 cmdlet 之前进行确认。

类型:SwitchParameter
别名:cf
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-DefaultProfile

用于与 Azure 通信的凭据、帐户、租户和订阅。

类型:IAzureContextContainer
别名:AzContext, AzureRmContext, AzureCredential
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Item

工作区项。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-ItemType

工作区项类型。

类型:Microsoft.Azure.Commands.Synapse.Models.SynapseConstants+WorkspaceItemType
接受的值:ApacheSparkPool, IntegrationRuntime, LinkedService, Credential
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-ObjectId

用户、组或服务主体的 Microsoft Entra ObjectId。

类型:String
别名:Id, PrincipalId
Position:Named
默认值:None
必需:True
接受管道输入:False
接受通配符:False

-RoleDefinitionId

分配给主体的角色的 ID。

类型:String
Position:Named
默认值:None
必需:True
接受管道输入:False
接受通配符:False

-RoleDefinitionName

分配给主体的角色的名称。

类型:String
Position:Named
默认值:None
必需:True
接受管道输入:False
接受通配符:False

-ServicePrincipalName

服务主体的 ServicePrincipalName。

类型:String
Position:Named
默认值:None
必需:True
接受管道输入:False
接受通配符:False

-SignInName

用户的电子邮件地址或用户主体名称。

类型:String
别名:Email, UserPrincipalName
Position:Named
默认值:None
必需:True
接受管道输入:False
接受通配符:False

-WhatIf

显示运行该 cmdlet 时会发生什么情况。 cmdlet 未运行。

类型:SwitchParameter
别名:wi
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-WorkspaceName

Synapse 工作区的名称。

类型:String
Position:Named
默认值:None
必需:True
接受管道输入:False
接受通配符:False

-WorkspaceObject

工作区输入对象,通常通过管道传递。

类型:PSSynapseWorkspace
Position:Named
默认值:None
必需:True
接受管道输入:True
接受通配符:False

输入

PSSynapseWorkspace

输出

PSRoleAssignmentDetails