VirtualMachineScaleSetOSDisk Class

Describes a virtual machine scale set operating system disk.

Constructor

VirtualMachineScaleSetOSDisk()

Variables

Name	Description
name	str The disk name.
caching	Union[str, <xref:"CachingTypes">] Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage.. Known values are: "None", "ReadOnly", and "ReadWrite".
write_accelerator_enabled	bool Specifies whether writeAccelerator should be enabled or disabled on the disk.
create_option	Union[str, <xref:"DiskCreateOptionTypes">] 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. Required. Known values are: "FromImage", "Empty", "Attach", "Copy", and "Restore".
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. The property '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".
os_type	Union[str, <xref:"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.. Known values are: "Windows" and "Linux".
image	<xref:<xref:"VirtualHardDisk">> Specifies information about the unmanaged user image to base the scale set on.
vhd_containers	list[str] Specifies the container urls that are used to store operating system disks for the scale set.
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, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage.. Known values are: "None", "ReadOnly", and "ReadWrite".

caching: str | CachingTypes

createOption

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. Required. Known values are: "FromImage", "Empty", "Attach", "Copy", and "Restore".

createOption: Required[str | DiskCreateOptionTypes]

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

diskSizeGB: int

image

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

image: VirtualHardDisk

managedDisk

The managed disk parameters.

managedDisk: VirtualMachineScaleSetManagedDiskParameters

name

The disk name.

name: str

osType

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.. Known values are: "Windows" and "Linux".

osType: str | OperatingSystemTypes

storageFaultDomainAlignment

"Aligned" and "BestEffortAligned".

storageFaultDomainAlignment: str | StorageFaultDomainAlignmentType

vhdContainers

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

vhdContainers: list[str]

writeAcceleratorEnabled

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

writeAcceleratorEnabled: bool

Feedback

Was this page helpful?