Test-AzSynapseWorkspace

  • Reference
Module:
Az.Synapse

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: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
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

Resource group name.

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

Inputs

None

Outputs

Object