Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

Get-AzSynapseWorkspace

Gets a Synapse Analytics workspace.

Syntax

GetByNameParameterSet (Default) 

Get-AzSynapseWorkspace
 [-ResourceGroupName <String>]
 [-Name <String>]
 [-DefaultProfile <IAzureContextContainer>]
 [<CommonParameters>]

GetByResourceIdParameterSet 

Get-AzSynapseWorkspace
 -ResourceId <String>
 [-DefaultProfile <IAzureContextContainer>]
 [<CommonParameters>]

Description

The Get-AzSynapseWorkspace cmdlet gets information about an Azure Synapse Analytics workspace.

Examples

Example 1

Get-AzSynapseWorkspace

This command gets all the Azure Synapse Analytics workspaces under the current subscription.

Example 2

Get-AzSynapseWorkspace -ResourceGroupName ContosoResourceGroup

This command gets all the Azure Synapse Analytics workspaces under the current subscription within the Resource Group ContosoResourceGroup.

Example 3

Get-AzSynapseWorkspace -Name ContosoWorkspace

This command gets the Azure Synapse Analytics workspace with the specified name.

Example 4

Get-AzSynapseWorkspace -ResourceId /subscriptions/21686af7-58ec-4f4d-9c68-f431f4db4edd/resourceGroups/ContosoResourceGroup/providers/Microsoft.Synapse/workspaces/ContosoWorkspace

This command gets the Azure Synapse Analytics workspace with the specified resource ID.

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

-Name

Name of Synapse workspace.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:WorkspaceName

Parameter sets

-ResourceGroupName

Resource group name.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-ResourceId

Resource identifier of Synapse workspace.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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.

Inputs

None

Outputs

PSSynapseWorkspace

Feedback

Was this page helpful?