Edit

Share via

Get-AzSqlDatabaseLongTermRetentionBackup

Module:
Az.Sql Module

Gets one or more long term retention backups.

Syntax

Location (Default) 

Get-AzSqlDatabaseLongTermRetentionBackup
    [-Location] <String>
    [-ResourceGroupName <String>]
    [-OnlyLatestPerDatabase]
    [-DatabaseState <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ServerName 

Get-AzSqlDatabaseLongTermRetentionBackup
    [-Location] <String>
    [-ServerName] <String>
    [-DatabaseName <String>]
    [-ResourceGroupName <String>]
    [-OnlyLatestPerDatabase]
    [-DatabaseState <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

BackupName 

Get-AzSqlDatabaseLongTermRetentionBackup
    [-Location] <String>
    [-ServerName] <String>
    [-BackupName] <String>
    -DatabaseName <String>
    [-ResourceGroupName <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

GetBackupByResourceId 

Get-AzSqlDatabaseLongTermRetentionBackup
    [-Location] <String>
    [-ResourceId] <String>
    [-BackupName] <String>
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

GetBackupsByResourceId 

Get-AzSqlDatabaseLongTermRetentionBackup
    [-Location] <String>
    [-ResourceId] <String>
    [-OnlyLatestPerDatabase]
    [-DatabaseState <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

GetBackupByInputObject 

Get-AzSqlDatabaseLongTermRetentionBackup
    [-InputObject] <AzureSqlDatabaseModel>
    [-BackupName] <String>
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

GetBackupsByInputObject 

Get-AzSqlDatabaseLongTermRetentionBackup
    [-InputObject] <AzureSqlDatabaseModel>
    [-OnlyLatestPerDatabase]
    [-DatabaseState <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Get-AzSqlDatabaseLongTermRetentionBackup cmdlet gets all long term retention backups for a location, server, or database or gets a specific long term retention backup.

Examples

Example 1: Get all backups for a location

Get-AzSqlDatabaseLongTermRetentionBackup -Location northeurope

BackupExpirationTime			 : 3/22/2018 5:50:55 AM
BackupName						 : 601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000
BackupTime						 : 3/15/2018 5:50:55 AM
DatabaseName					 : database01
DatabaseDeletionTime			 :
Location						 : northeurope
ResourceId						 : /subscriptions/371edd6d-9630-4558-a7bd-ee139498e6a1/resourceGroups/resourcegroup01/providers/Microsoft.Sql/locations/northeurope/longTermRetentionServers/server01/longTermRetentionDatabases/database01/longTermRetentionBackups/601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000
ServerName						 : server01
ServerCreateTime				 : 2/29/2018 12:12:19 AM
ResourceGroupName                :
BackupStorageRedundancy			 : Geo

BackupExpirationTime			 : 3/22/2018 11:43:18 PM
BackupName						 : 55970792-164c-4a4a-88e5-7158d092d503;131656309980000000
BackupTime						 : 3/15/2018 11:43:18 PM
DatabaseName					 : database02
DatabaseDeletionTime			 : 3/18/2018 4:36:00 PM
Location						 : northeurope
ResourceId						 : /subscriptions/371edd6d-9630-4558-a7bd-ee139498e6a1/providers/Microsoft.Sql/locations/northeurope/longTermRetentionServers/server02/longTermRetentionDatabases/database02/longTermRetentionBackups/55970792-164c-4a4a-88e5-7158d092d503;131656309980000000
ServerName						 : server02
ServerCreateTime				 : 2/28/2018 12:12:19 AM
ResourceGroupName                :
BackupStorageRedundancy			 : Geo

This command gets all long term retention backups for all databases (which may be alive or deleted) in southeastasia, resource group will be set only if server is live.

Example 2: Get all backups for a location under a resource group

Get-AzSqlDatabaseLongTermRetentionBackup -Location northeurope -ResourceGroupName resourceGroup01

BackupExpirationTime			 : 3/22/2018 5:50:55 AM
BackupName						     : 601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000
BackupTime						     : 3/15/2018 5:50:55 AM
DatabaseName					     : database01
DatabaseDeletionTime			 :
Location						       : northeurope
ResourceId						     : /subscriptions/371edd6d-9630-4558-a7bd-ee139498e6a1/resourceGroups/resourcegroup01/providers/Microsoft.Sql/locations/northeurope/longTermRetentionServers/server01/longTermRetentionDatabases/database01/longTermRetentionBackups/601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000
ServerName						     : server01
ServerCreateTime			  	 : 2/29/2018 12:12:19 AM
ResourceGroupName          : resourceGroup01
BackupStorageRedundancy		 : Geo

This command gets all long term retention backups for all databases (which may be alive or deleted) under a resource group in northeurope.

Example 3: Get a specific long term retention backup

Get-AzSqlDatabaseLongTermRetentionBackup -Location northeurope -ServerName server01 -DatabaseName database01 -BackupName "601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000"

BackupExpirationTime			 : 3/22/2018 5:50:55 AM
BackupName						     : 601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000
BackupTime						     : 3/15/2018 5:50:55 AM
DatabaseName					     : database01
DatabaseDeletionTime			 :
Location						       : northeurope
ResourceId					       : /subscriptions/371edd6d-9630-4558-a7bd-ee139498e6a1/resourceGroups/resourcegroup01/providers/Microsoft.Sql/locations/northeurope/longTermRetentionServers/server01/longTermRetentionDatabases/database01/longTermRetentionBackups/601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000
ServerName						     : server01
ServerCreateTime			  	 : 2/29/2018 12:12:19 AM
ResourceGroupName          :
BackupStorageRedundancy		 : Geo

This command gets the backup with name 601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000

Example 4: Get all long term retention backups for a database

Get-AzSqlDatabase -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 | Get-AzSqlDatabaseLongTermRetentionBackup

BackupExpirationTime			 : 3/22/2018 5:50:55 AM
BackupName						     : 601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000
BackupTime						     : 3/15/2018 5:50:55 AM
DatabaseName					     : database01
DatabaseDeletionTime			 :
Location						       : northeurope
ResourceId						     : /subscriptions/371edd6d-9630-4558-a7bd-ee139498e6a1/resourceGroups/resourcegroup01/providers/Microsoft.Sql/locations/northeurope/longTermRetentionServers/server01/longTermRetentionDatabases/database01/longTermRetentionBackups/601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000
ServerName						     : server01
ServerCreateTime				   : 2/29/2018 12:12:19 AM
ResourceGroupName          :
BackupStorageRedundancy		 : Geo

This command gets all long term retention backups for database01

Example 5: Get long term retention backups using filtering

Get-AzSqlDatabaseLongTermRetentionBackup -Location northeurope -ServerName server01 -DatabaseName database01 -BackupName "601061b7*"

BackupExpirationTime			 : 3/22/2018 11:43:18 PM
BackupName					       : 601061b7-164c-4a4a-88e5-7158d092d503;131656309980000000
BackupTime						     : 3/15/2018 11:43:18 PM
DatabaseName					     : database02
DatabaseDeletionTime			 : 3/18/2018 4:36:00 PM
Location						       : northeurope
ResourceId					       : /subscriptions/371edd6d-9630-4558-a7bd-ee139498e6a1/resourceGroups/resourcegroup01/Microsoft.Sql/locations/northeurope/longTermRetentionServers/server01/longTermRetentionDatabases/database02/longTermRetentionBackups/601061b7-164c-4a4a-88e5-7158d092d503;131656309980000000
ServerName						     : server01
ServerCreateTime				   : 2/28/2018 12:12:19 AM
ResourceGroupName          :
BackupStorageRedundancy		 : Geo

BackupExpirationTime			 : 3/22/2018 5:50:55 AM
BackupName						     : 601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000
BackupTime						     : 3/15/2018 5:50:55 AM
DatabaseName					     : database01
DatabaseDeletionTime			 :
Location						       : northeurope
ResourceId						     : /subscriptions/371edd6d-9630-4558-a7bd-ee139498e6a1/resourceGroups/resourcegroup01/providers/Microsoft.Sql/locations/northeurope/longTermRetentionServers/server01/longTermRetentionDatabases/database01/longTermRetentionBackups/601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000
ServerName						     : server01
ServerCreateTime				   : 2/29/2018 12:12:19 AM
ResourceGroupName          :
BackupStorageRedundancy		 : Geo

This command gets all backups with name that starts with "601061b7"

Parameters

-BackupName

The name of the backup.

Parameter properties

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

Parameter sets

BackupName
Position:3
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
GetBackupByResourceId
Position:3
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
GetBackupByInputObject
Position:3
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

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

Parameter sets

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

-DatabaseName

The name of the Azure SQL Database the backup is from.

Parameter properties

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

Parameter sets

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

-DatabaseState

The state of the database whose backups you want to find, Alive, Deleted, or All. Defaults to All

Parameter properties

Type:String
Default value:None
Accepted values:All, Deleted, Live
Supports wildcards:False
DontShow:False

Parameter sets

Location
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
ServerName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
GetBackupsByResourceId
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
GetBackupsByInputObject
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-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

-InputObject

The database object to get backups for.

Parameter properties

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

Parameter sets

GetBackupByInputObject
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
GetBackupsByInputObject
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Location

The location of the backups' source server.

Parameter properties

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

Parameter sets

Location
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ServerName
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
BackupName
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
GetBackupByResourceId
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
GetBackupsByResourceId
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-OnlyLatestPerDatabase

Whether or not to only get the latest backup per database. Defaults to false.

Parameter properties

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

Parameter sets

Location
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ServerName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
GetBackupsByResourceId
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
GetBackupsByInputObject
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResourceGroupName

The name of the resource group.

Parameter properties

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

Parameter sets

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

-ResourceId

The database Resource ID to get backups for.

Parameter properties

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

Parameter sets

GetBackupByResourceId
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
GetBackupsByResourceId
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-ServerName

The name of the Azure SQL Server the backups are under.

Parameter properties

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

Parameter sets

ServerName
Position:1
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
BackupName
Position:1
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

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

Parameter properties

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

Parameter sets

(All)
Position:Named
Mandatory:False
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

AzureSqlDatabaseModel

String

Outputs

AzureSqlDatabaseLongTermRetentionBackupModel