Package version:

Interface OSDisk

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.

interface OSDisk {
    caching?: CachingTypes;
    createOption: string;
    deleteOption?: string;
    diffDiskSettings?: DiffDiskSettings;
    diskSizeGB?: number;
    encryptionSettings?: DiskEncryptionSettings;
    image?: VirtualHardDisk;
    managedDisk?: ManagedDiskParameters;
    name?: string;
    osType?: OperatingSystemTypes;
    vhd?: VirtualHardDisk;
    writeAcceleratorEnabled?: boolean;
}

Properties

caching? createOption deleteOption? diffDiskSettings? diskSizeGB? encryptionSettings? image? managedDisk? name? osType? vhd? writeAcceleratorEnabled?

Properties

Optionalcaching

caching?: CachingTypes

Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The defaulting behavior is: None for Standard storage. ReadOnly for Premium storage.

createOption

createOption: string

Specifies how the virtual machine disk should be created. Possible values are Attach: This value is used when you are using a specialized disk to create the virtual machine. FromImage: This value is used when you are using an image to create the virtual machine. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described.

OptionaldeleteOption

deleteOption?: string

Specifies whether OS Disk should be deleted or detached upon VM deletion. Possible values are: Delete. If this value is used, the OS disk is deleted when VM is deleted. Detach. If this value is used, the os disk is retained after VM is deleted. The default value is set to Detach. For an ephemeral OS Disk, the default value is set to Delete. The user cannot change the delete option for an ephemeral OS Disk.

OptionaldiffDiskSettings

diffDiskSettings?: DiffDiskSettings

Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.

OptionaldiskSizeGB

diskSizeGB?: 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. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023.

OptionalencryptionSettings

encryptionSettings?: DiskEncryptionSettings

Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15.

Optionalimage

image?: VirtualHardDisk

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.

OptionalmanagedDisk

managedDisk?: ManagedDiskParameters

The managed disk parameters.

Optionalname

name?: string

The disk name.

OptionalosType

osType?: OperatingSystemTypes

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.

Optionalvhd

vhd?: VirtualHardDisk

The virtual hard disk.

OptionalwriteAcceleratorEnabled

writeAcceleratorEnabled?: boolean

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

Settings

Member Visibility