VirtualMachineScaleSetUpdateOSDisk Class

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

Constructor

VirtualMachineScaleSetUpdateOSDisk()

Variables

Name	Description
caching	Union[str, <xref:"CachingTypes">] The caching type. Known values are: "None", "ReadOnly", and "ReadWrite".
write_accelerator_enabled	bool Specifies whether writeAccelerator should be enabled or disabled on the disk.
diff_disk_settings	<xref:<xref:"DiffDiskSettings">> Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set.
disk_size_gb	int 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.
storage_fault_domain_alignment	Union[str, <xref:"StorageFaultDomainAlignmentType">] Specifies the storage fault domain alignment type for the disk. Known values are: "Aligned" and "BestEffortAligned".
image	<xref:<xref:"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.
vhd_containers	list[str] The list of virtual hard disk container uris.
managed_disk	<xref:<xref:"VirtualMachineScaleSetManagedDiskParameters">> The managed disk parameters.
delete_option	Union[str, <xref:"DiskDeleteOptionTypes">] 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. Known values are: "Delete" and "Detach".

Attributes

caching

"None", "ReadOnly", and "ReadWrite".

caching: str | CachingTypes

deleteOption

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. Known values are: "Delete" and "Detach".

deleteOption: str | DiskDeleteOptionTypes

diffDiskSettings

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

diffDiskSettings: DiffDiskSettings

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.

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

diskSizeGB: int

image

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.

image: VirtualHardDisk

managedDisk

The managed disk parameters.

managedDisk: VirtualMachineScaleSetManagedDiskParameters

storageFaultDomainAlignment

"Aligned" and "BestEffortAligned".

storageFaultDomainAlignment: str | StorageFaultDomainAlignmentType

vhdContainers

The list of virtual hard disk container uris.

vhdContainers: list[str]

writeAcceleratorEnabled

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

writeAcceleratorEnabled: bool