Get-AzSynapseDroppedSqlPool

Module:

Az.Synapse Module

Gets a dropped Sql pool backup of a Synapse Sql Pool.

Syntax

GetByNameParameterSet (Default)

Get-AzSynapseDroppedSqlPool
    -ResourceGroupName <String>
    -WorkspaceName <String>
    [-Name <String>]
    [-DeletionDate <DateTime>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

GetByResourceIdParameterSet

Get-AzSynapseDroppedSqlPool
    [-DeletionDate <DateTime>]
    [-ResourceId <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

The Get-AzSynapseDroppedSqlPool cmdlet gets a specified deleted SQL pool backup that you can restore, or all deleted backups that you can restore in a workspace.

Examples

Example 1: Get a specified dropped sqlpools from a sql pool

Get-AzSynapseDroppedSqlPool -ResourceGroupName ContosoResourceGroup -WorkspaceName ContosoWorkspace -Name "ContosoSqlPool"

The cmdlet retrieves dropped sqlpools for a sql pool.

Example 2: Get all dropped sqlpool on a workspace

Get-AzSynapseDroppedSqlPool -ResourceGroupName "ContosoResourceGroup" -WorkspaceName "ContosoWorkspace"

This command gets all available dropped sqlpool on a specified workspace.

Parameters

-DefaultProfile

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

Parameter properties

Type:	IAzureContextContainer
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-DeletionDate

The deletion date of the Azure Synapse SQL Database to retrieve backups for, with millisecond precision (e.g. 2016-02-23T00:21:22.847Z)

Parameter properties

Type:	Nullable<T>[DateTime]
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-Name

The Synapse Sql pool.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

GetByNameParameterSet

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ResourceGroupName

Resource group name.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

GetByNameParameterSet

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ResourceId

Input a Dropped Sql Pool Resource Id.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

GetByResourceIdParameterSet

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-WorkspaceName

Name of Synapse workspace.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

GetByNameParameterSet

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CommonParameters

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

Inputs

PSSynapseWorkspace

Microsoft.Azure.Commands.Synapse.Models.PSSynapseResourceGroup

Outputs

Microsoft.Azure.Commands.Synapse.Models.PSDroppedSqlPoolBackupModel