elastic_snapshots

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

Overview

Name	elastic_snapshots
Type	Resource
Id	azure.netapp.elastic_snapshots

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.
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.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_elastic_volume

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.
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.
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, account_name, pool_name, volume_name, snapshot_name, subscription_id		Get a ElasticSnapshot.
list_by_elastic_volume	select	resource_group_name, account_name, pool_name, volume_name, subscription_id		List ElasticSnapshot resources by ElasticVolume.
create_or_update	insert	resource_group_name, account_name, pool_name, volume_name, snapshot_name, subscription_id		Create a ElasticSnapshot.
create_or_update	replace	resource_group_name, account_name, pool_name, volume_name, snapshot_name, subscription_id		Create a ElasticSnapshot.
delete	delete	resource_group_name, account_name, pool_name, volume_name, snapshot_name, subscription_id		Delete a ElasticSnapshot.

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.
pool_name	string	The name of the ElasticCapacityPool. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
snapshot_name	string	The name of the ElasticSnapshot. Required.
subscription_id	string
volume_name	string	The name of the ElasticVolume. Required.

SELECT examples

get

Get a ElasticSnapshot.

SELECT
id,
name,
provisioningState,
systemData,
type
FROM azure.netapp.elastic_snapshots
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND pool_name = '{{ pool_name }}' -- required
AND volume_name = '{{ volume_name }}' -- required
AND snapshot_name = '{{ snapshot_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_elastic_volume

List ElasticSnapshot resources by ElasticVolume.

SELECT
id,
name,
provisioningState,
systemData,
type
FROM azure.netapp.elastic_snapshots
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND pool_name = '{{ pool_name }}' -- required
AND volume_name = '{{ volume_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a ElasticSnapshot.

INSERT INTO azure.netapp.elastic_snapshots (
properties,
resource_group_name,
account_name,
pool_name,
volume_name,
snapshot_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ pool_name }}',
'{{ volume_name }}',
'{{ snapshot_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: elastic_snapshots
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the elastic_snapshots resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the elastic_snapshots resource.
  - name: pool_name
    value: "{{ pool_name }}"
    description: Required parameter for the elastic_snapshots resource.
  - name: volume_name
    value: "{{ volume_name }}"
    description: Required parameter for the elastic_snapshots resource.
  - name: snapshot_name
    value: "{{ snapshot_name }}"
    description: Required parameter for the elastic_snapshots resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the elastic_snapshots resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      provisioningState: "{{ provisioningState }}"

REPLACE examples

create_or_update

Create a ElasticSnapshot.

REPLACE azure.netapp.elastic_snapshots
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND pool_name = '{{ pool_name }}' --required
AND volume_name = '{{ volume_name }}' --required
AND snapshot_name = '{{ snapshot_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a ElasticSnapshot.

DELETE FROM azure.netapp.elastic_snapshots
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND pool_name = '{{ pool_name }}' --required
AND volume_name = '{{ volume_name }}' --required
AND snapshot_name = '{{ snapshot_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;