VirtualMachineScaleSetOSDisk Class

Describes a virtual machine scale set operating system disk.

Constructor

VirtualMachineScaleSetOSDisk(*args: Any, **kwargs: Any)

Variables

Name Description
name
str

The disk name.
caching
str or 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
str or 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
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
str or StorageFaultDomainAlignmentType

Specifies the storage fault domain alignment type for the disk. Known values are: "Aligned" and "BestEffortAligned".
os_type
str or 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
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
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).

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 | _models.CachingTypes | None

create_option

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".

create_option: str | _models.DiskCreateOptionTypes

delete_option

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".

delete_option: str | _models.DiskDeleteOptionTypes | None

diff_disk_settings

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

diff_disk_settings: _models.DiffDiskSettings | None

disk_size_gb

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.

disk_size_gb: int | None

image

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

image: _models.VirtualHardDisk | None

managed_disk

The managed disk parameters.

managed_disk: _models.VirtualMachineScaleSetManagedDiskParameters | None

name

The disk name.

name: str | None

os_type

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".

os_type: str | _models.OperatingSystemTypes | None

storage_fault_domain_alignment

"Aligned" and "BestEffortAligned".

storage_fault_domain_alignment: str | _models.StorageFaultDomainAlignmentType | None

vhd_containers

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

vhd_containers: list[str] | None

write_accelerator_enabled

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

write_accelerator_enabled: bool | None