volumes

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

Overview

Name	volumes
Type	Resource
Id	azure_extras.storsimple_8000_series.volumes

Fields

The following fields are returned by SELECT queries:

get

The volume.

Name	Datatype	Description
id	string	The path ID that uniquely identifies the object.
name	string	The name of the object.
kind	string	The Kind of the object. Currently only Series8000 is supported
properties	object	The properties of the volume.
type	string	The hierarchical type of the object.

list_by_volume_container

The collection of volumes.

Name	Datatype	Description
id	string	The path ID that uniquely identifies the object.
name	string	The name of the object.
kind	string	The Kind of the object. Currently only Series8000 is supported
properties	object	The properties of the volume.
type	string	The hierarchical type of the object.

list_by_device

The collection of volumes.

Name	Datatype	Description
id	string	The path ID that uniquely identifies the object.
name	string	The name of the object.
kind	string	The Kind of the object. Currently only Series8000 is supported
properties	object	The properties of the volume.
type	string	The hierarchical type of the object.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	deviceName, volumeContainerName, volumeName, subscriptionId, resourceGroupName, managerName		Returns the properties of the specified volume name.
list_by_volume_container	select	deviceName, volumeContainerName, subscriptionId, resourceGroupName, managerName		Retrieves all the volumes in a volume container.
list_by_device	select	deviceName, subscriptionId, resourceGroupName, managerName		Retrieves all the volumes in a device.
create_or_update	insert	deviceName, volumeContainerName, volumeName, subscriptionId, resourceGroupName, managerName, data__properties		Creates or updates the volume.
delete	delete	deviceName, volumeContainerName, volumeName, subscriptionId, resourceGroupName, managerName		Deletes the 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
deviceName	string	The device name
managerName	string	The manager name
resourceGroupName	string	The resource group name
subscriptionId	string	The subscription id
volumeContainerName	string	The volume container name.
volumeName	string	The volume name.

SELECT examples

get

Returns the properties of the specified volume name.

SELECT
id,
name,
kind,
properties,
type
FROM azure_extras.storsimple_8000_series.volumes
WHERE deviceName = '{{ deviceName }}' -- required
AND volumeContainerName = '{{ volumeContainerName }}' -- required
AND volumeName = '{{ volumeName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND managerName = '{{ managerName }}' -- required
;

list_by_volume_container

Retrieves all the volumes in a volume container.

SELECT
id,
name,
kind,
properties,
type
FROM azure_extras.storsimple_8000_series.volumes
WHERE deviceName = '{{ deviceName }}' -- required
AND volumeContainerName = '{{ volumeContainerName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND managerName = '{{ managerName }}' -- required
;

list_by_device

Retrieves all the volumes in a device.

SELECT
id,
name,
kind,
properties,
type
FROM azure_extras.storsimple_8000_series.volumes
WHERE deviceName = '{{ deviceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND managerName = '{{ managerName }}' -- required
;

INSERT examples

create_or_update

Creates or updates the volume.

INSERT INTO azure_extras.storsimple_8000_series.volumes (
data__kind,
data__properties,
deviceName,
volumeContainerName,
volumeName,
subscriptionId,
resourceGroupName,
managerName
)
SELECT 
'{{ kind }}',
'{{ properties }}' /* required */,
'{{ deviceName }}',
'{{ volumeContainerName }}',
'{{ volumeName }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ managerName }}'
RETURNING
id,
name,
kind,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: volumes
  props:
    - name: deviceName
      value: string
      description: Required parameter for the volumes resource.
    - name: volumeContainerName
      value: string
      description: Required parameter for the volumes resource.
    - name: volumeName
      value: string
      description: Required parameter for the volumes resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the volumes resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the volumes resource.
    - name: managerName
      value: string
      description: Required parameter for the volumes resource.
    - name: kind
      value: string
      description: |
        The Kind of the object. Currently only Series8000 is supported
      valid_values: ['Series8000']
    - name: properties
      value: object
      description: |
        The properties of the volume.

DELETE examples

delete

Deletes the volume.

DELETE FROM azure_extras.storsimple_8000_series.volumes
WHERE deviceName = '{{ deviceName }}' --required
AND volumeContainerName = '{{ volumeContainerName }}' --required
AND volumeName = '{{ volumeName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND managerName = '{{ managerName }}' --required
;