volumes

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

Overview

Name	volumes
Type	Resource
Id	azure.container_storage.volumes

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, volumeName		Get a Volume
list_by_pool	select	subscriptionId, resourceGroupName, poolName		List Volume resources by Pool
create_or_update	insert	subscriptionId, resourceGroupName, poolName, volumeName		Create a Volume
update	update	subscriptionId, resourceGroupName, poolName, volumeName		Update a Volume
delete	delete	subscriptionId, resourceGroupName, poolName, volumeName		Delete a Volume

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.
subscriptionId	string	The ID of the target subscription.
volumeName	string	Volume Resource

SELECT examples

get

Get a Volume

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

list_by_pool

List Volume resources by Pool

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

INSERT examples

create_or_update

Create a Volume

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

Manifest

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

UPDATE examples

update

Update a Volume

UPDATE azure.container_storage.volumes
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND poolName = '{{ poolName }}' --required
AND volumeName = '{{ volumeName }}' --required
RETURNING
properties;

DELETE examples

delete

Delete a Volume

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