snapshot_policies

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

Overview

Name	snapshot_policies
Type	Resource
Id	azure.netapp.snapshot_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.
dailySchedule	object	Schedule for daily snapshots.
enabled	boolean	The property to decide policy is enabled or not.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
hourlySchedule	object	Schedule for hourly snapshots.
location	string	The geo-location where the resource lives. Required.
monthlySchedule	object	Schedule for monthly snapshots.
provisioningState	string	Azure lifecycle management.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
weeklySchedule	object	Schedule for weekly snapshots.

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.
dailySchedule	object	Schedule for daily snapshots.
enabled	boolean	The property to decide policy is enabled or not.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
hourlySchedule	object	Schedule for hourly snapshots.
location	string	The geo-location where the resource lives. Required.
monthlySchedule	object	Schedule for monthly snapshots.
provisioningState	string	Azure lifecycle management.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
weeklySchedule	object	Schedule for weekly snapshots.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, account_name, snapshot_policy_name, subscription_id		Get a snapshot Policy.
list	select	resource_group_name, account_name, subscription_id		List snapshot policy.
create	insert	resource_group_name, account_name, snapshot_policy_name, subscription_id, location, properties		Create a snapshot policy.
update	update	resource_group_name, account_name, snapshot_policy_name, subscription_id		Patch a snapshot policy.
delete	delete	resource_group_name, account_name, snapshot_policy_name, subscription_id		Delete snapshot policy.
list_volumes	exec	resource_group_name, account_name, snapshot_policy_name, subscription_id		Get volumes associated with snapshot 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
account_name	string	The name of the NetApp account. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
snapshot_policy_name	string	The name of the snapshot policy. Required.
subscription_id	string

SELECT examples

get

Get a snapshot Policy.

SELECT
id,
name,
dailySchedule,
enabled,
etag,
hourlySchedule,
location,
monthlySchedule,
provisioningState,
systemData,
tags,
type,
weeklySchedule
FROM azure.netapp.snapshot_policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND snapshot_policy_name = '{{ snapshot_policy_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List snapshot policy.

SELECT
id,
name,
dailySchedule,
enabled,
etag,
hourlySchedule,
location,
monthlySchedule,
provisioningState,
systemData,
tags,
type,
weeklySchedule
FROM azure.netapp.snapshot_policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Create a snapshot policy.

INSERT INTO azure.netapp.snapshot_policies (
tags,
location,
properties,
resource_group_name,
account_name,
snapshot_policy_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ snapshot_policy_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: snapshot_policies
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the snapshot_policies resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the snapshot_policies resource.
  - name: snapshot_policy_name
    value: "{{ snapshot_policy_name }}"
    description: Required parameter for the snapshot_policies resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the snapshot_policies resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Snapshot policy Properties. Required.
    value:
      hourlySchedule:
        snapshotsToKeep: {{ snapshotsToKeep }}
        minute: {{ minute }}
        usedBytes: {{ usedBytes }}
      dailySchedule:
        snapshotsToKeep: {{ snapshotsToKeep }}
        hour: {{ hour }}
        minute: {{ minute }}
        usedBytes: {{ usedBytes }}
      weeklySchedule:
        snapshotsToKeep: {{ snapshotsToKeep }}
        day: "{{ day }}"
        hour: {{ hour }}
        minute: {{ minute }}
        usedBytes: {{ usedBytes }}
      monthlySchedule:
        snapshotsToKeep: {{ snapshotsToKeep }}
        daysOfMonth: "{{ daysOfMonth }}"
        hour: {{ hour }}
        minute: {{ minute }}
        usedBytes: {{ usedBytes }}
      enabled: {{ enabled }}
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

Patch a snapshot policy.

UPDATE azure.netapp.snapshot_policies
SET 
location = '{{ location }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND snapshot_policy_name = '{{ snapshot_policy_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete snapshot policy.

DELETE FROM azure.netapp.snapshot_policies
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND snapshot_policy_name = '{{ snapshot_policy_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_volumes

Get volumes associated with snapshot policy.

EXEC azure.netapp.snapshot_policies.list_volumes 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@snapshot_policy_name='{{ snapshot_policy_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;