Get-AzSynapseWorkspace

Module:

Az.Synapse

Gets a Synapse Analytics workspace.

Syntax

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

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/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/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.

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

-Name

Name of Synapse workspace.

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

-ResourceGroupName

Resource group name.

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

-ResourceId

Resource identifier of Synapse workspace.

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

Inputs

None

Outputs

PSSynapseWorkspace