Get-AzSynapseRoleAssignment
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 との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。
| 型: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Item
Azure Synapse ワークスペースの項目。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-ItemType
Azure Synapse ワークスペースの 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 |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-RoleAssignmentId
ロールの割り当ての ID。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-RoleDefinitionId
プリンシパルに割り当てられているロールの ID。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-RoleDefinitionName
プリンシパルに割り当てられているロールの名前。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-ServicePrincipalName
サービス プリンシパルの ServicePrincipalName。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-SignInName
ユーザーの電子メール アドレスまたはユーザー プリンシパル名。
| 型: | String |
| Aliases: | Email, UserPrincipalName |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-WorkspaceName
Synapse ワークスペースの名前。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-WorkspaceObject
ワークスペース入力オブジェクト。通常はパイプラインを介して渡されます。
| 型: | PSSynapseWorkspace |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |