Get-AzSynapseRoleAssignment
Synapse Analytics ロールの割り当てを取得します。
構文
GetByWorkspaceNameAndNameParameterSet (既定)
Get-AzSynapseRoleAssignment
-WorkspaceName <String>
[-RoleDefinitionName <String>]
[-SignInName <String>]
[-ItemType <WorkspaceItemType>]
[-Item <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetByWorkspaceNameAndIdParameterSet
Get-AzSynapseRoleAssignment
-WorkspaceName <String>
[-RoleDefinitionName <String>]
[-ObjectId <String>]
[-ItemType <WorkspaceItemType>]
[-Item <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetByWorkspaceNameAndRoleDefinitionIdAndObjectIdParameterSet
Get-AzSynapseRoleAssignment
-WorkspaceName <String>
-RoleDefinitionId <String>
[-ObjectId <String>]
[-ItemType <WorkspaceItemType>]
[-Item <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetByWorkspaceNameAndAssignmentIdParameterSet
Get-AzSynapseRoleAssignment
-WorkspaceName <String>
-RoleAssignmentId <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetByWorkspaceNameAndServicePrincipalNameParameterSet
Get-AzSynapseRoleAssignment
-WorkspaceName <String>
[-RoleDefinitionName <String>]
[-ServicePrincipalName <String>]
[-ItemType <WorkspaceItemType>]
[-Item <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetByWorkspaceObjectAndNameParameterSet
Get-AzSynapseRoleAssignment
-WorkspaceObject <PSSynapseWorkspace>
-SignInName <String>
[-RoleDefinitionName <String>]
[-ItemType <WorkspaceItemType>]
[-Item <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetByWorkspaceObjectAndIdParameterSet
Get-AzSynapseRoleAssignment
-WorkspaceObject <PSSynapseWorkspace>
[-RoleDefinitionName <String>]
[-ObjectId <String>]
[-ItemType <WorkspaceItemType>]
[-Item <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetByWorkspaceObjectAndRoleDefinitionIdAndObjectIdParameterSet
Get-AzSynapseRoleAssignment
-WorkspaceObject <PSSynapseWorkspace>
-RoleDefinitionId <String>
[-ObjectId <String>]
[-ItemType <WorkspaceItemType>]
[-Item <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetByWorkspaceObjectAndAssignmentIdParameterSet
Get-AzSynapseRoleAssignment
-WorkspaceObject <PSSynapseWorkspace>
-RoleAssignmentId <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetByWorkspaceObjectAndServicePrincipalNameParameterSet
Get-AzSynapseRoleAssignment
-WorkspaceObject <PSSynapseWorkspace>
-ServicePrincipalName <String>
[-RoleDefinitionName <String>]
[-ItemType <WorkspaceItemType>]
[-Item <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
説明
Get-AzSynapseRoleAssignment コマンドレットは、Azure Synapse Analytics ロールの割り当てを取得します。
ロール定義またはユーザー プリンシパル名を指定しない場合、このコマンドレットはすべてのロールの割り当てを取得します。
このコマンドレットは、入力パラメーターに従って、以下の Microsoft Graph API を呼び出す場合があります。
- GET /users/{id}
- GET /servicePrincipals/{id}
注
サービス プリンシパルのロールの割り当てを取得するには、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
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Item
Azure Synapse ワークスペースの項目。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
GetByWorkspaceNameAndNameParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
GetByWorkspaceNameAndIdParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
GetByWorkspaceNameAndRoleDefinitionIdAndObjectIdParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
GetByWorkspaceNameAndServicePrincipalNameParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
GetByWorkspaceObjectAndNameParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
GetByWorkspaceObjectAndIdParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
GetByWorkspaceObjectAndRoleDefinitionIdAndObjectIdParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
GetByWorkspaceObjectAndServicePrincipalNameParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ItemType
Azure Synapse ワークスペースの itemtype。
パラメーターのプロパティ
| 型: | Microsoft.Azure.Commands.Synapse.Models.SynapseConstants+WorkspaceItemType
|
| 規定値: | None |
| 指定可能な値: | ApacheSparkPool, IntegrationRuntime, LinkedService, Credential |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
GetByWorkspaceNameAndNameParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
GetByWorkspaceNameAndIdParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
GetByWorkspaceNameAndRoleDefinitionIdAndObjectIdParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
GetByWorkspaceNameAndServicePrincipalNameParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
GetByWorkspaceObjectAndNameParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
GetByWorkspaceObjectAndIdParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
GetByWorkspaceObjectAndRoleDefinitionIdAndObjectIdParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
GetByWorkspaceObjectAndServicePrincipalNameParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ObjectId
ユーザー、グループ、またはサービス プリンシパルの Microsoft Entra ObjectId。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ID (アイディー), PrincipalId |
パラメーター セット
GetByWorkspaceNameAndIdParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
GetByWorkspaceNameAndRoleDefinitionIdAndObjectIdParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
GetByWorkspaceObjectAndIdParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
GetByWorkspaceObjectAndRoleDefinitionIdAndObjectIdParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-RoleAssignmentId
ロールの割り当ての ID。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
GetByWorkspaceNameAndAssignmentIdParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
GetByWorkspaceObjectAndAssignmentIdParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-RoleDefinitionId
プリンシパルに割り当てられているロールの ID。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
GetByWorkspaceNameAndRoleDefinitionIdAndObjectIdParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
GetByWorkspaceObjectAndRoleDefinitionIdAndObjectIdParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-RoleDefinitionName
プリンシパルに割り当てられているロールの名前。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
GetByWorkspaceNameAndNameParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
GetByWorkspaceNameAndIdParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
GetByWorkspaceNameAndServicePrincipalNameParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
GetByWorkspaceObjectAndNameParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
GetByWorkspaceObjectAndIdParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
GetByWorkspaceObjectAndServicePrincipalNameParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ServicePrincipalName
サービス プリンシパルの ServicePrincipalName。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
GetByWorkspaceNameAndServicePrincipalNameParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-SignInName
ユーザーの電子メール アドレスまたはユーザー プリンシパル名。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | Email, ユーザープリンシパルネーム |
パラメーター セット
GetByWorkspaceNameAndNameParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-WorkspaceName
Synapse ワークスペースの名前。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
GetByWorkspaceNameAndNameParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
GetByWorkspaceNameAndIdParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
GetByWorkspaceNameAndRoleDefinitionIdAndObjectIdParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
GetByWorkspaceNameAndAssignmentIdParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
GetByWorkspaceNameAndServicePrincipalNameParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-WorkspaceObject
ワークスペース入力オブジェクト。通常はパイプラインを介して渡されます。
パラメーターのプロパティ
パラメーター セット
GetByWorkspaceObjectAndNameParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
GetByWorkspaceObjectAndIdParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
GetByWorkspaceObjectAndRoleDefinitionIdAndObjectIdParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
GetByWorkspaceObjectAndAssignmentIdParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
GetByWorkspaceObjectAndServicePrincipalNameParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
出力