Get-AzSynapseRoleDefinition

Reference

Module:: Az.Synapse

Gets a Synapse Analytics role definition.

Syntax

Get-AzSynapseRoleDefinition
   -WorkspaceName <String>
   [-Id <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzSynapseRoleDefinition
   -WorkspaceName <String>
   [-Name <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzSynapseRoleDefinition
   -WorkspaceObject <PSSynapseWorkspace>
   -Id <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzSynapseRoleDefinition
   -WorkspaceObject <PSSynapseWorkspace>
   [-Name <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzSynapseRoleDefinition cmdlet gets an Azure Synapse Analytics Role Definition. If you do not specify a role name or a role Id, this cmdlet gets all role definitions.

Examples

Example 1

Get-AzSynapseRoleDefinition -WorkspaceName ContosoWorkspace

This command gets all role definitions under a workspace.

Example 2

Get-AzSynapseRoleDefinition -WorkspaceName ContosoWorkspace -Name ContosoRole

This command gets the role definition under workspace ContosoWorkspace with name ContosoRole.

Example 3

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

This command gets all role definitions 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

-Id

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

-Name

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

-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

PSSynapseRole