Get-AzSynapseSqlPoolGeoBackup

Reference

Module:: Az.Synapse

Gets a geo-redundant backup of a Sql Pool.

Syntax

Get-AzSynapseSqlPoolGeoBackup
   -ResourceGroupName <String>
   -WorkspaceName <String>
   [-Name <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzSynapseSqlPoolGeoBackup
   [-ResourceId <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzSynapseSqlPoolGeoBackup cmdlet gets a specified geo-redundant backup of a SQL Pool or all available geo-redundant backups on a specified workspace. A geo-redundant backup is a restorable resource using data files from a separate geographic location. You can use Geo-Restore to restore a geo-redundant backup in the event of a regional outage to recover your Sql Pool to a new region.

Examples

Example 1: Get a specified geo-redundant backup

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

The cmdlet retrieves Geo Backup for a sql pool.

Example 2: Get all geo-redundant backups on a workspace

Get-AzSynapseSqlPoolGeoBackup -ResourceGroupName "ContosoResourceGroup" -WorkspaceName "ContosoWorkspace"

This command gets all available geo-redundant backups on a specified workspace.

Example 3: Get all geo-redundant backups on a workspace using filtering

Get-AzSynapseSqlPoolGeoBackup -ResourceGroupName "ContosoResourceGroup" -WorkspaceName "ContosoWorkspace" -Name "Contoso*"

This command gets all available geo-redundant backups on a specified workspace that start with "Contoso".

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

The Synapse Sql pool.

Type:	String
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:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceId

Input a Sql Pool Geo Backup Resource Id.

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

Inputs

PSSynapseWorkspace

Microsoft.Azure.Commands.Synapse.Models.PSSynapseResourceGroup

Outputs

Microsoft.Azure.Commands.Synapse.Models.PSBackupModel

Dela via