elastic_backup_policies

Creates, updates, deletes, gets or lists an elastic_backup_policies resource.

Overview

Name	elastic_backup_policies
Type	Resource
Id	azure.netapp.elastic_backup_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.
assignedVolumesCount	integer	The number of volumes currently using this Backup Policy.
dailyBackupsToKeep	integer	Daily backups count to keep.
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.
location	string	The geo-location where the resource lives. Required.
monthlyBackupsToKeep	integer	Monthly backups count to keep.
policyState	string	The property to identify whether Backup Policy is enabled or not. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
provisioningState	string	Azure lifecycle management. Known values are: "Accepted", "Creating", "Patching", "Updating", "Deleting", "Moving", "Failed", and "Succeeded". (Accepted, Creating, Patching, Updating, Deleting, Moving, Failed, Succeeded)
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".
weeklyBackupsToKeep	integer	Weekly backups count to keep.

list_by_elastic_account

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.
assignedVolumesCount	integer	The number of volumes currently using this Backup Policy.
dailyBackupsToKeep	integer	Daily backups count to keep.
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.
location	string	The geo-location where the resource lives. Required.
monthlyBackupsToKeep	integer	Monthly backups count to keep.
policyState	string	The property to identify whether Backup Policy is enabled or not. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
provisioningState	string	Azure lifecycle management. Known values are: "Accepted", "Creating", "Patching", "Updating", "Deleting", "Moving", "Failed", and "Succeeded". (Accepted, Creating, Patching, Updating, Deleting, Moving, Failed, Succeeded)
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".
weeklyBackupsToKeep	integer	Weekly backups count to keep.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, account_name, backup_policy_name, subscription_id		Get the Elastic Backup Policy.
list_by_elastic_account	select	resource_group_name, account_name, subscription_id		List and describe all Elastic Backup Policies in the elastic account.
create_or_update	insert	resource_group_name, account_name, backup_policy_name, subscription_id, location		Create or update the specified Elastic Backup Policy in the NetApp account.
update	update	resource_group_name, account_name, backup_policy_name, subscription_id		Patch the specified NetApp Elastic Backup Policy.
create_or_update	replace	resource_group_name, account_name, backup_policy_name, subscription_id, location		Create or update the specified Elastic Backup Policy in the NetApp account.
delete	delete	resource_group_name, account_name, backup_policy_name, subscription_id		Delete the specified Elastic 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 ElasticAccount. Required.
backup_policy_name	string	The name of the ElasticBackupPolicy. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get the Elastic Backup Policy.

SELECT
id,
name,
assignedVolumesCount,
dailyBackupsToKeep,
eTag,
location,
monthlyBackupsToKeep,
policyState,
provisioningState,
systemData,
tags,
type,
weeklyBackupsToKeep
FROM azure.netapp.elastic_backup_policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND backup_policy_name = '{{ backup_policy_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_elastic_account

List and describe all Elastic Backup Policies in the elastic account.

SELECT
id,
name,
assignedVolumesCount,
dailyBackupsToKeep,
eTag,
location,
monthlyBackupsToKeep,
policyState,
provisioningState,
systemData,
tags,
type,
weeklyBackupsToKeep
FROM azure.netapp.elastic_backup_policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update the specified Elastic Backup Policy in the NetApp account.

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

Manifest

# Description fields are for documentation purposes
- name: elastic_backup_policies
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the elastic_backup_policies resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the elastic_backup_policies resource.
  - name: backup_policy_name
    value: "{{ backup_policy_name }}"
    description: Required parameter for the elastic_backup_policies resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the elastic_backup_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: |
      The resource-specific properties for this resource.
    value:
      provisioningState: "{{ provisioningState }}"
      dailyBackupsToKeep: {{ dailyBackupsToKeep }}
      weeklyBackupsToKeep: {{ weeklyBackupsToKeep }}
      monthlyBackupsToKeep: {{ monthlyBackupsToKeep }}
      assignedVolumesCount: {{ assignedVolumesCount }}
      policyState: "{{ policyState }}"

UPDATE examples

update

Patch the specified NetApp Elastic Backup Policy.

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

REPLACE examples

create_or_update

Create or update the specified Elastic Backup Policy in the NetApp account.

REPLACE azure.netapp.elastic_backup_policies
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND backup_policy_name = '{{ backup_policy_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
eTag,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete the specified Elastic Policy.

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