Package version:

Interface VirtualMachineScaleSetUpdateOSDisk

Describes virtual machine scale set operating system disk Update Object. This should be used for Updating VMSS OS Disk.

interface VirtualMachineScaleSetUpdateOSDisk {
    caching?: CachingTypes;
    deleteOption?: string;
    diffDiskSettings?: DiffDiskSettings;
    diskSizeGB?: number;
    image?: VirtualHardDisk;
    managedDisk?: VirtualMachineScaleSetManagedDiskParameters;
    vhdContainers?: string[];
    writeAcceleratorEnabled?: boolean;
}

Properties

caching? deleteOption? diffDiskSettings? diskSizeGB? image? managedDisk? vhdContainers? writeAcceleratorEnabled?

Properties

Optionalcaching

caching?: CachingTypes

The caching type.

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.

diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023

Optionalimage

image?: VirtualHardDisk

The Source User Image VirtualHardDisk. This VirtualHardDisk will be copied before using it to attach to the Virtual Machine. If SourceImage is provided, the destination VirtualHardDisk should not exist.

OptionalmanagedDisk

managedDisk?: VirtualMachineScaleSetManagedDiskParameters

The managed disk parameters.

OptionalvhdContainers

vhdContainers?: string[]

The list of virtual hard disk container uris.

OptionalwriteAcceleratorEnabled

writeAcceleratorEnabled?: boolean

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

Settings

Member Visibility