Share via

VirtualMachineScaleSetOSDisk Class

  • Reference

Describes a virtual machine scale set operating system disk.

All required parameters must be populated in order to send to server.

Inheritance
azure.mgmt.compute._serialization.Model
VirtualMachineScaleSetOSDisk

Constructor

VirtualMachineScaleSetOSDisk(*, create_option: str | _models.DiskCreateOptionTypes, name: str | None = None, caching: str | _models.CachingTypes | None = None, os_type: str | _models.OperatingSystemTypes | None = None, image: _models.VirtualHardDisk | None = None, vhd_containers: List[str] | None = None, managed_disk: _models.VirtualMachineScaleSetManagedDiskParameters | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
name
str

The disk name.
caching
str or CachingTypes

Specifies the caching requirements. <br>``<br> Possible values are: <br>``<br> None <br>``<br> ReadOnly <br>``<br> ReadWrite <br>``<br> Default: None for Standard storage. ReadOnly for Premium storage. Known values are: "None", "ReadOnly", and "ReadWrite".
create_option
str or DiskCreateOptionTypes

Specifies how the virtual machines in the scale set should be created.:code:
<br> The only allowed value is: FromImage u2013 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", and "Attach".
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. <br>``<br> Possible values are: <br>``<br> Windows <br>``<br> Linux. Known values are: "Windows" and "Linux".
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.

Variables

Name Description
name
str

The disk name.
caching
str or CachingTypes

Specifies the caching requirements. <br>``<br> Possible values are: <br>``<br> None <br>``<br> ReadOnly <br>``<br> ReadWrite <br>``<br> Default: None for Standard storage. ReadOnly for Premium storage. Known values are: "None", "ReadOnly", and "ReadWrite".
create_option
str or DiskCreateOptionTypes

Specifies how the virtual machines in the scale set should be created.:code:
<br> The only allowed value is: FromImage u2013 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", and "Attach".
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. <br>``<br> Possible values are: <br>``<br> Windows <br>``<br> Linux. Known values are: "Windows" and "Linux".
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.