avs_vm_volumes

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

Overview

Name	avs_vm_volumes
Type	Resource
Id	azure_isv.purestorageblock.avs_vm_volumes

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.
avs	object	AVS-specific volume information.
createdTimestamp	string	Volume creation date, as an RFC 3339 timestamp.
displayName	string	Human-readable name of the volume.
provisionedSize	integer	Currently provisioned size of the volume, in bytes.
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
softDeletion	object	Volume's soft-deletion state. Required.
space	object	Storage space usage.
storagePoolInternalId	string	Pure Storage's internal ID for the storage pool containing the volume.
storagePoolResourceId	string	Azure Resource ID of the storage pool containing this volume.
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".
volumeInternalId	string	Pure Storage's internal ID for the volume.
volumeType	string	Specify which control plane handles the lifecycle of the volume. "avs" (avs)

list_by_avs_vm

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.
avs	object	AVS-specific volume information.
createdTimestamp	string	Volume creation date, as an RFC 3339 timestamp.
displayName	string	Human-readable name of the volume.
provisionedSize	integer	Currently provisioned size of the volume, in bytes.
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
softDeletion	object	Volume's soft-deletion state. Required.
space	object	Storage space usage.
storagePoolInternalId	string	Pure Storage's internal ID for the storage pool containing the volume.
storagePoolResourceId	string	Azure Resource ID of the storage pool containing this volume.
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".
volumeInternalId	string	Pure Storage's internal ID for the volume.
volumeType	string	Specify which control plane handles the lifecycle of the volume. "avs" (avs)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, storage_pool_name, avs_vm_id, volume_id, subscription_id		Get a volume in an AVS VM.
list_by_avs_vm	select	resource_group_name, storage_pool_name, avs_vm_id, subscription_id		List volumes in an AVS VM.
update	update	resource_group_name, storage_pool_name, avs_vm_id, volume_id, subscription_id		Update a volume in an AVS VM.
delete	delete	resource_group_name, storage_pool_name, avs_vm_id, volume_id, subscription_id		Delete a volume in an AVS VM.

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
avs_vm_id	string	ID of the AVS VM. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
storage_pool_name	string	Name of the storage pool. Required.
subscription_id	string
volume_id	string	ID of the volume in the AVS VM. Required.

SELECT examples

get

Get a volume in an AVS VM.

SELECT
id,
name,
avs,
createdTimestamp,
displayName,
provisionedSize,
provisioningState,
softDeletion,
space,
storagePoolInternalId,
storagePoolResourceId,
systemData,
type,
volumeInternalId,
volumeType
FROM azure_isv.purestorageblock.avs_vm_volumes
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND storage_pool_name = '{{ storage_pool_name }}' -- required
AND avs_vm_id = '{{ avs_vm_id }}' -- required
AND volume_id = '{{ volume_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_avs_vm

List volumes in an AVS VM.

SELECT
id,
name,
avs,
createdTimestamp,
displayName,
provisionedSize,
provisioningState,
softDeletion,
space,
storagePoolInternalId,
storagePoolResourceId,
systemData,
type,
volumeInternalId,
volumeType
FROM azure_isv.purestorageblock.avs_vm_volumes
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND storage_pool_name = '{{ storage_pool_name }}' -- required
AND avs_vm_id = '{{ avs_vm_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

UPDATE examples

update

Update a volume in an AVS VM.

UPDATE azure_isv.purestorageblock.avs_vm_volumes
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND storage_pool_name = '{{ storage_pool_name }}' --required
AND avs_vm_id = '{{ avs_vm_id }}' --required
AND volume_id = '{{ volume_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a volume in an AVS VM.

DELETE FROM azure_isv.purestorageblock.avs_vm_volumes
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND storage_pool_name = '{{ storage_pool_name }}' --required
AND avs_vm_id = '{{ avs_vm_id }}' --required
AND volume_id = '{{ volume_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;