Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

New-AzSynapseSqlPoolRestorePoint

Creates a new restore point in an Azure Synapse Analytics SQL pool.

Syntax

CreateByNameParameterSet (Default) 

New-AzSynapseSqlPoolRestorePoint
 -WorkspaceName <String>
 -Name <String>
 -RestorePointLabel <String>
 [-ResourceGroupName <String>]
 [-AsJob]
 [-DefaultProfile <IAzureContextContainer>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

CreateByParentObjectParameterSet 

New-AzSynapseSqlPoolRestorePoint
 -Name <String>
 -WorkspaceObject <PSSynapseWorkspace>
 -RestorePointLabel <String>
 [-AsJob]
 [-DefaultProfile <IAzureContextContainer>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

CreateByInputObjectParameterSet 

New-AzSynapseSqlPoolRestorePoint
 -InputObject <PSSynapseSqlPool>
 -RestorePointLabel <String>
 [-AsJob]
 [-DefaultProfile <IAzureContextContainer>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

CreateByResourceIdParameterSet 

New-AzSynapseSqlPoolRestorePoint
 -ResourceId <String>
 -RestorePointLabel <String>
 [-AsJob]
 [-DefaultProfile <IAzureContextContainer>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

Description

The New-AzSynapseSqlPoolRestorePoint cmdlet creates a new restore point that an Azure Synapse Analytics SQL pool can be restored from.

Examples

Example 1

New-AzSynapseSqlPoolRestorePoint -WorkspaceName ContosoWorkspace -Name ContosoSqlPool -RestorePointLabel ContosoRestorePoint

This command creates a restore point for SQL pool called ContosoSqlPool in the workspace ContosoWorkspace.

Parameters

-AsJob

Run cmdlet in the background

Parameter properties

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

Parameter sets

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

-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

-InputObject

SQL pool input object, usually passed through the pipeline.

Parameter properties

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

Parameter sets

-Name

Name of Synapse SQL pool.

Parameter properties

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

Parameter sets

-ResourceGroupName

Resource group name.

Parameter properties

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

Parameter sets

-ResourceId

Resource identifier of Synapse SQL Pool.

Parameter properties

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

Parameter sets

-RestorePointLabel

The label we associate a restore point with, may not be unique.

Parameter properties

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

Parameter sets

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

-WorkspaceName

Name of Synapse workspace.

Parameter properties

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

Parameter sets

-WorkspaceObject

workspace input object, usually passed through the pipeline.

Parameter properties

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

Parameter sets

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

PSSynapseSqlPool

Outputs

PSRestorePoint

Feedback

Was this page helpful?