New-AzSynapseRoleAssignment

參考

模組:: Az.Synapse

建立 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>]

Description

New-AzSynapseRoleAssignment Cmdlet 會建立 Azure Synapse Analytics 角色指派。

Cmdlet 可能會根據輸入參數呼叫下列Microsoft圖形 API：

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

注意

若要建立服務主體的角色指派，請在 ObjectId 參數中傳遞主體的物件識別碼。當您是有權在工作區上管理 Azure RBAC 角色指派但不是 Synapse 系統管理員的使用者時，請直接透過 -RoleDefinitionId 和 -ObjectId 直接建立 Synapse Administrator 角色，但不能直接透過 -RoleDefinitionName，針對 Synapse Administrator，RoleDefinitionId 是 “aaaaaaaa-0000-1111-2222-bbbbbb”，請採用下列範例 5 作為參考。原因是，當您嘗試新增「Synapse Administrator」角色時，Cmdlet 必須從需要工作區讀取許可權的角色名稱取得角色標識碼，而該角色標識符是目前用戶沒有的角色名稱。

範例

範例 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 Administrator 角色指派給透過管線之物件標識碼為 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

指派給主體的角色標識碼。

類型:	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

共用方式為