Test-AzSynapseWorkspace.md

external help file	Module Name	online version	schema
Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml	Az.Synapse	https://learn.microsoft.com/powershell/module/az.synapse/test-azsynapseworkspace	2.0.0

Test-AzSynapseWorkspace

SYNOPSIS

Checks for the existence of a Synapse Analytics workspace.

SYNTAX

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

DESCRIPTION

The Test-AzSynapseWorkspace cmdlet checks for the existence of a Synapse Analytics workspace.

EXAMPLES

Example 1

Test-AzSynapseWorkspace -Name ContosoWorkspace

This command checks for the existence of a Synapse Analytics workspace.

PARAMETERS

-DefaultProfile

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

Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzContext, AzureRmContext, AzureCredential

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

-Name

Name of Synapse workspace.

Type: System.String
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ResourceGroupName

Resource group name.

Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None

OUTPUTS

System.Object

NOTES

RELATED LINKS