elastic_backups

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

Overview

Name	elastic_backups
Type	Resource
Id	azure.netapp.elastic_backups

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.
backupType	string	Type of backup Manual or Scheduled. Known values are: "Manual" and "Scheduled". (Manual, Scheduled)
completionDate	string (date-time)	The completion date of the backup.
creationDate	string (date-time)	The creation date of the backup.
elasticBackupPolicyResourceId	string	ResourceId used to identify the elastic backup policy.
elasticSnapshotResourceId	string	ResourceId used to identify the elastic snapshot resource. This is required when an existing snapshot needs to be used for creating a manual backup.
elasticVolumeResourceId	string	ResourceId used to identify the Elastic Volume. Required.
failureReason	string	Failure reason.
label	string	Label for backup.
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)
size	integer	Size of backup in bytes.
snapshotCreationDate	string (date-time)	The snapshot creation date of the backup.
snapshotUsage	string	Manual backup using an already existing snapshot. This will always be CreateNewSnapshot for scheduled backups and UseExistingSnapshot/CreateNewSnapshot for manual backups. Known values are: "UseExistingSnapshot" and "CreateNewSnapshot". (UseExistingSnapshot, CreateNewSnapshot)
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".
volumeSize	string	Specifies if the backup is for a large volume. Known values are: "Large" and "Regular". (Large, Regular)

list_by_vault

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.
backupType	string	Type of backup Manual or Scheduled. Known values are: "Manual" and "Scheduled". (Manual, Scheduled)
completionDate	string (date-time)	The completion date of the backup.
creationDate	string (date-time)	The creation date of the backup.
elasticBackupPolicyResourceId	string	ResourceId used to identify the elastic backup policy.
elasticSnapshotResourceId	string	ResourceId used to identify the elastic snapshot resource. This is required when an existing snapshot needs to be used for creating a manual backup.
elasticVolumeResourceId	string	ResourceId used to identify the Elastic Volume. Required.
failureReason	string	Failure reason.
label	string	Label for backup.
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)
size	integer	Size of backup in bytes.
snapshotCreationDate	string (date-time)	The snapshot creation date of the backup.
snapshotUsage	string	Manual backup using an already existing snapshot. This will always be CreateNewSnapshot for scheduled backups and UseExistingSnapshot/CreateNewSnapshot for manual backups. Known values are: "UseExistingSnapshot" and "CreateNewSnapshot". (UseExistingSnapshot, CreateNewSnapshot)
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".
volumeSize	string	Specifies if the backup is for a large volume. Known values are: "Large" and "Regular". (Large, Regular)

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_vault_name, backup_name, subscription_id		Get the specified Elastic Backup under Elastic Backup Vault.
list_by_vault	select	resource_group_name, account_name, backup_vault_name, subscription_id		List all elastic backups Under an elastic Backup Vault.
create_or_update	insert	resource_group_name, account_name, backup_vault_name, backup_name, subscription_id		Create an elastic backup under the elastic Backup Vault.
update	update	resource_group_name, account_name, backup_vault_name, backup_name, subscription_id		Patch an elastic Backup under the Elastic Backup Vault.
create_or_update	replace	resource_group_name, account_name, backup_vault_name, backup_name, subscription_id		Create an elastic backup under the elastic Backup Vault.
delete	delete	resource_group_name, account_name, backup_vault_name, backup_name, subscription_id		Delete a ElasticBackup.

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_name	string	The name of the ElasticBackup. Required.
backup_vault_name	string	The name of the ElasticBackupVault. 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 specified Elastic Backup under Elastic Backup Vault.

SELECT
id,
name,
backupType,
completionDate,
creationDate,
elasticBackupPolicyResourceId,
elasticSnapshotResourceId,
elasticVolumeResourceId,
failureReason,
label,
provisioningState,
size,
snapshotCreationDate,
snapshotUsage,
systemData,
type,
volumeSize
FROM azure.netapp.elastic_backups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND backup_vault_name = '{{ backup_vault_name }}' -- required
AND backup_name = '{{ backup_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_vault

List all elastic backups Under an elastic Backup Vault.

SELECT
id,
name,
backupType,
completionDate,
creationDate,
elasticBackupPolicyResourceId,
elasticSnapshotResourceId,
elasticVolumeResourceId,
failureReason,
label,
provisioningState,
size,
snapshotCreationDate,
snapshotUsage,
systemData,
type,
volumeSize
FROM azure.netapp.elastic_backups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND backup_vault_name = '{{ backup_vault_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create an elastic backup under the elastic Backup Vault.

INSERT INTO azure.netapp.elastic_backups (
properties,
resource_group_name,
account_name,
backup_vault_name,
backup_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ backup_vault_name }}',
'{{ backup_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: elastic_backups
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the elastic_backups resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the elastic_backups resource.
  - name: backup_vault_name
    value: "{{ backup_vault_name }}"
    description: Required parameter for the elastic_backups resource.
  - name: backup_name
    value: "{{ backup_name }}"
    description: Required parameter for the elastic_backups resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the elastic_backups resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      creationDate: "{{ creationDate }}"
      snapshotCreationDate: "{{ snapshotCreationDate }}"
      completionDate: "{{ completionDate }}"
      provisioningState: "{{ provisioningState }}"
      size: {{ size }}
      label: "{{ label }}"
      backupType: "{{ backupType }}"
      failureReason: "{{ failureReason }}"
      elasticVolumeResourceId: "{{ elasticVolumeResourceId }}"
      snapshotUsage: "{{ snapshotUsage }}"
      elasticSnapshotResourceId: "{{ elasticSnapshotResourceId }}"
      elasticBackupPolicyResourceId: "{{ elasticBackupPolicyResourceId }}"
      volumeSize: "{{ volumeSize }}"

UPDATE examples

update

Patch an elastic Backup under the Elastic Backup Vault.

UPDATE azure.netapp.elastic_backups
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND backup_vault_name = '{{ backup_vault_name }}' --required
AND backup_name = '{{ backup_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update

Create an elastic backup under the elastic Backup Vault.

REPLACE azure.netapp.elastic_backups
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND backup_vault_name = '{{ backup_vault_name }}' --required
AND backup_name = '{{ backup_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a ElasticBackup.

DELETE FROM azure.netapp.elastic_backups
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND backup_vault_name = '{{ backup_vault_name }}' --required
AND backup_name = '{{ backup_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;