volumes

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

Overview

Name	volumes
Type	Resource
Id	azure_extras.network_cloud.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.
allocatedSizeMiB	integer	The allocated size of the volume in Mebibytes.
assignedStorageApplianceId	string	The assigned resource ID of the storage appliance that hosts the volume.
attachedTo	array	The list of resource IDs that attach the volume. It may include virtual machines and Hybrid AKS clusters.
detailedStatus	string	The more detailed status of the volume. Known values are: "Active", "Error", and "Provisioning". (Active, Error, Provisioning)
detailedStatusMessage	string	The descriptive message about the current detailed status.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
extendedLocation	object	The extended location of the resource. This property is required when creating the resource. Required.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of the volume. Known values are: "Accepted", "Canceled", "Failed", "Provisioning", and "Succeeded". (Accepted, Canceled, Failed, Provisioning, Succeeded)
serialNumber	string	The unique identifier of the volume.
sizeMiB	integer	The requested storage allocation for the volume in Mebibytes. Required.
storageApplianceId	string	The resource ID of the storage appliance that hosts the volume.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

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.
allocatedSizeMiB	integer	The allocated size of the volume in Mebibytes.
assignedStorageApplianceId	string	The assigned resource ID of the storage appliance that hosts the volume.
attachedTo	array	The list of resource IDs that attach the volume. It may include virtual machines and Hybrid AKS clusters.
detailedStatus	string	The more detailed status of the volume. Known values are: "Active", "Error", and "Provisioning". (Active, Error, Provisioning)
detailedStatusMessage	string	The descriptive message about the current detailed status.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
extendedLocation	object	The extended location of the resource. This property is required when creating the resource. Required.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of the volume. Known values are: "Accepted", "Canceled", "Failed", "Provisioning", and "Succeeded". (Accepted, Canceled, Failed, Provisioning, Succeeded)
serialNumber	string	The unique identifier of the volume.
sizeMiB	integer	The requested storage allocation for the volume in Mebibytes. Required.
storageApplianceId	string	The resource ID of the storage appliance that hosts the volume.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

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.
allocatedSizeMiB	integer	The allocated size of the volume in Mebibytes.
assignedStorageApplianceId	string	The assigned resource ID of the storage appliance that hosts the volume.
attachedTo	array	The list of resource IDs that attach the volume. It may include virtual machines and Hybrid AKS clusters.
detailedStatus	string	The more detailed status of the volume. Known values are: "Active", "Error", and "Provisioning". (Active, Error, Provisioning)
detailedStatusMessage	string	The descriptive message about the current detailed status.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
extendedLocation	object	The extended location of the resource. This property is required when creating the resource. Required.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of the volume. Known values are: "Accepted", "Canceled", "Failed", "Provisioning", and "Succeeded". (Accepted, Canceled, Failed, Provisioning, Succeeded)
serialNumber	string	The unique identifier of the volume.
sizeMiB	integer	The requested storage allocation for the volume in Mebibytes. Required.
storageApplianceId	string	The resource ID of the storage appliance that hosts the volume.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, volume_name, subscription_id		Get properties of the provided volume.
list_by_resource_group	select	resource_group_name, subscription_id	$top, $skipToken	Get a list of volumes in the provided resource group.
list_by_subscription	select	subscription_id	$top, $skipToken	Get a list of volumes in the provided subscription.
create_or_update	insert	resource_group_name, volume_name, subscription_id, location, properties, extendedLocation		Create a new volume or update the properties of the existing one.
update	update	resource_group_name, volume_name, subscription_id		Update tags associated with the provided volume.
create_or_update	replace	resource_group_name, volume_name, subscription_id, location, properties, extendedLocation		Create a new volume or update the properties of the existing one.
delete	delete	resource_group_name, volume_name, subscription_id		Delete the provided 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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
volume_name	string	The name of the volume. Required.
$skipToken	string	The opaque token that the server returns to indicate where to continue listing resources from. This is used for paging through large result sets. Default value is None.
$top	integer	The maximum number of resources to return from the operation. Example: '$top=10'. Default value is None.

SELECT examples

get

Get properties of the provided volume.

SELECT
id,
name,
allocatedSizeMiB,
assignedStorageApplianceId,
attachedTo,
detailedStatus,
detailedStatusMessage,
etag,
extendedLocation,
location,
provisioningState,
serialNumber,
sizeMiB,
storageApplianceId,
systemData,
tags,
type
FROM azure_extras.network_cloud.volumes
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND volume_name = '{{ volume_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Get a list of volumes in the provided resource group.

SELECT
id,
name,
allocatedSizeMiB,
assignedStorageApplianceId,
attachedTo,
detailedStatus,
detailedStatusMessage,
etag,
extendedLocation,
location,
provisioningState,
serialNumber,
sizeMiB,
storageApplianceId,
systemData,
tags,
type
FROM azure_extras.network_cloud.volumes
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

list_by_subscription

Get a list of volumes in the provided subscription.

SELECT
id,
name,
allocatedSizeMiB,
assignedStorageApplianceId,
attachedTo,
detailedStatus,
detailedStatusMessage,
etag,
extendedLocation,
location,
provisioningState,
serialNumber,
sizeMiB,
storageApplianceId,
systemData,
tags,
type
FROM azure_extras.network_cloud.volumes
WHERE subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create_or_update

Create a new volume or update the properties of the existing one.

INSERT INTO azure_extras.network_cloud.volumes (
tags,
location,
properties,
extendedLocation,
resource_group_name,
volume_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}' /* required */,
'{{ extendedLocation }}' /* required */,
'{{ resource_group_name }}',
'{{ volume_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
extendedLocation,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: volumes
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the volumes resource.
  - name: volume_name
    value: "{{ volume_name }}"
    description: Required parameter for the volumes resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the volumes resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The list of the resource properties. Required.
    value:
      sizeMiB: {{ sizeMiB }}
      storageApplianceId: "{{ storageApplianceId }}"
      allocatedSizeMiB: {{ allocatedSizeMiB }}
      assignedStorageApplianceId: "{{ assignedStorageApplianceId }}"
      attachedTo:
        - "{{ attachedTo }}"
      detailedStatus: "{{ detailedStatus }}"
      detailedStatusMessage: "{{ detailedStatusMessage }}"
      serialNumber: "{{ serialNumber }}"
      provisioningState: "{{ provisioningState }}"
  - name: extendedLocation
    description: |
      The extended location of the resource. This property is required when creating the resource. Required.
    value:
      name: "{{ name }}"
      type: "{{ type }}"

UPDATE examples

update

Update tags associated with the provided volume.

UPDATE azure_extras.network_cloud.volumes
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND volume_name = '{{ volume_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
extendedLocation,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create a new volume or update the properties of the existing one.

REPLACE azure_extras.network_cloud.volumes
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
extendedLocation = '{{ extendedLocation }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND volume_name = '{{ volume_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
AND properties = '{{ properties }}' --required
AND extendedLocation = '{{ extendedLocation }}' --required
RETURNING
id,
name,
etag,
extendedLocation,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete the provided volume.

DELETE FROM azure_extras.network_cloud.volumes
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND volume_name = '{{ volume_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;