VirtualMachineScaleSetUpdateOSDisk Class

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

Inheritance

azure.mgmt.compute._serialization.Model

VirtualMachineScaleSetUpdateOSDisk

Constructor

VirtualMachineScaleSetUpdateOSDisk(*, caching: str | _models.CachingTypes | None = None, write_accelerator_enabled: bool | None = None, disk_size_gb: int | None = None, image: _models.VirtualHardDisk | None = None, vhd_containers: List[str] | None = None, managed_disk: _models.VirtualMachineScaleSetManagedDiskParameters | None = None, delete_option: str | _models.DiskDeleteOptionTypes | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
caching	str or 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.
disk_size_gb	int Specifies the size of the operating system disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. <br>``<br> This value cannot be larger than 1023 GB.
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.
vhd_containers	list[str] The list of virtual hard disk container uris.
managed_disk	VirtualMachineScaleSetManagedDiskParameters The managed disk parameters.
delete_option	str or DiskDeleteOptionTypes Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only). <br>``<br> Possible values: <br>``<br> Delete If this value is used, the OS disk is deleted when VMSS Flex VM is deleted.:code: <br> Detach If this value is used, the OS disk is retained after VMSS Flex VM is deleted. <br>``<br> 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".

Variables

Name	Description
caching	str or 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.
disk_size_gb	int Specifies the size of the operating system disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. <br>``<br> This value cannot be larger than 1023 GB.
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.
vhd_containers	list[str] The list of virtual hard disk container uris.
managed_disk	VirtualMachineScaleSetManagedDiskParameters The managed disk parameters.
delete_option	str or DiskDeleteOptionTypes Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only). <br>``<br> Possible values: <br>``<br> Delete If this value is used, the OS disk is deleted when VMSS Flex VM is deleted.:code: <br> Detach If this value is used, the OS disk is retained after VMSS Flex VM is deleted. <br>``<br> 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".