Get-AzSynapseRoleAssignment

リファレンス

モジュール:: Az.Synapse

Synapse Analytics ロールの割り当てを取得します。

構文

Get-AzSynapseRoleAssignment
   -WorkspaceName <String>
   [-RoleDefinitionName <String>]
   [-SignInName <String>]
   [-ItemType <WorkspaceItemType>]
   [-Item <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzSynapseRoleAssignment
   -WorkspaceName <String>
   [-RoleDefinitionName <String>]
   [-ObjectId <String>]
   [-ItemType <WorkspaceItemType>]
   [-Item <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzSynapseRoleAssignment
   -WorkspaceName <String>
   -RoleDefinitionId <String>
   [-ObjectId <String>]
   [-ItemType <WorkspaceItemType>]
   [-Item <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzSynapseRoleAssignment
   -WorkspaceName <String>
   -RoleAssignmentId <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzSynapseRoleAssignment
   -WorkspaceName <String>
   [-RoleDefinitionName <String>]
   [-ServicePrincipalName <String>]
   [-ItemType <WorkspaceItemType>]
   [-Item <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzSynapseRoleAssignment
   -WorkspaceObject <PSSynapseWorkspace>
   [-RoleDefinitionName <String>]
   -SignInName <String>
   [-ItemType <WorkspaceItemType>]
   [-Item <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzSynapseRoleAssignment
   -WorkspaceObject <PSSynapseWorkspace>
   [-RoleDefinitionName <String>]
   [-ObjectId <String>]
   [-ItemType <WorkspaceItemType>]
   [-Item <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzSynapseRoleAssignment
   -WorkspaceObject <PSSynapseWorkspace>
   -RoleDefinitionId <String>
   [-ObjectId <String>]
   [-ItemType <WorkspaceItemType>]
   [-Item <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzSynapseRoleAssignment
   -WorkspaceObject <PSSynapseWorkspace>
   -RoleAssignmentId <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzSynapseRoleAssignment
   -WorkspaceObject <PSSynapseWorkspace>
   [-RoleDefinitionName <String>]
   -ServicePrincipalName <String>
   [-ItemType <WorkspaceItemType>]
   [-Item <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

説明

Get-AzSynapseRoleAssignment コマンドレットは、Azure Synapse Analytics ロールの割り当てを取得します。ロール定義またはユーザープリンシパル名を指定しない場合、このコマンドレットはすべてのロールの割り当てを取得します。

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

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

Note

サービスプリンシパルのロールの割り当てを取得するには、ObjectId パラメーターでプリンシパルのオブジェクト ID を渡します。

例

例 1

Get-AzSynapseRoleAssignment -WorkspaceName ContosoWorkspace

このコマンドは、ワークスペースのすべてのロールの割り当てを取得します。

例 2

Get-AzSynapseRoleAssignment -WorkspaceName ContosoWorkspace -RoleDefinitionName ContosoRole

このコマンドは、ContosoRole というロール名を持つワークスペース ContosoWorkspace のすべてのロールの割り当てを取得します。

例 3

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

このコマンドは、ContosoRole というロール名とユーザープリンシパル名 ContosoName を使用して、ワークスペース ContosoWorkspace の下にロールの割り当てを取得します。

例 4

Get-AzSynapseRoleAssignment -WorkspaceName ContosoWorkspace -RoleDefinitionName ContosoRole -SignInName ContosoName -ItemType ContosoItemType

このコマンドは、ワークスペース ContosoWorkspace のロールの割り当てを、ロール名 ContosoRole、ユーザープリンシパル名 ContosoName、itemtype ContosoItemtype で取得します。

例 5

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

このコマンドは、ContosoRole というロール名、ユーザープリンシパル名 ContosoName、ContosoItemType、ContosoItem を使用して、ワークスペース ContosoWorkspace の下にロールの割り当てを取得します。

例 6

$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Get-AzSynapseRoleAssignment

このコマンドは、パイプラインを介してワークスペースの下にあるすべてのロールの割り当てを取得します。

パラメーター

-DefaultProfile

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

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Item

Azure Synapse ワークスペースの項目。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ItemType

Azure Synapse ワークスペースの itemtype。

Type:	Microsoft.Azure.Commands.Synapse.Models.SynapseConstants+WorkspaceItemType
Accepted values:	ApacheSparkPool, IntegrationRuntime, LinkedService, Credential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ObjectId

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

Type:	String
Aliases:	Id, PrincipalId
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RoleAssignmentId

ロールの割り当ての ID。

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-RoleDefinitionId

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

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-RoleDefinitionName

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

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ServicePrincipalName

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

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SignInName

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

Type:	String
Aliases:	Email, UserPrincipalName
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-WorkspaceName

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

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-WorkspaceObject

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

Type:	PSSynapseWorkspace
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

入力

PSSynapseWorkspace

出力

PSRoleAssignmentDetails

次の方法で共有