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	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
friendlyName	string	The FriendlyName.
location	string	Resource Location.
providerSpecificDetails	object	The ReplicationChannelSetting.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

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.
friendlyName	string	The FriendlyName.
location	string	Resource Location.
providerSpecificDetails	object	The ReplicationChannelSetting.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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	resource_group_name, resource_name, policy_name, subscription_id		Gets the requested policy. Gets the details of a replication policy.
list	select	resource_group_name, resource_name, subscription_id		Gets the list of replication policies. Lists the replication policies for a vault.
create	insert	resource_group_name, resource_name, policy_name, subscription_id		Creates the policy. The operation to create a replication policy.
update	update	resource_group_name, resource_name, policy_name, subscription_id		Updates the policy. The operation to update a replication policy.
delete	delete	resource_group_name, resource_name, policy_name, subscription_id		Delete the policy. 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
policy_name	string	Replication policy name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
resource_name	string	The name of the Vault. Required.
subscription_id	string

SELECT examples

get

Gets the requested policy. Gets the details of a replication policy.

SELECT
id,
name,
friendlyName,
location,
providerSpecificDetails,
systemData,
type
FROM azure.recovery_services_site_recovery.replication_policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND policy_name = '{{ policy_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets the list of replication policies. Lists the replication policies for a vault.

SELECT
id,
name,
friendlyName,
location,
providerSpecificDetails,
systemData,
type
FROM azure.recovery_services_site_recovery.replication_policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates the policy. The operation to create a replication policy.

INSERT INTO azure.recovery_services_site_recovery.replication_policies (
properties,
resource_group_name,
resource_name,
policy_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ resource_name }}',
'{{ policy_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: replication_policies
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the replication_policies resource.
  - name: resource_name
    value: "{{ resource_name }}"
    description: Required parameter for the replication_policies resource.
  - name: policy_name
    value: "{{ policy_name }}"
    description: Required parameter for the replication_policies resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the replication_policies resource.
  - name: properties
    description: |
      Policy creation properties.
    value:
      providerSpecificInput:
        instanceType: "{{ instanceType }}"

UPDATE examples

update

Updates the policy. The operation to update a replication policy.

UPDATE azure.recovery_services_site_recovery.replication_policies
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND policy_name = '{{ policy_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
type;

DELETE examples

delete

Delete the policy. The operation to delete a replication policy.

DELETE FROM azure.recovery_services_site_recovery.replication_policies
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND policy_name = '{{ policy_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;