backup_short_term_retention_policies

Creates, updates, deletes, gets or lists a backup_short_term_retention_policies resource.

Overview

Name	backup_short_term_retention_policies
Type	Resource
Id	azure.sql.backup_short_term_retention_policies

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
diffBackupIntervalInHours	object	The differential backup interval in hours. This is how many interval hours between each differential backup will be supported. This is only applicable to live databases but not dropped databases. Known values are: 12 and 24.
retentionDays	integer	The backup retention period in days. This is how many days Point-in-Time Restore will be supported.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_database

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
diffBackupIntervalInHours	object	The differential backup interval in hours. This is how many interval hours between each differential backup will be supported. This is only applicable to live databases but not dropped databases. Known values are: 12 and 24.
retentionDays	integer	The backup retention period in days. This is how many days Point-in-Time Restore will be supported.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, server_name, database_name, policy_name, subscription_id		Gets a database's short term retention policy.
list_by_database	select	resource_group_name, server_name, database_name, subscription_id		Gets a database's short term retention policy.
create_or_update	insert	resource_group_name, server_name, database_name, policy_name, subscription_id		Updates a database's short term retention policy.
update	update	resource_group_name, server_name, database_name, policy_name, subscription_id		Updates a database's short term retention policy.
create_or_update	replace	resource_group_name, server_name, database_name, policy_name, subscription_id		Updates a database's short term retention policy.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
database_name	string	The name of the database. Required.
policy_name	string	The policy name. Should always be default. "default" Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
server_name	string	The name of the server. Required.
subscription_id	string

SELECT examples

get

Gets a database's short term retention policy.

SELECT
id,
name,
diffBackupIntervalInHours,
retentionDays,
systemData,
type
FROM azure.sql.backup_short_term_retention_policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND database_name = '{{ database_name }}' -- required
AND policy_name = '{{ policy_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_database

Gets a database's short term retention policy.

SELECT
id,
name,
diffBackupIntervalInHours,
retentionDays,
systemData,
type
FROM azure.sql.backup_short_term_retention_policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND database_name = '{{ database_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Updates a database's short term retention policy.

INSERT INTO azure.sql.backup_short_term_retention_policies (
properties,
resource_group_name,
server_name,
database_name,
policy_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ server_name }}',
'{{ database_name }}',
'{{ policy_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: backup_short_term_retention_policies
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the backup_short_term_retention_policies resource.
  - name: server_name
    value: "{{ server_name }}"
    description: Required parameter for the backup_short_term_retention_policies resource.
  - name: database_name
    value: "{{ database_name }}"
    description: Required parameter for the backup_short_term_retention_policies resource.
  - name: policy_name
    value: "{{ policy_name }}"
    description: Required parameter for the backup_short_term_retention_policies resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the backup_short_term_retention_policies resource.
  - name: properties
    description: |
      Resource properties.
    value:
      retentionDays: {{ retentionDays }}
      diffBackupIntervalInHours: "{{ diffBackupIntervalInHours }}"

UPDATE examples

update

Updates a database's short term retention policy.

UPDATE azure.sql.backup_short_term_retention_policies
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND server_name = '{{ server_name }}' --required
AND database_name = '{{ database_name }}' --required
AND policy_name = '{{ policy_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update

Updates a database's short term retention policy.

REPLACE azure.sql.backup_short_term_retention_policies
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND server_name = '{{ server_name }}' --required
AND database_name = '{{ database_name }}' --required
AND policy_name = '{{ policy_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;