Share via

VirtualMachineScaleSetUpdateOSDisk Class

  • Reference

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

Constructor

VirtualMachineScaleSetUpdateOSDisk(*, caching: str | _models.CachingTypes | None = None, write_accelerator_enabled: bool | None = None, diff_disk_settings: _models.DiffDiskSettings | 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".

Default value: None
write_accelerator_enabled
bool

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

Default value: None
diff_disk_settings
DiffDiskSettings

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

Default value: None
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. <br>``<br> diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023.

Default value: None
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.

Default value: None
vhd_containers
list[str]

The list of virtual hard disk container uris.

Default value: None
managed_disk
VirtualMachineScaleSetManagedDiskParameters

The managed disk parameters.

Default value: None
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.<br>``<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".

Default value: None

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.
diff_disk_settings
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. <br>``<br> diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023.
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.<br>``<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".