volume_containers

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

Overview

Name	volume_containers
Type	Resource
Id	azure_extras.storsimple_8000_series.volume_containers

Fields

The following fields are returned by SELECT queries:

get

The VolumeContainer.

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 volume container properties.
type	string	The hierarchical type of the object.

list_by_device

The VolumeContainer List

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 volume container properties.
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, subscriptionId, resourceGroupName, managerName		Gets the properties of the specified volume container name.
list_by_device	select	deviceName, subscriptionId, resourceGroupName, managerName		Gets all the volume containers in a device.
create_or_update	insert	deviceName, volumeContainerName, subscriptionId, resourceGroupName, managerName, data__properties		Creates or updates the volume container.
delete	delete	deviceName, volumeContainerName, subscriptionId, resourceGroupName, managerName		Deletes the volume container.

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 name of the volume container.

SELECT examples

get

Gets the properties of the specified volume container name.

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

list_by_device

Gets all the volume containers in a device.

SELECT
id,
name,
kind,
properties,
type
FROM azure_extras.storsimple_8000_series.volume_containers
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 container.

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

Manifest

# Description fields are for documentation purposes
- name: volume_containers
  props:
    - name: deviceName
      value: string
      description: Required parameter for the volume_containers resource.
    - name: volumeContainerName
      value: string
      description: Required parameter for the volume_containers resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the volume_containers resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the volume_containers resource.
    - name: managerName
      value: string
      description: Required parameter for the volume_containers 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 volume container properties.

DELETE examples

delete

Deletes the volume container.

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