Remove-AzSynapseSqlPool

Module:

Az.Synapse

Deletes a Synapse Analytics SQL pool.

Syntax

Remove-AzSynapseSqlPool
      [-ResourceGroupName <String>]
      -WorkspaceName <String>
      -Name <String>
      [-Version <Int32>]
      [-PassThru]
      [-AsJob]
      [-Force]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzSynapseSqlPool
      -Name <String>
      [-Version <Int32>]
      -WorkspaceObject <PSSynapseWorkspace>
      [-PassThru]
      [-AsJob]
      [-Force]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzSynapseSqlPool
      [-Version <Int32>]
      -InputObject <PSSynapseSqlPool>
      [-PassThru]
      [-AsJob]
      [-Force]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzSynapseSqlPool
      [-Version <Int32>]
      -ResourceId <String>
      [-PassThru]
      [-AsJob]
      [-Force]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-AzSynapseSqlPool cmdlet permanently deletes an Azure Synapse Analytics SQL pool.

Examples

Example 1

Remove-AzSynapseSqlPool -WorkspaceName ContosoWorkspace -Name ContosoSqlPool

This command deletes an Azure Synapse Analytics SQL pool.

Example 2

$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Remove-AzSynapseSqlPool -Name ContosoSqlPool

This command deletes an Azure Synapse Analytics SQL pool through pipeline.

Example 3

$pool = Get-AzSynapseSqlPool -WorkspaceName ContosoWorkspace -Name ContosoSqlPool
$pool | Remove-AzSynapseSqlPool

This command deletes an Azure Synapse Analytics SQL pool through pipeline.

Example 4

Remove-AzSynapseSqlPool -ResourceId /subscriptions/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/resourceGroups/ContosoResourceGroup/providers/Microsoft.Synapse/workspaces/ContosoWorkspace/sqlPools/ContosoSqlPool

This command deletes an Azure Synapse Analytics SQL pool with the specified resource ID.

Parameters

-AsJob

Run cmdlet in the background

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-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

-Force

Do not ask for confirmation.

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

-InputObject

SQL pool input object, usually passed through the pipeline.

Type:	PSSynapseSqlPool
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
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

-PassThru

This Cmdlet does not return an object by default. If this switch is specified, it returns true if successful.

Type:	SwitchParameter
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 SQL Pool.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
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

PSSynapseSqlPool

String

Outputs

Boolean