az sql db ltr-policy

Manage SQL database long term retention policy.

Commands

Name	Description	Type	Status
az sql db ltr-policy set	Update long term retention settings for a database.	Core	GA
az sql db ltr-policy show	Show the long term retention policy for a database.	Core	GA

az sql db ltr-policy set

Edit

Update long term retention settings for a database.

az sql db ltr-policy set [--ids]
                         [--make-backups-immutable --tb-immutability]
                         [--monthly-retention]
                         [--name]
                         [--resource-group]
                         [--server]
                         [--subscription]
                         [--tb-immutability-mode]
                         [--week-of-year]
                         [--weekly-retention]
                         [--yearly-retention]
                         [--yes]

Examples

Set long term retention for a database.

az sql db ltr-policy set -g mygroup -s myserver -n mydb --weekly-retention "P1W" --monthly-retention "P6M" --yearly-retention "P1Y" --week-of-year 26 --make-backups-immutable Enabled

Set long term retention for a database with time based immutability enabled and immutability mode locked.

az sql db ltr-policy set -g mygroup -s myserver -n mydb --weekly-retention "P0W" --monthly-retention "P0M" --yearly-retention "P0Y" --tb-immutability Enabled --tb-immutability-mode Locked

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--make-backups-immutable --tb-immutability

Preview

Whether to enable time based immutability on the LTR backups. Possible values are: 'True', 'False', 'Enabled', 'Disabled'.

--monthly-retention

Retention for the monthly backup. If just a number is passed instead of an ISO 8601 string, days will be assumed as the units.There is a minimum of 7 days and a maximum of 10 years.

--name -n

Name of the Azure SQL Database.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--server -s

Name of the Azure SQL Server. You can configure the default using az configure --defaults sql-server=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

--tb-immutability-mode

Preview

The mode of time based immutability to be set on the LTR backups. Possible values are: 'Locked', 'Unlocked'. This is only valid if make-backups-immutable is enabled.

--week-of-year

The Week of Year, 1 to 52, in which to take the yearly LTR backup.

--weekly-retention

Retention for the weekly backup. If just a number is passed instead of an ISO 8601 string, days will be assumed as the units.There is a minimum of 7 days and a maximum of 10 years.

--yearly-retention

Retention for the yearly backup. If just a number is passed instead of an ISO 8601 string, days will be assumed as the units.There is a minimum of 7 days and a maximum of 10 years.

--yes -y

Do not prompt for confirmation.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False