azure.mgmt.compute.v2023_09_01.models.VirtualMachineScaleSetUpdateOSDisk.yml

### YamlMime:PythonClass
uid: azure.mgmt.compute.v2023_09_01.models.VirtualMachineScaleSetUpdateOSDisk
name: VirtualMachineScaleSetUpdateOSDisk
fullName: azure.mgmt.compute.v2023_09_01.models.VirtualMachineScaleSetUpdateOSDisk
module: azure.mgmt.compute.v2023_09_01.models
inheritances:
- azure.mgmt.compute._serialization.Model
summary: 'Describes virtual machine scale set operating system disk Update Object.
  This should be used

  for Updating VMSS OS Disk.'
constructor:
  syntax: 'VirtualMachineScaleSetUpdateOSDisk(*, caching: str | _models.CachingTypes
    | None = None, write_accelerator_enabled: bool | None = None, disk_size_gb: int
    | None = None, image: _models.VirtualHardDisk | None = None, vhd_containers: List[str]
    | None = None, managed_disk: _models.VirtualMachineScaleSetManagedDiskParameters
    | None = None, delete_option: str | _models.DiskDeleteOptionTypes | None = None,
    **kwargs: Any)'
  keywordOnlyParameters:
  - name: caching
    description: 'The caching type. Known values are: "None", "ReadOnly", and "ReadWrite".'
    types:
    - <xref:str>
    - <xref:azure.mgmt.compute.v2023_09_01.models.CachingTypes>
  - name: write_accelerator_enabled
    description: 'Specifies whether writeAccelerator should be enabled or

      disabled on the disk.'
    types:
    - <xref:bool>
  - name: disk_size_gb
    description: '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. `<br>``<br>`

      diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot
      be larger than

      1023.'
    types:
    - <xref:int>
  - name: image
    description: '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.'
    types:
    - <xref:azure.mgmt.compute.v2023_09_01.models.VirtualHardDisk>
  - name: vhd_containers
    description: The list of virtual hard disk container uris.
    types:
    - <xref:list>[<xref:str>]
  - name: managed_disk
    description: The managed disk parameters.
    types:
    - <xref:azure.mgmt.compute.v2023_09_01.models.VirtualMachineScaleSetManagedDiskParameters>
  - name: delete_option
    description: 'Specifies whether OS Disk should be deleted or detached upon VMSS
      Flex

      deletion (This feature is available for VMSS with Flexible OrchestrationMode
      only).

      `<br>``<br>` Possible values: `<br>``<br>` **Delete** If this value is

      used, the OS disk is deleted when VMSS Flex VM is deleted.:code:*<br>*`<br>`
      **Detach**

      If this value is used, the OS disk is retained after VMSS Flex VM is deleted.

      `<br>``<br>` 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".'
    types:
    - <xref:str>
    - <xref:azure.mgmt.compute.v2023_09_01.models.DiskDeleteOptionTypes>
variables:
- description: 'The caching type. Known values are: "None", "ReadOnly", and "ReadWrite".'
  name: caching
  types:
  - <xref:str>
  - <xref:azure.mgmt.compute.v2023_09_01.models.CachingTypes>
- description: 'Specifies whether writeAccelerator should be enabled or

    disabled on the disk.'
  name: write_accelerator_enabled
  types:
  - <xref:bool>
- description: '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. `<br>``<br>`

    diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be
    larger than

    1023.'
  name: disk_size_gb
  types:
  - <xref:int>
- description: '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.'
  name: image
  types:
  - <xref:azure.mgmt.compute.v2023_09_01.models.VirtualHardDisk>
- description: The list of virtual hard disk container uris.
  name: vhd_containers
  types:
  - <xref:list>[<xref:str>]
- description: The managed disk parameters.
  name: managed_disk
  types:
  - <xref:azure.mgmt.compute.v2023_09_01.models.VirtualMachineScaleSetManagedDiskParameters>
- description: 'Specifies whether OS Disk should be deleted or detached upon VMSS
    Flex

    deletion (This feature is available for VMSS with Flexible OrchestrationMode only).

    `<br>``<br>` Possible values: `<br>``<br>` **Delete** If this value is

    used, the OS disk is deleted when VMSS Flex VM is deleted.:code:*<br>*`<br>` **Detach**

    If this value is used, the OS disk is retained after VMSS Flex VM is deleted.

    `<br>``<br>` 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".'
  name: delete_option
  types:
  - <xref:str>
  - <xref:azure.mgmt.compute.v2023_09_01.models.DiskDeleteOptionTypes>