OSDisk interface
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.
Properties
| caching | Specifies the caching requirements. |
| create |
Specifies how the virtual machine should be created. |
| diff |
Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine. |
| disk |
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. |
| encryption |
Specifies the encryption settings for the OS Disk. |
| 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. |
| managed |
The managed disk parameters. |
| name | The disk name. |
| os |
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. |
| vhd | The virtual hard disk. |
| write |
Specifies whether writeAccelerator should be enabled or disabled on the disk. |
Property Details
caching
Specifies the caching requirements.
Possible values are:
None
ReadOnly
ReadWrite
Default: None for Standard storage. ReadOnly for Premium storage.
caching?: CachingTypesProperty Value
createOption
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.
createOption: stringProperty Value
string
diffDiskSettings
Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.
diffDiskSettings?: DiffDiskSettingsProperty Value
diskSizeGB
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
diskSizeGB?: numberProperty Value
number
encryptionSettings
Specifies the encryption settings for the OS Disk.
Minimum api-version: 2015-06-15
encryptionSettings?: DiskEncryptionSettingsProperty Value
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.
image?: VirtualHardDiskProperty Value
managedDisk
The managed disk parameters.
managedDisk?: ManagedDiskParametersProperty Value
name
The disk name.
name?: stringProperty Value
string
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
osType?: OperatingSystemTypesProperty Value
vhd
writeAcceleratorEnabled
Specifies whether writeAccelerator should be enabled or disabled on the disk.
writeAcceleratorEnabled?: booleanProperty Value
boolean