azure.mgmt.compute.v2018_06_01.models.DataDisk.yml

### YamlMime:PythonClass
uid: azure.mgmt.compute.v2018_06_01.models.DataDisk
name: DataDisk
fullName: azure.mgmt.compute.v2018_06_01.models.DataDisk
module: azure.mgmt.compute.v2018_06_01.models
inheritances:
- azure.mgmt.compute._serialization.Model
summary: 'Describes a data disk.


  All required parameters must be populated in order to send to server.'
constructor:
  syntax: 'DataDisk(*, lun: int, create_option: str | _models.DiskCreateOptionTypes,
    name: str | None = None, vhd: _models.VirtualHardDisk | None = None, image: _models.VirtualHardDisk
    | None = None, caching: str | _models.CachingTypes | None = None, write_accelerator_enabled:
    bool | None = None, disk_size_gb: int | None = None, managed_disk: _models.ManagedDiskParameters
    | None = None, **kwargs: Any)'
  keywordOnlyParameters:
  - name: lun
    description: 'Specifies the logical unit number of the data disk. This value is
      used to

      identify data disks within the VM and therefore must be unique for each data
      disk attached to a

      VM. Required.'
    types:
    - <xref:int>
  - name: name
    description: The disk name.
    types:
    - <xref:str>
  - name: vhd
    description: The virtual hard disk.
    types:
    - <xref:azure.mgmt.compute.v2018_06_01.models.VirtualHardDisk>
  - name: image
    description: 'The source user image virtual hard disk. The virtual hard disk will
      be copied

      before being attached to the virtual machine. If SourceImage is provided, the
      destination

      virtual hard drive must not exist.'
    types:
    - <xref:azure.mgmt.compute.v2018_06_01.models.VirtualHardDisk>
  - name: caching
    description: '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".'
    types:
    - <xref:str>
    - <xref:azure.mgmt.compute.v2018_06_01.models.CachingTypes>
  - name: write_accelerator_enabled
    description: 'Specifies whether writeAccelerator should be enabled or

      disabled on the disk.'
    types:
    - <xref:bool>
  - name: create_option
    description: 'Specifies how the virtual machine should be

      created.:code:*<br>*`<br>` Possible values are:`<br>``<br>` **Attach**

      u2013 This value is used when you are using a specialized disk to create the
      virtual

      machine.:code:*<br>*`<br>` **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".'
    types:
    - <xref:str>
    - <xref:azure.mgmt.compute.v2018_06_01.models.DiskCreateOptionTypes>
  - 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>`

      This value cannot be larger than 1023 GB.'
    types:
    - <xref:int>
  - name: managed_disk
    description: The managed disk parameters.
    types:
    - <xref:azure.mgmt.compute.v2018_06_01.models.ManagedDiskParameters>
variables:
- description: 'Specifies the logical unit number of the data disk. This value is
    used to identify

    data disks within the VM and therefore must be unique for each data disk attached
    to a VM.

    Required.'
  name: lun
  types:
  - <xref:int>
- description: The disk name.
  name: name
  types:
  - <xref:str>
- description: The virtual hard disk.
  name: vhd
  types:
  - <xref:azure.mgmt.compute.v2018_06_01.models.VirtualHardDisk>
- description: 'The source user image virtual hard disk. The virtual hard disk will
    be copied

    before being attached to the virtual machine. If SourceImage is provided, the
    destination

    virtual hard drive must not exist.'
  name: image
  types:
  - <xref:azure.mgmt.compute.v2018_06_01.models.VirtualHardDisk>
- description: '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".'
  name: caching
  types:
  - <xref:str>
  - <xref:azure.mgmt.compute.v2018_06_01.models.CachingTypes>
- description: 'Specifies whether writeAccelerator should be enabled or

    disabled on the disk.'
  name: write_accelerator_enabled
  types:
  - <xref:bool>
- description: 'Specifies how the virtual machine should be

    created.:code:*<br>*`<br>` Possible values are:`<br>``<br>` **Attach**

    u2013 This value is used when you are using a specialized disk to create the virtual

    machine.:code:*<br>*`<br>` **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".'
  name: create_option
  types:
  - <xref:str>
  - <xref:azure.mgmt.compute.v2018_06_01.models.DiskCreateOptionTypes>
- 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>`

    This value cannot be larger than 1023 GB.'
  name: disk_size_gb
  types:
  - <xref:int>
- description: The managed disk parameters.
  name: managed_disk
  types:
  - <xref:azure.mgmt.compute.v2018_06_01.models.ManagedDiskParameters>