azure.mgmt.compute.v2023_09_01.models.ImageOSDisk.yml

### YamlMime:PythonClass
uid: azure.mgmt.compute.v2023_09_01.models.ImageOSDisk
name: ImageOSDisk
fullName: azure.mgmt.compute.v2023_09_01.models.ImageOSDisk
module: azure.mgmt.compute.v2023_09_01.models
inheritances:
- azure.mgmt.compute.v2023_09_01.models._models_py3.ImageDisk
summary: 'Describes an Operating System disk.


  All required parameters must be populated in order to send to server.'
constructor:
  syntax: '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)'
  keywordOnlyParameters:
  - name: snapshot
    description: The snapshot.
    types:
    - <xref:azure.mgmt.compute.v2023_09_01.models.SubResource>
  - name: managed_disk
    description: The managedDisk.
    types:
    - <xref:azure.mgmt.compute.v2023_09_01.models.SubResource>
  - name: blob_uri
    description: The Virtual Hard Disk.
    types:
    - <xref:str>
  - name: caching
    description: '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".'
    types:
    - <xref:str>
    - <xref:azure.mgmt.compute.v2023_09_01.models.CachingTypes>
  - name: disk_size_gb
    description: '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. This value
      cannot be larger

      than 1023 GB.'
    types:
    - <xref:int>
  - name: storage_account_type
    description: '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".'
    types:
    - <xref:str>
    - <xref:azure.mgmt.compute.v2023_09_01.models.StorageAccountTypes>
  - name: disk_encryption_set
    description: 'Specifies the customer managed disk encryption set resource id

      for the managed image disk.'
    types:
    - <xref:azure.mgmt.compute.v2023_09_01.models.DiskEncryptionSetParameters>
  - name: os_type
    description: '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. Possible values are: **Windows,**
      **Linux.**.

      Required. Known values are: "Windows" and "Linux".'
    types:
    - <xref:str>
    - <xref:azure.mgmt.compute.v2023_09_01.models.OperatingSystemTypes>
  - name: os_state
    description: 'The OS State. For managed images, use Generalized. Required. Known
      values

      are: "Generalized" and "Specialized".'
    types:
    - <xref:str>
    - <xref:azure.mgmt.compute.v2023_09_01.models.OperatingSystemStateTypes>
variables:
- description: The snapshot.
  name: snapshot
  types:
  - <xref:azure.mgmt.compute.v2023_09_01.models.SubResource>
- description: The managedDisk.
  name: managed_disk
  types:
  - <xref:azure.mgmt.compute.v2023_09_01.models.SubResource>
- description: The Virtual Hard Disk.
  name: blob_uri
  types:
  - <xref:str>
- description: '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".'
  name: caching
  types:
  - <xref:str>
  - <xref:azure.mgmt.compute.v2023_09_01.models.CachingTypes>
- description: '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. This value
    cannot be larger

    than 1023 GB.'
  name: disk_size_gb
  types:
  - <xref:int>
- description: '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".'
  name: storage_account_type
  types:
  - <xref:str>
  - <xref:azure.mgmt.compute.v2023_09_01.models.StorageAccountTypes>
- description: 'Specifies the customer managed disk encryption set resource id for

    the managed image disk.'
  name: disk_encryption_set
  types:
  - <xref:azure.mgmt.compute.v2023_09_01.models.DiskEncryptionSetParameters>
- description: '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. Possible values are: **Windows,** **Linux.**.

    Required. Known values are: "Windows" and "Linux".'
  name: os_type
  types:
  - <xref:str>
  - <xref:azure.mgmt.compute.v2023_09_01.models.OperatingSystemTypes>
- description: 'The OS State. For managed images, use Generalized. Required. Known
    values are:

    "Generalized" and "Specialized".'
  name: os_state
  types:
  - <xref:str>
  - <xref:azure.mgmt.compute.v2023_09_01.models.OperatingSystemStateTypes>