managed_instance_long_term_retention_policies

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

Overview

Name	managed_instance_long_term_retention_policies
Type	Resource
Id	azure.sql.managed_instance_long_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.
backupStorageAccessTier	string	The BackupStorageAccessTier for the LTR backups. Known values are: "Hot" and "Archive". (Hot, Archive)
monthlyRetention	string	The monthly retention policy for an LTR backup in an ISO 8601 format.
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".
weekOfYear	integer	The week of year to take the yearly backup in an ISO 8601 format.
weeklyRetention	string	The weekly retention policy for an LTR backup in an ISO 8601 format.
yearlyRetention	string	The yearly retention policy for an LTR backup in an ISO 8601 format.

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.
backupStorageAccessTier	string	The BackupStorageAccessTier for the LTR backups. Known values are: "Hot" and "Archive". (Hot, Archive)
monthlyRetention	string	The monthly retention policy for an LTR backup in an ISO 8601 format.
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".
weekOfYear	integer	The week of year to take the yearly backup in an ISO 8601 format.
weeklyRetention	string	The weekly retention policy for an LTR backup in an ISO 8601 format.
yearlyRetention	string	The yearly retention policy for an LTR backup in an ISO 8601 format.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, managed_instance_name, database_name, policy_name, subscription_id		Gets a managed database's long term retention policy.
list_by_database	select	resource_group_name, managed_instance_name, database_name, subscription_id		Gets a database's long term retention policy.
create_or_update	insert	resource_group_name, managed_instance_name, database_name, policy_name, subscription_id		Sets a managed database's long term retention policy.
create_or_update	replace	resource_group_name, managed_instance_name, database_name, policy_name, subscription_id		Sets a managed database's long term retention policy.
delete	delete	resource_group_name, managed_instance_name, database_name, policy_name, subscription_id		Deletes a managed database's long 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.
managed_instance_name	string	The name of the managed instance. 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.
subscription_id	string

SELECT examples

get

Gets a managed database's long term retention policy.

SELECT
id,
name,
backupStorageAccessTier,
monthlyRetention,
systemData,
type,
weekOfYear,
weeklyRetention,
yearlyRetention
FROM azure.sql.managed_instance_long_term_retention_policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND managed_instance_name = '{{ managed_instance_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 long term retention policy.

SELECT
id,
name,
backupStorageAccessTier,
monthlyRetention,
systemData,
type,
weekOfYear,
weeklyRetention,
yearlyRetention
FROM azure.sql.managed_instance_long_term_retention_policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND managed_instance_name = '{{ managed_instance_name }}' -- required
AND database_name = '{{ database_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Sets a managed database's long term retention policy.

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

Manifest

# Description fields are for documentation purposes
- name: managed_instance_long_term_retention_policies
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the managed_instance_long_term_retention_policies resource.
  - name: managed_instance_name
    value: "{{ managed_instance_name }}"
    description: Required parameter for the managed_instance_long_term_retention_policies resource.
  - name: database_name
    value: "{{ database_name }}"
    description: Required parameter for the managed_instance_long_term_retention_policies resource.
  - name: policy_name
    value: "{{ policy_name }}"
    description: Required parameter for the managed_instance_long_term_retention_policies resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the managed_instance_long_term_retention_policies resource.
  - name: properties
    description: |
      Resource properties.
    value:
      backupStorageAccessTier: "{{ backupStorageAccessTier }}"
      weeklyRetention: "{{ weeklyRetention }}"
      monthlyRetention: "{{ monthlyRetention }}"
      yearlyRetention: "{{ yearlyRetention }}"
      weekOfYear: {{ weekOfYear }}

REPLACE examples

create_or_update

Sets a managed database's long term retention policy.

REPLACE azure.sql.managed_instance_long_term_retention_policies
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND managed_instance_name = '{{ managed_instance_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;

DELETE examples

delete

Deletes a managed database's long term retention policy.

DELETE FROM azure.sql.managed_instance_long_term_retention_policies
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND managed_instance_name = '{{ managed_instance_name }}' --required
AND database_name = '{{ database_name }}' --required
AND policy_name = '{{ policy_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;