Edit

Share via

Get-AzSqlDeletedDatabaseBackup

  • Reference
Module:
Az.Sql

Gets a deleted database that you can restore.

Syntax

Get-AzSqlDeletedDatabaseBackup
   [-ExpandKeyList]
   [-KeysFilter <String>]
   [-DatabaseId <String>]
   [-ServerName] <String>
   [[-DatabaseName] <String>]
   [[-DeletionDate] <DateTime>]
   [-ResourceGroupName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Get-AzSqlDeletedDatabaseBackup cmdlet gets a specified deleted SQL database backup that you can restore, or all deleted backups that you can restore. This cmdlet is also supported by the SQL Server Stretch Database service on Azure.

Examples

Example 1: Get all deleted database backups on a server

Get-AzSqlDeletedDatabaseBackup -ResourceGroupName "ContosoResourceGroup" -ServerName "ContosoServer"

This command gets all deleted database backups on a server.

Example 2: Get a specified deleted database backup

Get-AzSqlDeletedDatabaseBackup -ResourceGroupName "ContosoResourceGroup" -ServerName "ContosoServer" -DatabaseName "ContosoDatabase"

This command gets the deleted database backup for ContosoDatabase.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-DatabaseId

Id of the database

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

-DatabaseName

Specifies the name of the database.

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

-DeletionDate

Specifies the date, as a DateTime object, that the database was deleted. To get a DateTime object, use the Get-Date cmdlet.

Type:Nullable<T>[DateTime]
Position:3
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ExpandKeyList

Flag to be used to view all the AKV keys in a database.

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

-KeysFilter

Timestamp filter to get AKV keys

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

-ResourceGroupName

Specifies the name of the resource group to which the server is assigned.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ServerName

Specifies the name of the database server.

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

Inputs

String

Nullable<T>[[System.DateTime, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

Outputs

AzureSqlDeletedDatabaseBackupModel