snapshots

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

Overview

Name	snapshots
Type	Resource
Id	azure.container_storage.snapshots

Fields

The following fields are returned by SELECT queries:

get

Azure operation completed successfully.

Name	Datatype	Description
properties	object	The resource-specific properties for this resource.

list_by_pool

Azure operation completed successfully.

Name	Datatype	Description
properties	object	The resource-specific properties for this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, poolName, snapshotName		Get a Snapshot
list_by_pool	select	subscriptionId, resourceGroupName, poolName		List Snapshot resources by Pool
create_or_update	insert	subscriptionId, resourceGroupName, poolName, snapshotName		Create a Snapshot
delete	delete	subscriptionId, resourceGroupName, poolName, snapshotName		Delete a Snapshot

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
poolName	string	Pool Object
resourceGroupName	string	The name of the resource group. The name is case insensitive.
snapshotName	string	Volume Snapshot Resource
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Get a Snapshot

SELECT
properties
FROM azure.container_storage.snapshots
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND poolName = '{{ poolName }}' -- required
AND snapshotName = '{{ snapshotName }}' -- required
;

list_by_pool

List Snapshot resources by Pool

SELECT
properties
FROM azure.container_storage.snapshots
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND poolName = '{{ poolName }}' -- required
;

INSERT examples

create_or_update

Create a Snapshot

INSERT INTO azure.container_storage.snapshots (
data__properties,
subscriptionId,
resourceGroupName,
poolName,
snapshotName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ poolName }}',
'{{ snapshotName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: snapshots
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the snapshots resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the snapshots resource.
    - name: poolName
      value: string
      description: Required parameter for the snapshots resource.
    - name: snapshotName
      value: string
      description: Required parameter for the snapshots resource.
    - name: properties
      value: object
      description: |
        The resource-specific properties for this resource.

DELETE examples

delete

Delete a Snapshot

DELETE FROM azure.container_storage.snapshots
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND poolName = '{{ poolName }}' --required
AND snapshotName = '{{ snapshotName }}' --required
;