managed_restorable_dropped_database_backup_short_term_retention_policies

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

Overview

Name	managed_restorable_dropped_database_backup_short_term_retention_policies
Type	Resource
Id	azure.sql.managed_restorable_dropped_database_backup_short_term_retention_policies

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the policies.

Name	Datatype	Description
properties	object	Resource properties.

list_by_restorable_dropped_database

Successfully retrieved the policies.

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, restorableDroppedDatabaseId, policyName, subscriptionId		Gets a dropped database's short term retention policy.
list_by_restorable_dropped_database	select	resourceGroupName, managedInstanceName, restorableDroppedDatabaseId, subscriptionId		Gets a dropped database's short term retention policy list.
create_or_update	insert	resourceGroupName, managedInstanceName, restorableDroppedDatabaseId, policyName, subscriptionId		Sets a database's short term retention policy.
update	update	resourceGroupName, managedInstanceName, restorableDroppedDatabaseId, policyName, subscriptionId		Sets 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
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.
restorableDroppedDatabaseId	string
subscriptionId	string	The subscription ID that identifies an Azure subscription.

SELECT examples

get

Gets a dropped database's short term retention policy.

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

list_by_restorable_dropped_database

Gets a dropped database's short term retention policy list.

SELECT
properties
FROM azure.sql.managed_restorable_dropped_database_backup_short_term_retention_policies
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND managedInstanceName = '{{ managedInstanceName }}' -- required
AND restorableDroppedDatabaseId = '{{ restorableDroppedDatabaseId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Sets a database's short term retention policy.

INSERT INTO azure.sql.managed_restorable_dropped_database_backup_short_term_retention_policies (
data__properties,
resourceGroupName,
managedInstanceName,
restorableDroppedDatabaseId,
policyName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ managedInstanceName }}',
'{{ restorableDroppedDatabaseId }}',
'{{ policyName }}',
'{{ subscriptionId }}'
RETURNING
properties
;

Manifest

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

UPDATE examples

update

Sets a database's short term retention policy.

UPDATE azure.sql.managed_restorable_dropped_database_backup_short_term_retention_policies
SET 
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND managedInstanceName = '{{ managedInstanceName }}' --required
AND restorableDroppedDatabaseId = '{{ restorableDroppedDatabaseId }}' --required
AND policyName = '{{ policyName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
properties;