Get-AzSqlDatabaseGeoBackup
Gets a geo-redundant backup of a database.
Syntax
Get-AzSqlDatabaseGeoBackup
[-ExpandKeyList]
[-KeysFilter <String>]
[-ServerName] <String>
[[-DatabaseName] <String>]
[-ResourceGroupName] <String>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Get-AzSqlDatabaseGeoBackup cmdlet gets a specified geo-redundant backup of a SQL database or all available geo-redundant backups on a specified server. 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 database to a new region. This cmdlet is also supported by the SQL Server Stretch Database service on Azure.
Examples
Example 1: Get all geo-redundant backups on a server
Get-AzSqlDatabaseGeoBackup -ResourceGroupName "ContosoResourceGroup" -ServerName "ContosoServer"This command gets all available geo-redundant backups on a specified server.
Example 2: Get a specified geo-redundant backup
Get-AzSqlDatabaseGeoBackup -ResourceGroupName "ContosoResourceGroup" -ServerName "ContosoServer" -DatabaseName "ContosoDatabase"This command gets the database geo-redundant backup named ContosoDatabase.
Example 3: Get all geo-redundant backups on a server using filtering
Get-AzSqlDatabaseGeoBackup -ResourceGroupName "ContosoResourceGroup" -ServerName "ContosoServer" -DatabaseName "Contoso*"This command gets all available geo-redundant backups on a specified server that start with "Contoso".
Example 4: Get a recoverable database with TDE AKV keys on a server using expand keys
Get-AzSqlDatabaseGeoBackup -ResourceGroupName "ContosoResourceGroup" -ServerName "ContosoServer" -DatabaseName "Contoso" -ExpandKeyListThis command gets a recoverable database configured with CMK with expand keys on a specified server. This filter when used, shows all AKV keys on a database.
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 |
-DatabaseName
Specifies the name of the database to get.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | True |
-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 |
-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 SQL database 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 server that hosts the backup to restore.
| 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
Outputs
AzureSqlDatabaseGeoBackupModel
