Test-AzSynapseSqlPool

Module:

Az.Synapse

Checks for the existence of a Synapse Analytics SQL pool.

Syntax

Test-AzSynapseSqlPool
    [-ResourceGroupName <String>]
    -WorkspaceName <String>
    -Name <String>
    [-Version <Int32>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Test-AzSynapseSqlPool
    -Name <String>
    [-Version <Int32>]
    -WorkspaceObject <PSSynapseWorkspace>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

The Test-AzSynapseSqlPool cmdlet checks for the existence of a Synapse Analytics SQL pool.

Examples

Example 1

Test-AzSynapseSqlPool -WorkspaceName ContosoWorkspace -Name ContosoSqlPool

This command checks the existence of the specified SQL pool.

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 SQL pool.

Type:	String
Aliases:	SqlPoolName
Position:	Named
Default value:	None
Required:	True
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

-Version

Version of Synapse SQL pool. For example, 2 or 3.

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

-WorkspaceName

Name of Synapse workspace.

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

-WorkspaceObject

workspace input object, usually passed through the pipeline.

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

Inputs

PSSynapseWorkspace

Outputs

Object