Update-AzSqlDatabaseLongTermRetentionBackup
Updates a long term retention backup.
Note
This is the previous version of our documentation. Please consult the most recent version for up-to-date information.
Syntax
Update-AzSqlDatabaseLongTermRetentionBackup
[-Location] <String>
[-ServerName] <String>
[-DatabaseName] <String>
[-BackupName] <String>
[-ResourceGroupName <String>]
[-BackupStorageRedundancy <String>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Update-AzSqlDatabaseLongTermRetentionBackup
[-ResourceId] <String>
[-BackupStorageRedundancy <String>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Update-AzSqlDatabaseLongTermRetentionBackup
[-BackupStorageRedundancy <String>]
[-InputObject] <AzureSqlDatabaseLongTermRetentionBackupModel>
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
Updates the properties of a long term retention backup.
Examples
Example 1: Update Backup Storage Redundancy of a long term retention backup.
PS C:\> Update-AzSqlDatabaseLongTermRetentionBackup -Location southeastasia -ServerName ayang-stage-seas -DatabaseName ltr3 -BackupName 'e5c20f43-494c-4925-89d1-58e0f4569fb3;132579992320000000' -ResourceGroupName testrg -BackupStorageRedundancy Geo
BackupExpirationTime : 3/19/2021 1:33:52 AM
BackupName : e5c20f43-494c-4925-89d1-58e0f4569fb3;132579992320000000
BackupTime : 2/17/2021 1:33:52 AM
DatabaseName : ltr3
DatabaseDeletionTime : 3/16/2021 6:28:11 AM
Location : southeastasia
ResourceId : /subscriptions/01c4ec88-e179-44f7-9eb0-e9719a5087ab/resourceGroups/testrg/providers/Microsoft.Sql/locations/southeastasia/longTermRetentionServers/ayang-stage-seas/longTermRetentionDatabases/ltr3/longTermRetentionBackups/e5c20f43-494c-4925-89d1-58e0f4569fb3;132579992320000000
ServerName : ayang-stage-seas
ServerCreateTime : 4/22/2020 9:58:33 PM
ResourceGroupName : testrg
BackupStorageRedundancy : GeoThis command sets the Backup Storage Redundancy of the specified backup using location and Resource Group, Server, Database, and Backup names.
Example 2: Update Backup Storage Redundancy of a long term retention backup (using Resource Id).
PS C:\> Update-AzSqlDatabaseLongTermRetentionBackup -ResourceId '/subscriptions/01c4ec88-e179-44f7-9eb0-e9719a5087ab/resourceGroups/testrg/providers/Microsoft.Sql/locations/southeastasia/longTermRetentionServers/ayang-stage-seas/longTermRetentionDatabases/ltr3/longTermRetentionBackups/e5c20f43-494c-4925-89d1-58e0f4569fb3;132579992320000000' -BackupStorageRedundancy Geo
BackupExpirationTime : 3/19/2021 1:33:52 AM
BackupName : e5c20f43-494c-4925-89d1-58e0f4569fb3;132579992320000000
BackupTime : 2/17/2021 1:33:52 AM
DatabaseName : ltr3
DatabaseDeletionTime : 3/16/2021 6:28:11 AM
Location : southeastasia
ResourceId : /subscriptions/01c4ec88-e179-44f7-9eb0-e9719a5087ab/resourceGroups/testrg/providers/Microsoft.Sql/locations/southeastasia/longTermRetentionServers/ayang-stage-seas/longTermRetentionDatabases/ltr3/longTermRetentionBackups/e5c20f43-494c-4925-89d1-58e0f4569fb3;132579992320000000
ServerName : ayang-stage-seas
ServerCreateTime : 4/22/2020 9:58:33 PM
ResourceGroupName : testrg
BackupStorageRedundancy : GeoThis command sets the Backup Storage Redundancy of the specified backup using a backup Resource Id.
Parameters
Run cmdlet in the background
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
The name of the backup.
| Type: | String |
| Position: | 3 |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
The Backup storage redundancy used to store backups for the SQL Database. Options are: Local, Zone and Geo.
| Type: | String |
| Accepted values: | Local, Zone, Geo |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
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 |
The name of the Azure SQL Database the backup is from.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
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 |
The Database Long Term Retention Backup object to update.
| Type: | AzureSqlDatabaseLongTermRetentionBackupModel |
| Position: | 0 |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
The location of the backup's source server.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
The name of the resource group.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
The Resource ID of the Database Long Term Retention Backup to remove.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
The name of the Azure SQL Server the backup is under.
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
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 |
Inputs
Outputs
AzureSqlDatabaseLongTermRetentionBackupModel