Get-AzSynapseRoleAssignment

Module:

Az.Synapse

Gets a Synapse Analytics role assignment.

Syntax

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

Description

The Get-AzSynapseRoleAssignment cmdlet gets a Azure Synapse Analytics Role Assignment. If you do not specify a role definition or a user principal name, this cmdlet gets all role assignment.

The cmdlet may call below Microsoft Graph API according to input parameters:

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

Note

To retrieve a role assignment for a service principal, pass the object ID of the principal in the ObjectId parameter.

Examples

Example 1

Get-AzSynapseRoleAssignment -WorkspaceName ContosoWorkspace

This command gets all role assignments under a workspace.

Example 2

Get-AzSynapseRoleAssignment -WorkspaceName ContosoWorkspace -RoleDefinitionName ContosoRole

This command gets all role assignments under workspace ContosoWorkspace with role name ContosoRole.

Example 3

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

This command gets a role assignment under workspace ContosoWorkspace with role name ContosoRole and user principal name ContosoName.

Example 4

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

This command gets role assignments under workspace ContosoWorkspace with role name ContosoRole, user principal name ContosoName and under itemtype ContosoItemtype.

Example 5

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

This command gets a role assignment under workspace ContosoWorkspace with role name ContosoRole, user principal name ContosoName, ContosoItemType and ContosoItem.

Example 6

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

This command gets all role assignments under a workspace through pipeline.

Parameters

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

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

-Item

The item of Azure Synapse workspace.

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

-ItemType

The itemtype of Azure Synapse workspace.

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

The Microsoft Entra ObjectId of the User, Group or Service Principal.

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

-RoleAssignmentId

The ID of the role assignment.

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

-RoleDefinitionId

Id of the Role that is assigned to the principal.

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

-RoleDefinitionName

Name of the Role that is assigned to the principal.

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

-ServicePrincipalName

The ServicePrincipalName of the service principal.

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

-SignInName

The email address or the user principal name of the user.

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

-WorkspaceName

Name of Synapse workspace.

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

-WorkspaceObject

workspace input object, usually passed through the pipeline.

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

Inputs

PSSynapseWorkspace

Outputs

PSRoleAssignmentDetails