policies

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

Overview

Name	policies
Type	Resource
Id	azure.data_replication.policies

Fields

The following fields are returned by SELECT queries:

get

Returns Policy Model on success.

Name	Datatype	Description
id	string	Gets or sets the Id of the resource.
name	string	Gets or sets the name of the resource.
properties	object	Policy model properties.
systemData	object	System data required to be defined for Azure resources.
type	string	Gets or sets the type of the resource.

list

Returns Policy Model Collection on success.

Name	Datatype	Description
id	string	Gets or sets the Id of the resource.
name	string	Gets or sets the name of the resource.
properties	object	Policy model properties.
systemData	object	System data required to be defined for Azure resources.
type	string	Gets or sets the type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, vaultName, policyName		Gets the details of the policy.
list	select	subscriptionId, resourceGroupName, vaultName		Gets the list of policies in the given vault.
create	insert	subscriptionId, resourceGroupName, vaultName, policyName, data__properties		Creates the policy.
delete	delete	subscriptionId, resourceGroupName, vaultName, policyName		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
policyName	string	The policy name.
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 vault name.

SELECT examples

get

Gets the details of the policy.

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

list

Gets the list of policies in the given vault.

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

INSERT examples

create

Creates the policy.

INSERT INTO azure.data_replication.policies (
data__properties,
subscriptionId,
resourceGroupName,
vaultName,
policyName
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ vaultName }}',
'{{ policyName }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

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

DELETE examples

delete

Removes the policy.

DELETE FROM azure.data_replication.policies
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND vaultName = '{{ vaultName }}' --required
AND policyName = '{{ policyName }}' --required
;