Share via


VirtualHardDiskProperties interface

Properties under the virtual hard disk resource

Properties

blockSizeBytes

Block size in bytes

containerId

Storage ContainerID of the storage container to be used for VHD

createFromLocal

Boolean indicating whether it is an existing local hard disk or if one should be created.

diskFileFormat

The format of the actual VHD file [vhd, vhdx]

diskSizeGB

Size of the disk in GB

downloadUrl

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 for enabling dynamic sizing on the virtual hard disk

hyperVGeneration

The hypervisor generation of the Virtual Machine [V1, V2]

logicalSectorBytes

Logical sector in bytes

maxShares

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

Physical sector in bytes

provisioningState

Provisioning state of the virtual hard disk.

status

The observed state of virtual hard disks

Property Details

blockSizeBytes

Block size in bytes

blockSizeBytes?: number

Property Value

number

containerId

Storage ContainerID of the storage container to be used for VHD

containerId?: string

Property Value

string

createFromLocal

Boolean indicating whether it is an existing local hard disk or if one should be created.

createFromLocal?: boolean

Property Value

boolean

diskFileFormat

The format of the actual VHD file [vhd, vhdx]

diskFileFormat?: string

Property Value

string

diskSizeGB

Size of the disk in GB

diskSizeGB?: number

Property Value

number

downloadUrl

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.

downloadUrl?: string

Property Value

string

dynamic

Boolean for enabling dynamic sizing on the virtual hard disk

dynamic?: boolean

Property Value

boolean

hyperVGeneration

The hypervisor generation of the Virtual Machine [V1, V2]

hyperVGeneration?: string

Property Value

string

logicalSectorBytes

Logical sector in bytes

logicalSectorBytes?: number

Property Value

number

maxShares

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.

maxShares?: number

Property Value

number

physicalSectorBytes

Physical sector in bytes

physicalSectorBytes?: number

Property Value

number

provisioningState

Provisioning state of the virtual hard disk.

provisioningState?: string

Property Value

string

status

The observed state of virtual hard disks

status?: VirtualHardDiskStatus

Property Value