avs_vms

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

Overview

Name	avs_vms
Type	Resource
Id	azure_isv.purestorageblock.avs_vms

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 VM details.
createdTimestamp	string	Date at which the AVS VM was created, as an RFC 3339 timestamp.
displayName	string	Human-readable name of the AVS VM.
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
softDeletion	object	AVS VM's soft-deletion state.
space	object	Contains properties related to used Flash space.
storagePoolInternalId	string	Pure Storage's internal ID for the storage pool.
storagePoolResourceId	string	Azure resource ID of the storage pool.
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".
volumeContainerType	string	Specify which control plane handles the lifecycle of the volume container. "avs" (avs)

list_by_storage_pool

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 VM details.
createdTimestamp	string	Date at which the AVS VM was created, as an RFC 3339 timestamp.
displayName	string	Human-readable name of the AVS VM.
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
softDeletion	object	AVS VM's soft-deletion state.
space	object	Contains properties related to used Flash space.
storagePoolInternalId	string	Pure Storage's internal ID for the storage pool.
storagePoolResourceId	string	Azure resource ID of the storage pool.
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".
volumeContainerType	string	Specify which control plane handles the lifecycle of the volume container. "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, subscription_id		Get an AVS VM.
list_by_storage_pool	select	resource_group_name, storage_pool_name, subscription_id		List AVS VMs by storage pool.
update	update	resource_group_name, storage_pool_name, avs_vm_id, subscription_id		Update an AVS VM.
delete	delete	resource_group_name, storage_pool_name, avs_vm_id, subscription_id		Delete 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

SELECT examples

get

Get an AVS VM.

SELECT
id,
name,
avs,
createdTimestamp,
displayName,
provisioningState,
softDeletion,
space,
storagePoolInternalId,
storagePoolResourceId,
systemData,
type,
volumeContainerType
FROM azure_isv.purestorageblock.avs_vms
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
;

list_by_storage_pool

List AVS VMs by storage pool.

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

UPDATE examples

update

Update an AVS VM.

UPDATE azure_isv.purestorageblock.avs_vms
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 subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete an AVS VM.

DELETE FROM azure_isv.purestorageblock.avs_vms
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
;