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_vm.virtual_hard_disks

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.
blockSizeBytes	integer	Block size in bytes.
containerId	string	Storage ContainerID of the storage container to be used for VHD.
createFromLocal	boolean	Boolean indicating whether it is an existing local hard disk or if one should be created.
diskFileFormat	string	The format of the actual VHD file [vhd, vhdx]. Known values are: "vhdx" and "vhd". (vhdx, vhd)
diskSizeGB	integer	Size of the disk in GB.
downloadUrl	string	URL for downloading or accessing the virtual hard disk. This URL points to a secure link from where the VHD can be downloaded or accessed directly.
dynamic	boolean	Boolean for enabling dynamic sizing on the virtual hard disk.
extendedLocation	object	The extendedLocation of the resource.
hyperVGeneration	string	The hypervisor generation of the Virtual Machine [V1, V2]. Known values are: "V1" and "V2". (V1, V2)
location	string	The geo-location where the resource lives. Required.
logicalSectorBytes	integer	Logical sector in bytes.
maxShares	integer	The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time.
physicalSectorBytes	integer	Physical sector in bytes.
provisioningState	string	Provisioning state of the virtual hard disk. Known values are: "Succeeded", "Failed", "InProgress", "Accepted", "Deleting", and "Canceled". (Succeeded, Failed, InProgress, Accepted, Deleting, Canceled)
status	object	The observed state of virtual hard disks.
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.
blockSizeBytes	integer	Block size in bytes.
containerId	string	Storage ContainerID of the storage container to be used for VHD.
createFromLocal	boolean	Boolean indicating whether it is an existing local hard disk or if one should be created.
diskFileFormat	string	The format of the actual VHD file [vhd, vhdx]. Known values are: "vhdx" and "vhd". (vhdx, vhd)
diskSizeGB	integer	Size of the disk in GB.
downloadUrl	string	URL for downloading or accessing the virtual hard disk. This URL points to a secure link from where the VHD can be downloaded or accessed directly.
dynamic	boolean	Boolean for enabling dynamic sizing on the virtual hard disk.
extendedLocation	object	The extendedLocation of the resource.
hyperVGeneration	string	The hypervisor generation of the Virtual Machine [V1, V2]. Known values are: "V1" and "V2". (V1, V2)
location	string	The geo-location where the resource lives. Required.
logicalSectorBytes	integer	Logical sector in bytes.
maxShares	integer	The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time.
physicalSectorBytes	integer	Physical sector in bytes.
provisioningState	string	Provisioning state of the virtual hard disk. Known values are: "Succeeded", "Failed", "InProgress", "Accepted", "Deleting", and "Canceled". (Succeeded, Failed, InProgress, Accepted, Deleting, Canceled)
status	object	The observed state of virtual hard disks.
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_all

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.
blockSizeBytes	integer	Block size in bytes.
containerId	string	Storage ContainerID of the storage container to be used for VHD.
createFromLocal	boolean	Boolean indicating whether it is an existing local hard disk or if one should be created.
diskFileFormat	string	The format of the actual VHD file [vhd, vhdx]. Known values are: "vhdx" and "vhd". (vhdx, vhd)
diskSizeGB	integer	Size of the disk in GB.
downloadUrl	string	URL for downloading or accessing the virtual hard disk. This URL points to a secure link from where the VHD can be downloaded or accessed directly.
dynamic	boolean	Boolean for enabling dynamic sizing on the virtual hard disk.
extendedLocation	object	The extendedLocation of the resource.
hyperVGeneration	string	The hypervisor generation of the Virtual Machine [V1, V2]. Known values are: "V1" and "V2". (V1, V2)
location	string	The geo-location where the resource lives. Required.
logicalSectorBytes	integer	Logical sector in bytes.
maxShares	integer	The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time.
physicalSectorBytes	integer	Physical sector in bytes.
provisioningState	string	Provisioning state of the virtual hard disk. Known values are: "Succeeded", "Failed", "InProgress", "Accepted", "Deleting", and "Canceled". (Succeeded, Failed, InProgress, Accepted, Deleting, Canceled)
status	object	The observed state of virtual hard disks.
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, virtual_hard_disk_name, subscription_id		Gets a virtual hard disk.
list_by_resource_group	select	resource_group_name, subscription_id		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	subscription_id		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	resource_group_name, virtual_hard_disk_name, subscription_id, location		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	resource_group_name, virtual_hard_disk_name, subscription_id		The operation to update a virtual hard disk.
create_or_update	replace	resource_group_name, virtual_hard_disk_name, subscription_id, location		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	resource_group_name, virtual_hard_disk_name, subscription_id		The operation to delete a virtual hard disk.
upload	exec	resource_group_name, virtual_hard_disk_name, subscription_id, azureManagedDiskUploadUrl		The operation to upload 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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
virtual_hard_disk_name	string	Name of the virtual hard disk. Required.

