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

Successfully got LTR policy for managed database.

Name	Datatype	Description
properties	object	Resource properties.

list_by_database

Successfully got LTR policy for managed database.

Name	Datatype	Description
properties	object	Resource properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, managedInstanceName, databaseName, policyName, subscriptionId		Gets a managed database's long term retention policy.
list_by_database	select	resourceGroupName, managedInstanceName, databaseName, subscriptionId		Gets a database's long term retention policy.
create_or_update	insert	resourceGroupName, managedInstanceName, databaseName, policyName, subscriptionId		Sets 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
databaseName	string	The name of the database.
managedInstanceName	string	The name of the managed instance.
policyName	string	The policy name. Should always be Default.
resourceGroupName	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
subscriptionId	string	The subscription ID that identifies an Azure subscription.

SELECT examples

get

Gets a managed database's long term retention policy.

SELECT
properties
FROM azure.sql.managed_instance_long_term_retention_policies
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND managedInstanceName = '{{ managedInstanceName }}' -- required
AND databaseName = '{{ databaseName }}' -- required
AND policyName = '{{ policyName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_database

Gets a database's long term retention policy.

SELECT
properties
FROM azure.sql.managed_instance_long_term_retention_policies
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND managedInstanceName = '{{ managedInstanceName }}' -- required
AND databaseName = '{{ databaseName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- 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 (
data__properties,
resourceGroupName,
managedInstanceName,
databaseName,
policyName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ managedInstanceName }}',
'{{ databaseName }}',
'{{ policyName }}',
'{{ subscriptionId }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: managed_instance_long_term_retention_policies
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the managed_instance_long_term_retention_policies resource.
    - name: managedInstanceName
      value: string
      description: Required parameter for the managed_instance_long_term_retention_policies resource.
    - name: databaseName
      value: string
      description: Required parameter for the managed_instance_long_term_retention_policies resource.
    - name: policyName
      value: string
      description: Required parameter for the managed_instance_long_term_retention_policies resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the managed_instance_long_term_retention_policies resource.
    - name: properties
      value: object
      description: |
        Resource properties.