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

vw_virtual_hard_disks

Name	Datatype	Description
block_size_bytes	text	field from the properties object
container_id	text	field from the properties object
disk_file_format	text	field from the properties object
disk_size_gb	text	field from the properties object
dynamic	text	field from the properties object
extended_location	text	field from the properties object
hyper_v_generation	text	field from the properties object
location	text	The geo-location where the resource lives
logical_sector_bytes	text	field from the properties object
physical_sector_bytes	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
status	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.
virtualHardDiskName	text	field from the properties object

virtual_hard_disks

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

Methods

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, subscriptionId, virtualHardDiskName	Gets a virtual hard disk
list	SELECT	resourceGroupName, subscriptionId	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	resourceGroupName, subscriptionId, virtualHardDiskName	The operation to create or update a virtual hard disk. Please note some properties can be set only during virtual hard disk creation.
delete	DELETE	resourceGroupName, subscriptionId, virtualHardDiskName	The operation to delete a virtual hard disk.
update	UPDATE	resourceGroupName, subscriptionId, virtualHardDiskName	The operation to update a virtual hard disk.

SELECT examples

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.

vw_virtual_hard_disks

SELECT
block_size_bytes,
container_id,
disk_file_format,
disk_size_gb,
dynamic,
extended_location,
hyper_v_generation,
location,
logical_sector_bytes,
physical_sector_bytes,
provisioning_state,
resourceGroupName,
status,
subscriptionId,
tags,
virtualHardDiskName
FROM azure_stack.azure_stack_hci.vw_virtual_hard_disks
WHERE subscriptionId = '{{ subscriptionId }}';

virtual_hard_disks

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

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure_stack.azure_stack_hci.virtual_hard_disks (
resourceGroupName,
subscriptionId,
virtualHardDiskName,
properties,
extendedLocation,
tags,
location
)
SELECT 
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ virtualHardDiskName }}',
'{{ properties }}',
'{{ extendedLocation }}',
'{{ tags }}',
'{{ location }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: blockSizeBytes
          value: integer
        - name: diskSizeGB
          value: integer
        - name: dynamic
          value: boolean
        - name: logicalSectorBytes
          value: integer
        - name: physicalSectorBytes
          value: integer
        - name: hyperVGeneration
          value: string
        - name: diskFileFormat
          value: string
        - name: provisioningState
          value: string
        - name: containerId
          value: string
        - name: status
          value:
            - name: errorCode
              value: string
            - name: errorMessage
              value: string
            - name: provisioningStatus
              value:
                - name: operationId
                  value: string
                - name: status
                  value: string
    - name: extendedLocation
      value:
        - name: name
          value: string
        - name: type
          value: []
    - name: tags
      value: object
    - name: location
      value: string

UPDATE example

Updates a virtual_hard_disks resource.

/*+ update */
UPDATE azure_stack.azure_stack_hci.virtual_hard_disks
SET 
tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND virtualHardDiskName = '{{ virtualHardDiskName }}';

DELETE example

Deletes the specified virtual_hard_disks resource.

/*+ delete */
DELETE FROM azure_stack.azure_stack_hci.virtual_hard_disks
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND virtualHardDiskName = '{{ virtualHardDiskName }}';