SELECT examples

get

Gets a virtual hard disk.

SELECT
id,
name,
blockSizeBytes,
containerId,
createFromLocal,
diskFileFormat,
diskSizeGB,
downloadUrl,
dynamic,
extendedLocation,
hyperVGeneration,
location,
logicalSectorBytes,
maxShares,
physicalSectorBytes,
provisioningState,
status,
systemData,
tags,
type
FROM azure_stack.azure_stack_hci_vm.virtual_hard_disks
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND virtual_hard_disk_name = '{{ virtual_hard_disk_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

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
id,
name,
blockSizeBytes,
containerId,
createFromLocal,
diskFileFormat,
diskSizeGB,
downloadUrl,
dynamic,
extendedLocation,
hyperVGeneration,
location,
logicalSectorBytes,
maxShares,
physicalSectorBytes,
provisioningState,
status,
systemData,
tags,
type
FROM azure_stack.azure_stack_hci_vm.virtual_hard_disks
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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
id,
name,
blockSizeBytes,
containerId,
createFromLocal,
diskFileFormat,
diskSizeGB,
downloadUrl,
dynamic,
extendedLocation,
hyperVGeneration,
location,
logicalSectorBytes,
maxShares,
physicalSectorBytes,
provisioningState,
status,
systemData,
tags,
type
FROM azure_stack.azure_stack_hci_vm.virtual_hard_disks
WHERE subscription_id = '{{ subscription_id }}' -- 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_vm.virtual_hard_disks (
tags,
location,
properties,
extendedLocation,
resource_group_name,
virtual_hard_disk_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ extendedLocation }}',
'{{ resource_group_name }}',
'{{ virtual_hard_disk_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
extendedLocation,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: virtual_hard_disks
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the virtual_hard_disks resource.
  - name: virtual_hard_disk_name
    value: "{{ virtual_hard_disk_name }}"
    description: Required parameter for the virtual_hard_disks resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the virtual_hard_disks 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 resource-specific properties for this resource.
    value:
      blockSizeBytes: {{ blockSizeBytes }}
      diskSizeGB: {{ diskSizeGB }}
      dynamic: {{ dynamic }}
      logicalSectorBytes: {{ logicalSectorBytes }}
      physicalSectorBytes: {{ physicalSectorBytes }}
      downloadUrl: "{{ downloadUrl }}"
      hyperVGeneration: "{{ hyperVGeneration }}"
      diskFileFormat: "{{ diskFileFormat }}"
      createFromLocal: {{ createFromLocal }}
      provisioningState: "{{ provisioningState }}"
      containerId: "{{ containerId }}"
      status:
        errorCode: "{{ errorCode }}"
        errorMessage: "{{ errorMessage }}"
        provisioningStatus:
          operationId: "{{ operationId }}"
          status: "{{ status }}"
        downloadStatus:
          downloadedSizeInMB: {{ downloadedSizeInMB }}
          status: "{{ status }}"
          progressPercentage: {{ progressPercentage }}
        uploadStatus:
          uploadedSizeInMB: {{ uploadedSizeInMB }}
          status: "{{ status }}"
          progressPercentage: {{ progressPercentage }}
          errorCode: "{{ errorCode }}"
          errorMessage: "{{ errorMessage }}"
        managedBy:
          - "{{ managedBy }}"
        uniqueId: "{{ uniqueId }}"
      maxShares: {{ maxShares }}
  - name: extendedLocation
    description: |
      The extendedLocation of the resource.
    value:
      name: "{{ name }}"
      type: "{{ type }}"

UPDATE examples

update

The operation to update a virtual hard disk.

UPDATE azure_stack.azure_stack_hci_vm.virtual_hard_disks
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND virtual_hard_disk_name = '{{ virtual_hard_disk_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
extendedLocation,
location,
properties,
systemData,
tags,
type;

REPLACE 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.

REPLACE azure_stack.azure_stack_hci_vm.virtual_hard_disks
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
extendedLocation = '{{ extendedLocation }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND virtual_hard_disk_name = '{{ virtual_hard_disk_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
extendedLocation,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

The operation to delete a virtual hard disk.

DELETE FROM azure_stack.azure_stack_hci_vm.virtual_hard_disks
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND virtual_hard_disk_name = '{{ virtual_hard_disk_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

upload

The operation to upload a virtual hard disk.

EXEC azure_stack.azure_stack_hci_vm.virtual_hard_disks.upload 
@resource_group_name='{{ resource_group_name }}' --required, 
@virtual_hard_disk_name='{{ virtual_hard_disk_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"azureManagedDiskUploadUrl": "{{ azureManagedDiskUploadUrl }}"
}'
;