Share via

ImageOSDisk Class

  • Reference

Describes an Operating System disk.

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

Inheritance
azure.mgmt.compute.v2022_03_01.models._models_py3.ImageDisk
ImageOSDisk

Constructor

ImageOSDisk(*, os_type: str | _models.OperatingSystemTypes, os_state: str | _models.OperatingSystemStateTypes, snapshot: _models.SubResource | None = None, managed_disk: _models.SubResource | None = None, blob_uri: str | None = None, caching: str | _models.CachingTypes | None = None, disk_size_gb: int | None = None, storage_account_type: str | _models.StorageAccountTypes | None = None, disk_encryption_set: _models.DiskEncryptionSetParameters | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
snapshot
SubResource

The snapshot.
managed_disk
SubResource

The managedDisk.
blob_uri
str

The Virtual Hard Disk.
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".
disk_size_gb
int

Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. <br>``<br> This value cannot be larger than 1023 GB.
storage_account_type
str or StorageAccountTypes

Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. Known values are: "Standard_LRS", "Premium_LRS", "StandardSSD_LRS", "UltraSSD_LRS", "Premium_ZRS", "StandardSSD_ZRS", and "PremiumV2_LRS".
disk_encryption_set
DiskEncryptionSetParameters

Specifies the customer managed disk encryption set resource id for the managed image disk.
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 a custom image. <br>``<br> Possible values are: <br>``<br> Windows <br>``<br> Linux. Required. Known values are: "Windows" and "Linux".
os_state
str or OperatingSystemStateTypes

The OS State. For managed images, use Generalized. Required. Known values are: "Generalized" and "Specialized".

Variables

Name Description
snapshot
SubResource

The snapshot.
managed_disk
SubResource

The managedDisk.
blob_uri
str

The Virtual Hard Disk.
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".
disk_size_gb
int

Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. <br>``<br> This value cannot be larger than 1023 GB.
storage_account_type
str or StorageAccountTypes

Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. Known values are: "Standard_LRS", "Premium_LRS", "StandardSSD_LRS", "UltraSSD_LRS", "Premium_ZRS", "StandardSSD_ZRS", and "PremiumV2_LRS".
disk_encryption_set
DiskEncryptionSetParameters

Specifies the customer managed disk encryption set resource id for the managed image disk.
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 a custom image. <br>``<br> Possible values are: <br>``<br> Windows <br>``<br> Linux. Required. Known values are: "Windows" and "Linux".
os_state
str or OperatingSystemStateTypes

The OS State. For managed images, use Generalized. Required. Known values are: "Generalized" and "Specialized".