Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface OSDisk

Package version

Specifies information about the operating system disk used by the virtual machine.

For more information about disks, see About disks and VHDs for Azure virtual machines.

Hierarchy

  • OSDisk

Index

Properties

Optional caching

caching: CachingTypes

Specifies the caching requirements.

Possible values are:

None

ReadOnly

ReadWrite

Default: None for Standard storage. ReadOnly for Premium storage. Possible values include: 'None', 'ReadOnly', 'ReadWrite'

createOption

createOption: DiskCreateOptionTypes

Specifies how the virtual machine should be created.

Possible values are:

Attach \u2013 This value is used when you are using a specialized disk to create the virtual machine.

FromImage \u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described. Possible values include: 'FromImage', 'Empty', 'Attach'

Optional diskSizeGB

diskSizeGB: undefined | number

Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

This value cannot be larger than 1023 GB

Optional encryptionSettings

encryptionSettings: DiskEncryptionSettings

Specifies the encryption settings for the OS Disk.

Minimum api-version: 2015-06-15

Optional image

The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist.

Optional managedDisk

The managed disk parameters.

Optional name

name: undefined | string

The disk name.

Optional osType

This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD.

Possible values are:

Windows

Linux. Possible values include: 'Windows', 'Linux'

Optional vhd

The virtual hard disk.

Optional writeAcceleratorEnabled

writeAcceleratorEnabled: undefined | false | true

Specifies whether writeAccelerator should be enabled or disabled on the disk.

Generated using TypeDoc