New-AzSynapseSqlPoolRestorePoint

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

Syntax

New-AzSynapseSqlPoolRestorePoint
   [-ResourceGroupName <String>]
   -WorkspaceName <String>
   -Name <String>
   -RestorePointLabel <String>
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzSynapseSqlPoolRestorePoint
   -Name <String>
   -WorkspaceObject <PSSynapseWorkspace>
   -RestorePointLabel <String>
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzSynapseSqlPoolRestorePoint
   -InputObject <PSSynapseSqlPool>
   -RestorePointLabel <String>
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
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

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

-Name

Name of Synapse SQL pool.

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

-ResourceGroupName

Resource group name.

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

-ResourceId

Resource identifier of Synapse SQL Pool.

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

-RestorePointLabel

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

Type:String
Position:Named
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False

-WorkspaceName

Name of Synapse workspace.

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

-WorkspaceObject

workspace input object, usually passed through the pipeline.

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

Inputs

PSSynapseWorkspace

PSSynapseSqlPool

Outputs

PSRestorePoint