protection_policies

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

Overview

Name	protection_policies
Type	Resource
Id	azure.recovery_services_backup.protection_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
properties	object	ProtectionPolicyResource properties
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	vaultName, resourceGroupName, subscriptionId, policyName	api-version	Provides the details of the backup policies associated to Recovery Services Vault. This is an asynchronous operation. Status of the operation can be fetched using GetPolicyOperationResult API.
create_or_update	insert	vaultName, resourceGroupName, subscriptionId, policyName	api-version, x-ms-authorization-auxiliary	Creates or modifies a backup policy. This is an asynchronous operation. Status of the operation can be fetched using GetPolicyOperationResult API.
delete	delete	vaultName, resourceGroupName, subscriptionId, policyName	api-version	Deletes specified backup policy from your Recovery Services Vault. This is an asynchronous operation. Status of the operation can be fetched using GetProtectionPolicyOperationResult API.

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
policyName	string	Backup policy to be deleted.
resourceGroupName	string	The name of the resource group where the recovery services vault is present.
subscriptionId	string	The subscription Id.
vaultName	string	The name of the recovery services vault.
api-version	string	Client Api Version.
x-ms-authorization-auxiliary	string

SELECT examples

get

Provides the details of the backup policies associated to Recovery Services Vault. This is an asynchronous
operation. Status of the operation can be fetched using GetPolicyOperationResult API.

SELECT
id,
name,
properties,
type
FROM azure.recovery_services_backup.protection_policies
WHERE vaultName = '{{ vaultName }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND policyName = '{{ policyName }}' -- required
AND api-version = '{{ api-version }}'
;

INSERT examples

create_or_update

Creates or modifies a backup policy. This is an asynchronous operation. Status of the operation can be fetched
using GetPolicyOperationResult API.

INSERT INTO azure.recovery_services_backup.protection_policies (
data__properties,
vaultName,
resourceGroupName,
subscriptionId,
policyName,
api-version,
x-ms-authorization-auxiliary
)
SELECT 
'{{ properties }}',
'{{ vaultName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ policyName }}',
'{{ api-version }}',
'{{ x-ms-authorization-auxiliary }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: protection_policies
  props:
    - name: vaultName
      value: string
      description: Required parameter for the protection_policies resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the protection_policies resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the protection_policies resource.
    - name: policyName
      value: string
      description: Required parameter for the protection_policies resource.
    - name: properties
      value: object
      description: |
        ProtectionPolicyResource properties
    - name: api-version
      value: string
      description: Client Api Version.
    - name: x-ms-authorization-auxiliary
      value: string

DELETE examples

delete

Deletes specified backup policy from your Recovery Services Vault. This is an asynchronous operation. Status of the
operation can be fetched using GetProtectionPolicyOperationResult API.

DELETE FROM azure.recovery_services_backup.protection_policies
WHERE vaultName = '{{ vaultName }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND policyName = '{{ policyName }}' --required
AND api-version = '{{ api-version }}'
;