long_term_retention_policies

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

Overview

Name	long_term_retention_policies
Type	Resource
Id	azure.sql.long_term_retention_policies

Fields

The following fields are returned by SELECT queries:

get

Successfully get the policy.

Name	Datatype	Description
properties	object	Resource properties.

list_by_database

Successfully get the policy.

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, serverName, databaseName, policyName, subscriptionId		Gets a database's long term retention policy.
list_by_database	select	resourceGroupName, serverName, databaseName, subscriptionId		Gets a database's long term retention policy.
create_or_update	insert	resourceGroupName, serverName, databaseName, policyName, subscriptionId		Set or update a 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.
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.
serverName	string	The name of the server.
subscriptionId	string	The subscription ID that identifies an Azure subscription.

SELECT examples

get

Gets a database's long term retention policy.

SELECT
properties
FROM azure.sql.long_term_retention_policies
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- 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.long_term_retention_policies
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND databaseName = '{{ databaseName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Set or update a database's long term retention policy.

INSERT INTO azure.sql.long_term_retention_policies (
data__properties,
resourceGroupName,
serverName,
databaseName,
policyName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serverName }}',
'{{ databaseName }}',
'{{ policyName }}',
'{{ subscriptionId }}'
RETURNING
properties
;

Manifest

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