virtual_hard_disks

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

Overview

Name	virtual_hard_disks
Type	Resource
Id	azure_stack.azure_stack_hci.virtual_hard_disks

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
extendedLocation	object	The extendedLocation of the resource.
location	string	The geo-location where the resource lives
properties	object	Properties under the virtual hard disk resource
tags	object	Resource tags.

list

Name	Datatype	Description
extendedLocation	object	The extendedLocation of the resource.
location	string	The geo-location where the resource lives
properties	object	Properties under the virtual hard disk resource
tags	object	Resource tags.

list_all

Name	Datatype	Description
extendedLocation	object	The extendedLocation of the resource.
location	string	The geo-location where the resource lives
properties	object	Properties under the virtual hard disk resource
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, virtualHardDiskName		Gets a virtual hard disk
list	select	subscriptionId, resourceGroupName		Lists all of the virtual hard disks in the specified resource group. Use the nextLink property in the response to get the next page of virtual hard disks.
list_all	select	subscriptionId		Lists all of the virtual hard disks in the specified subscription. Use the nextLink property in the response to get the next page of virtual hard disks.
create_or_update	insert	subscriptionId, resourceGroupName, virtualHardDiskName		The operation to create or update a virtual hard disk. Please note some properties can be set only during virtual hard disk creation.
update	update	subscriptionId, resourceGroupName, virtualHardDiskName		The operation to update a virtual hard disk.
delete	delete	subscriptionId, resourceGroupName, virtualHardDiskName		The operation to delete a virtual hard disk.

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
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
virtualHardDiskName	string	Name of the virtual hard disk

SELECT examples

get

Gets a virtual hard disk

SELECT
extendedLocation,
location,
properties,
tags
FROM azure_stack.azure_stack_hci.virtual_hard_disks
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND virtualHardDiskName = '{{ virtualHardDiskName }}' -- required
;

list

Lists all of the virtual hard disks in the specified resource group. Use the nextLink property in the response to get the next page of virtual hard disks.

SELECT
extendedLocation,
location,
properties,
tags
FROM azure_stack.azure_stack_hci.virtual_hard_disks
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_all

Lists all of the virtual hard disks in the specified subscription. Use the nextLink property in the response to get the next page of virtual hard disks.

SELECT
extendedLocation,
location,
properties,
tags
FROM azure_stack.azure_stack_hci.virtual_hard_disks
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

The operation to create or update a virtual hard disk. Please note some properties can be set only during virtual hard disk creation.

INSERT INTO azure_stack.azure_stack_hci.virtual_hard_disks (
data__properties,
data__extendedLocation,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
virtualHardDiskName
)
SELECT 
'{{ properties }}',
'{{ extendedLocation }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ virtualHardDiskName }}'
RETURNING
extendedLocation,
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: virtual_hard_disks
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the virtual_hard_disks resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the virtual_hard_disks resource.
    - name: virtualHardDiskName
      value: string
      description: Required parameter for the virtual_hard_disks resource.
    - name: properties
      value: object
      description: |
        Properties under the virtual hard disk resource
    - name: extendedLocation
      value: object
      description: |
        The extendedLocation of the resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

The operation to update a virtual hard disk.

UPDATE azure_stack.azure_stack_hci.virtual_hard_disks
SET 
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND virtualHardDiskName = '{{ virtualHardDiskName }}' --required
RETURNING
extendedLocation,
location,
properties,
tags;

DELETE examples

delete

The operation to delete a virtual hard disk.

DELETE FROM azure_stack.azure_stack_hci.virtual_hard_disks
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND virtualHardDiskName = '{{ virtualHardDiskName }}' --required
;