volumes

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

Overview

Name	volumes
Type	Resource
Id	azure.nexus.volumes

Fields

vw_volumes

Name	Datatype	Description
attached_to	text	field from the properties object
detailed_status	text	field from the properties object
detailed_status_message	text	field from the properties object
extended_location	text	field from the properties object
location	text	The geo-location where the resource lives
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
serial_number	text	field from the properties object
size_mib	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.
volumeName	text	field from the properties object

volumes

Name	Datatype	Description
extendedLocation	object
location	string	The geo-location where the resource lives
properties	object
tags	object	Resource tags.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, subscriptionId, volumeName	Get properties of the provided volume.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Get a list of volumes in the provided resource group.
list_by_subscription	SELECT	subscriptionId	Get a list of volumes in the provided subscription.
create_or_update	INSERT	resourceGroupName, subscriptionId, volumeName, data__extendedLocation, data__properties	Create a new volume or update the properties of the existing one.
delete	DELETE	resourceGroupName, subscriptionId, volumeName	Delete the provided volume.
update	UPDATE	resourceGroupName, subscriptionId, volumeName	Update tags associated with the provided volume.

SELECT examples

Get a list of volumes in the provided subscription.

vw_volumes

SELECT
attached_to,
detailed_status,
detailed_status_message,
extended_location,
location,
provisioning_state,
resourceGroupName,
serial_number,
size_mib,
subscriptionId,
tags,
volumeName
FROM azure.nexus.vw_volumes
WHERE subscriptionId = '{{ subscriptionId }}';

volumes

SELECT
extendedLocation,
location,
properties,
tags
FROM azure.nexus.volumes
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new volumes resource.

All Properties

/*+ create */
INSERT INTO azure.nexus.volumes (
resourceGroupName,
subscriptionId,
volumeName,
data__extendedLocation,
data__properties,
extendedLocation,
properties,
tags,
location
)
SELECT 
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ volumeName }}',
'{{ data__extendedLocation }}',
'{{ data__properties }}',
'{{ extendedLocation }}',
'{{ properties }}',
'{{ tags }}',
'{{ location }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: extendedLocation
      value:
        - name: name
          value: string
        - name: type
          value: string
    - name: properties
      value:
        - name: attachedTo
          value:
            - string
        - name: detailedStatus
          value: string
        - name: detailedStatusMessage
          value: string
        - name: provisioningState
          value: string
        - name: serialNumber
          value: string
        - name: sizeMiB
          value: integer
    - name: tags
      value: object
    - name: location
      value: string

UPDATE example

Updates a volumes resource.

/*+ update */
UPDATE azure.nexus.volumes
SET 
tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND volumeName = '{{ volumeName }}';

DELETE example

Deletes the specified volumes resource.

/*+ delete */
DELETE FROM azure.nexus.volumes
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND volumeName = '{{ volumeName }}';