policy

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

Overview

Name	policy
Type	Resource
Id	azure.recovery_services_data_replication.policy

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.
customProperties	object	Policy model custom properties. Required.
provisioningState	string	Gets or sets the provisioning state of the policy. Known values are: "Canceled", "Creating", "Deleting", "Deleted", "Failed", "Succeeded", and "Updating". (Canceled, Creating, Deleting, Deleted, Failed, Succeeded, Updating)
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.
customProperties	object	Policy model custom properties. Required.
provisioningState	string	Gets or sets the provisioning state of the policy. Known values are: "Canceled", "Creating", "Deleting", "Deleted", "Failed", "Succeeded", and "Updating". (Canceled, Creating, Deleting, Deleted, Failed, Succeeded, Updating)
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, vault_name, policy_name, subscription_id		Gets the details of the policy.
list	select	resource_group_name, vault_name, subscription_id		Gets the list of policies in the given vault.
create	insert	resource_group_name, vault_name, policy_name, subscription_id		Creates the policy.
delete	delete	resource_group_name, vault_name, policy_name, subscription_id		Removes the 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	The policy name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
vault_name	string	The vault name. Required.

SELECT examples

get

Gets the details of the policy.

SELECT
id,
name,
customProperties,
provisioningState,
systemData,
type
FROM azure.recovery_services_data_replication.policy
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND vault_name = '{{ vault_name }}' -- required
AND policy_name = '{{ policy_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets the list of policies in the given vault.

SELECT
id,
name,
customProperties,
provisioningState,
systemData,
type
FROM azure.recovery_services_data_replication.policy
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND vault_name = '{{ vault_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates the policy.

INSERT INTO azure.recovery_services_data_replication.policy (
properties,
resource_group_name,
vault_name,
policy_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ vault_name }}',
'{{ policy_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: policy
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the policy resource.
  - name: vault_name
    value: "{{ vault_name }}"
    description: Required parameter for the policy resource.
  - name: policy_name
    value: "{{ policy_name }}"
    description: Required parameter for the policy resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the policy resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      provisioningState: "{{ provisioningState }}"
      customProperties:
        instanceType: "{{ instanceType }}"

DELETE examples

delete

Removes the policy.

DELETE FROM azure.recovery_services_data_replication.policy
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND vault_name = '{{ vault_name }}' --required
AND policy_name = '{{ policy_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;