replication_policies

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

Overview

Name	replication_policies
Type	Resource
Id	azure.recovery_services_site_recovery.replication_policies

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource Id
name	string	Resource Name
location	string	Resource Location
properties	object	The custom data.
type	string	Resource Type

list

Name	Datatype	Description
id	string	Resource Id
name	string	Resource Name
location	string	Resource Location
properties	object	The custom data.
type	string	Resource Type

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceName, resourceGroupName, subscriptionId, policyName	api-version	Gets the details of a replication policy.
list	select	resourceName, resourceGroupName, subscriptionId	api-version	Lists the replication policies for a vault.
create	insert	resourceName, resourceGroupName, subscriptionId, policyName	api-version	The operation to create a replication policy.
update	update	resourceName, resourceGroupName, subscriptionId, policyName	api-version	The operation to update a replication policy.
delete	delete	resourceName, resourceGroupName, subscriptionId, policyName	api-version	The operation to delete a replication 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
policyName	string	Replication policy name.
resourceGroupName	string	The name of the resource group where the recovery services vault is present.
resourceName	string	The name of the recovery services vault.
subscriptionId	string	The subscription Id.
api-version	string	Client Api Version.

SELECT examples

get

Gets the details of a replication policy.

SELECT
id,
name,
location,
properties,
type
FROM azure.recovery_services_site_recovery.replication_policies
WHERE resourceName = '{{ resourceName }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND policyName = '{{ policyName }}' -- required
AND api-version = '{{ api-version }}'
;

list

Lists the replication policies for a vault.

SELECT
id,
name,
location,
properties,
type
FROM azure.recovery_services_site_recovery.replication_policies
WHERE resourceName = '{{ resourceName }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND api-version = '{{ api-version }}'
;

INSERT examples

create

The operation to create a replication policy.

INSERT INTO azure.recovery_services_site_recovery.replication_policies (
data__properties,
resourceName,
resourceGroupName,
subscriptionId,
policyName,
api-version
)
SELECT 
'{{ properties }}',
'{{ resourceName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ policyName }}',
'{{ api-version }}'
RETURNING
id,
name,
location,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: replication_policies
  props:
    - name: resourceName
      value: string
      description: Required parameter for the replication_policies resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the replication_policies resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the replication_policies resource.
    - name: policyName
      value: string
      description: Required parameter for the replication_policies resource.
    - name: properties
      value: object
      description: |
        Policy creation properties.
    - name: api-version
      value: string
      description: Client Api Version.

UPDATE examples

update

The operation to update a replication policy.

UPDATE azure.recovery_services_site_recovery.replication_policies
SET 
data__properties = '{{ properties }}'
WHERE 
resourceName = '{{ resourceName }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND policyName = '{{ policyName }}' --required
AND api-version = '{{ api-version}}'
RETURNING
id,
name,
location,
properties,
type;

DELETE examples

delete

The operation to delete a replication policy.

DELETE FROM azure.recovery_services_site_recovery.replication_policies
WHERE resourceName = '{{ resourceName }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND policyName = '{{ policyName }}' --required
AND api-version = '{{ api-version }}'
;