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

説明

New-AzSynapseRoleAssignment コマンドレットは、Azure Synapse Analytics ロールの割り当てを作成します。

このコマンドレットは、入力パラメーターに従って、以下の Microsoft Graph API を呼び出す場合があります。

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

手記

サービスプリンシパルのロールの割り当てを作成するには、ObjectId パラメーターでプリンシパルのオブジェクト ID を渡します。ワークスペースで Azure RBAC ロールの割り当てを管理するアクセス許可を持つユーザーであり、Synapse 管理者ではない場合は、 -RoleDefinitionId と -ObjectId を直接して Synapse 管理者ロールを作成してください。ただし、Synapse Administrator の場合、RoleDefinitionId は "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb" である -RoleDefinitionNameでは参照できません。以下の例 5 を参考にしてください。この理由は、"Synapse Administrator" ロールを追加しようとすると、コマンドレットは、現在のユーザーが持っていないワークスペースの読み取りアクセス許可を必要とするロール名からロール ID を取得する必要があります。

例

例 1

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

このコマンドは、プリンシパル名が ContosoName であるユーザーに ContosoRole を割り当てます。

例 2

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

このコマンドは、プリンシパル名が ContosoName で項目の種類が ContosoItemType、項目が ContosoItem であるユーザーに ContosoRole を割り当てます。

例 3

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

このコマンドは、プリンシパル名が ContosoName で項目の種類が ContosoItemType、項目が ContosoItem であるユーザーに ContosoRole を割り当てます。

例 4

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

このコマンドは、パイプライン経由でプリンシパル名が ContosoName であるユーザーに ContosoRole を割り当てます。

例 5

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

このコマンドは、パイプライン経由でオブジェクト ID が ContosoObjectId であるユーザーに Synapse 管理者ロールを割り当てます。

パラメーター

-AsJob

バックグラウンドでコマンドレットを実行する

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Confirm

コマンドレットを実行する前に確認を求めるメッセージが表示されます。

型:	SwitchParameter
Aliases:	cf
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DefaultProfile

Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。

型:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Item

ワークスペース項目。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ItemType

ワークスペース項目の種類。

型:	Microsoft.Azure.Commands.Synapse.Models.SynapseConstants+WorkspaceItemType
指定可能な値:	ApacheSparkPool, IntegrationRuntime, LinkedService, Credential
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ObjectId

ユーザー、グループ、またはサービスプリンシパルの Microsoft Entra ObjectId。

型:	String
Aliases:	Id, PrincipalId
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-RoleDefinitionId

プリンシパルに割り当てられているロールの ID。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-RoleDefinitionName

プリンシパルに割り当てられているロールの名前。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ServicePrincipalName

サービスプリンシパルの ServicePrincipalName。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-SignInName

ユーザーの電子メールアドレスまたはユーザープリンシパル名。

型:	String
Aliases:	Email, UserPrincipalName
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-WhatIf

コマンドレットを実行した場合の動作を示します。コマンドレットは実行されません。

型:	SwitchParameter
Aliases:	wi
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-WorkspaceName

Synapse ワークスペースの名前。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-WorkspaceObject

ワークスペース入力オブジェクト。通常はパイプラインを介して渡されます。

型:	PSSynapseWorkspace
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

入力

PSSynapseWorkspace

出力

PSRoleAssignmentDetails

次の方法で共有