Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Set-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy
- Module:
- Az.Sql Module
Sets a backup short term retention policy.
Syntax
PolicyByResourceInstanceDatabaseSet (Default)
Set-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy
[-ResourceGroupName] <String>
[-InstanceName] <String>
[-DatabaseName] <String>
[-RetentionDays] <Int32>
[-DeletionDate <DateTime>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
PolicyByInputObjectSet
Set-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy
[-InputObject] <AzureSqlManagedDatabaseBaseModel>
[-RetentionDays] <Int32>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
PolicyByResourceIdSet
Set-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy
[-ResourceId] <String>
[-RetentionDays] <Int32>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Set-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy cmdlet sets the short term retention policy for this database. The policy is the retention period, in days, for point-in-time restore backups.
Examples
Example 1
Set-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy -ResourceGroupName resourcegroup01 -InstanceName server01 -DatabaseName database01 -RetentionDays 35
ResourceGroupName : resourcegroup01
InstanceName : instance01
DatabaseName : database01
DeletionDate :
RetentionDays : 35
This command sets the short term retention policy for database01 to 35 days.
Example 2
Get-AzSqlInstanceDatabase -ResourceGroupName resourcegroup01 -InstanceName server01 -Name database01 | Set-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy -RetentionDays 35
ResourceGroupName : resourcegroup01
InstanceName : instance01
DatabaseName : database01
DeletionDate :
RetentionDays : 35
This command sets the short term retention policy for database01 to 35 days via piping in a database object.
Example 3
Get-AzSqlDeletedInstanceDatabaseBackup -ResourceGroupName "ContosoResourceGroup" -InstanceName "ContosoServer" -DatabaseName "DB1" | Set-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy -RetentionDays 8
ResourceGroupName : resourcegroup01
InstanceName : instance01
DatabaseName : database01
DeletionDate : 2019-03-03 12:00:17 AM
RetentionDays : 8
ResourceGroupName : resourcegroup01
InstanceName : instance01
DatabaseName : database01
DeletionDate : 2019-03-02 11:00:16 PM
RetentionDays : 8
This command sets the short term retention policy for all deleted databases named DB1 via piping in a deleted database object. Note you can only reduce retention period on deleted databases.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
-DatabaseName
The name of the Azure SQL Instance Database to retrieve backups for.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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
-DeletionDate
The deletion date of the Azure SQL Instance Database to retrieve backups for, with millisecond precision (e.g. 2016-02-23T00:21:22.847Z)
Parameter properties
| Type: | |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-InputObject
The live or deleted database object to get/set the policy for.
Parameter properties
| Type: | AzureSqlManagedDatabaseBaseModel |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzureSqlInstanceDatabase, AzureInstanceDatabaseObject |
Parameter sets
-InstanceName
The name of the Azure SQL Managed Instance the database is in.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ResourceGroupName
The name of the resource group.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ResourceId
The short term retention policy resource Id.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-RetentionDays
Days of backup retention.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
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
AzureSqlManagedDatabaseBaseModel
String
Outputs
AzureSqlManagedDatabaseBackupShortTermRetentionPolicyModel
Azure PowerShell
Feedback
Was this page helpful?