disks

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

Overview

Name	disks
Type	Resource
Id	azure.dev_test_labs.disks

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	The identifier of the resource.
name	string	The name of the resource.
location	string	The location of the resource.
properties	object	The properties of the resource.
tags	object	The tags of the resource.
type	string	The type of the resource.

list

Name	Datatype	Description
id	string	The identifier of the resource.
name	string	The name of the resource.
location	string	The location of the resource.
properties	object	The properties of the resource.
tags	object	The tags of the resource.
type	string	The type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, labName, userName, name	$expand, api-version	Get disk.
list	select	subscriptionId, resourceGroupName, labName, userName	$expand, $filter, $top, $orderby, api-version	List disks in a given user profile.
create_or_update	insert	subscriptionId, resourceGroupName, labName, userName, name, data__properties	api-version	Create or replace an existing disk. This operation can take a while to complete.
update	update	subscriptionId, resourceGroupName, labName, userName, name	api-version	Allows modifying tags of disks. All other properties will be ignored.
delete	delete	subscriptionId, resourceGroupName, labName, userName, name	api-version	Delete disk. This operation can take a while to complete.
attach	exec	subscriptionId, resourceGroupName, labName, userName, name	api-version	Attach and create the lease of the disk to the virtual machine. This operation can take a while to complete.
detach	exec	subscriptionId, resourceGroupName, labName, userName, name	api-version	Detach and break the lease of the disk attached to the virtual machine. This operation can take a while to complete.

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
labName	string	The name of the lab.
name	string	The name of the disk.
resourceGroupName	string	The name of the resource group.
subscriptionId	string	The subscription ID.
userName	string	The name of the user profile.
$expand	string	Specify the $expand query. Example: 'properties($select=diskType)'
$filter	string	The filter to apply to the operation. Example: '$filter=contains(name,'myName')
$orderby	string	The ordering expression for the results, using OData notation. Example: '$orderby=name desc'
$top	integer (int32)	The maximum number of resources to return from the operation. Example: '$top=10'
api-version	string	Client API version.

SELECT examples

get

Get disk.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.dev_test_labs.disks
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND labName = '{{ labName }}' -- required
AND userName = '{{ userName }}' -- required
AND name = '{{ name }}' -- required
AND $expand = '{{ $expand }}'
AND api-version = '{{ api-version }}'
;

list

List disks in a given user profile.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.dev_test_labs.disks
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND labName = '{{ labName }}' -- required
AND userName = '{{ userName }}' -- required
AND $expand = '{{ $expand }}'
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $orderby = '{{ $orderby }}'
AND api-version = '{{ api-version }}'
;

INSERT examples

create_or_update

Create or replace an existing disk. This operation can take a while to complete.

INSERT INTO azure.dev_test_labs.disks (
data__location,
data__tags,
data__properties,
subscriptionId,
resourceGroupName,
labName,
userName,
name,
api-version
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ labName }}',
'{{ userName }}',
'{{ name }}',
'{{ api-version }}'
RETURNING
id,
name,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: disks
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the disks resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the disks resource.
    - name: labName
      value: string
      description: Required parameter for the disks resource.
    - name: userName
      value: string
      description: Required parameter for the disks resource.
    - name: name
      value: string
      description: Required parameter for the disks resource.
    - name: location
      value: string
      description: |
        The location of the resource.
    - name: tags
      value: object
      description: |
        The tags of the resource.
    - name: properties
      value: object
      description: |
        The properties of the resource.
    - name: api-version
      value: string
      description: Client API version.

UPDATE examples

update

Allows modifying tags of disks. All other properties will be ignored.

UPDATE azure.dev_test_labs.disks
SET 
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND labName = '{{ labName }}' --required
AND userName = '{{ userName }}' --required
AND name = '{{ name }}' --required
AND api-version = '{{ api-version}}'
RETURNING
id,
name,
location,
properties,
tags,
type;

DELETE examples

delete

Delete disk. This operation can take a while to complete.

DELETE FROM azure.dev_test_labs.disks
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND labName = '{{ labName }}' --required
AND userName = '{{ userName }}' --required
AND name = '{{ name }}' --required
AND api-version = '{{ api-version }}'
;

Lifecycle Methods

attach

Attach and create the lease of the disk to the virtual machine. This operation can take a while to complete.

EXEC azure.dev_test_labs.disks.attach 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@labName='{{ labName }}' --required, 
@userName='{{ userName }}' --required, 
@name='{{ name }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"leasedByLabVmId": "{{ leasedByLabVmId }}"
}'
;

detach

Detach and break the lease of the disk attached to the virtual machine. This operation can take a while to complete.

EXEC azure.dev_test_labs.disks.detach 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@labName='{{ labName }}' --required, 
@userName='{{ userName }}' --required, 
@name='{{ name }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"leasedByLabVmId": "{{ leasedByLabVmId }}"
}'
;