backup_policies

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

Overview

Name	backup_policies
Type	Resource
Id	azure.data_protection.backup_policies

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource Id represents the complete path to the resource.
name	string	Resource name associated with the resource.
properties	object	BaseBackupPolicyResource properties (title: BaseBackupPolicy)
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...

list

Name	Datatype	Description
id	string	Resource Id represents the complete path to the resource.
name	string	Resource name associated with the resource.
properties	object	BaseBackupPolicyResource properties (title: BaseBackupPolicy)
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, vaultName, backupPolicyName		Gets a backup policy belonging to a backup vault
list	select	subscriptionId, resourceGroupName, vaultName		Returns list of backup policies belonging to a backup vault
create_or_update	insert	subscriptionId, resourceGroupName, vaultName, backupPolicyName
delete	delete	subscriptionId, resourceGroupName, vaultName, backupPolicyName

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
backupPolicyName	string
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
vaultName	string	The name of the backup vault.

SELECT examples

get

Gets a backup policy belonging to a backup vault

SELECT
id,
name,
properties,
systemData,
type
FROM azure.data_protection.backup_policies
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND vaultName = '{{ vaultName }}' -- required
AND backupPolicyName = '{{ backupPolicyName }}' -- required
;

list

Returns list of backup policies belonging to a backup vault

SELECT
id,
name,
properties,
systemData,
type
FROM azure.data_protection.backup_policies
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND vaultName = '{{ vaultName }}' -- required
;

INSERT examples

create_or_update

No description available.

INSERT INTO azure.data_protection.backup_policies (
data__properties,
subscriptionId,
resourceGroupName,
vaultName,
backupPolicyName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ vaultName }}',
'{{ backupPolicyName }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: backup_policies
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the backup_policies resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the backup_policies resource.
    - name: vaultName
      value: string
      description: Required parameter for the backup_policies resource.
    - name: backupPolicyName
      value: string
      description: Required parameter for the backup_policies resource.
    - name: properties
      value: object
      description: |
        BaseBackupPolicyResource properties

DELETE examples

delete

No description available.

DELETE FROM azure.data_protection.backup_policies
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND vaultName = '{{ vaultName }}' --required
AND backupPolicyName = '{{ backupPolicyName }}' --required
;