Get-AzSynapseRoleDefinition
Gets a Synapse Analytics role definition.
Syntax
GetByWorkspaceNameAndIdParameterSet (Default)
Get-AzSynapseRoleDefinition
-WorkspaceName <String>
[-Id <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetByWorkspaceNameAndNameParameterSet
Get-AzSynapseRoleDefinition
-WorkspaceName <String>
[-Name <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetByWorkspaceObjectAndIdParameterSet
Get-AzSynapseRoleDefinition
-WorkspaceObject <PSSynapseWorkspace>
-Id <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetByWorkspaceObjectAndNameParameterSet
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.
Parameter properties
Type: IAzureContextContainer
Default value: None Supports wildcards: False DontShow: False Aliases: AzContext, AzureRmContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Id
Id of the Role that is assigned to the principal.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
GetByWorkspaceNameAndIdParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Name
Name of the Role that is assigned to the principal.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
GetByWorkspaceNameAndNameParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetByWorkspaceObjectAndNameParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WorkspaceName
Name of Synapse workspace.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
GetByWorkspaceNameAndIdParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetByWorkspaceNameAndNameParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WorkspaceObject
workspace input object, usually passed through the pipeline.
Parameter properties
Parameter sets
GetByWorkspaceObjectAndIdParameterSet
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
GetByWorkspaceObjectAndNameParameterSet
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs
