Package version:

Interface VirtualMachineScaleSetOSDisk

Describes a virtual machine scale set operating system disk.

interface VirtualMachineScaleSetOSDisk {
    caching?: CachingTypes;
    createOption: string;
    deleteOption?: string;
    diffDiskSettings?: DiffDiskSettings;
    diskSizeGB?: number;
    image?: VirtualHardDisk;
    managedDisk?: VirtualMachineScaleSetManagedDiskParameters;
    name?: string;
    osType?: OperatingSystemTypes;
    vhdContainers?: string[];
    writeAcceleratorEnabled?: boolean;
}

Properties

caching? createOption deleteOption? diffDiskSettings? diskSizeGB? image? managedDisk? name? osType? vhdContainers? writeAcceleratorEnabled?

Properties

Optionalcaching

caching?: CachingTypes

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

createOption

createOption: string

Specifies how the virtual machines in the scale set should be created. The only allowed value is: FromImage. 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.

OptionaldeleteOption

deleteOption?: string

Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only).

Possible values:

Delete If this value is used, the OS disk is deleted when VMSS Flex VM is deleted.

Detach If this value is used, the OS disk is retained after VMSS Flex VM is deleted.

The default value is set to Delete. For an Ephemeral OS Disk, the default value is set to Delete. User cannot change the delete option for Ephemeral OS Disk.

OptionaldiffDiskSettings

diffDiskSettings?: DiffDiskSettings

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

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.

Optionalimage

image?: VirtualHardDisk

Specifies information about the unmanaged user image to base the scale set on.

OptionalmanagedDisk

managedDisk?: VirtualMachineScaleSetManagedDiskParameters

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.

OptionalvhdContainers

vhdContainers?: string[]

Specifies the container urls that are used to store operating system disks for the scale set.

OptionalwriteAcceleratorEnabled

writeAcceleratorEnabled?: boolean

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

Settings

Member Visibility