-
Notifications
You must be signed in to change notification settings - Fork 232
/
azure.mgmt.compute.v2019_07_01.models.DataDisk.yml
195 lines (165 loc) · 6.96 KB
/
azure.mgmt.compute.v2019_07_01.models.DataDisk.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
### YamlMime:PythonClass
uid: azure.mgmt.compute.v2019_07_01.models.DataDisk
name: DataDisk
fullName: azure.mgmt.compute.v2019_07_01.models.DataDisk
module: azure.mgmt.compute.v2019_07_01.models
inheritances:
- azure.mgmt.compute._serialization.Model
summary: 'Describes a data disk.
Variables are only populated by the server, and will be ignored when sending a request.
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, to_be_detached: bool | 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.v2019_07_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.v2019_07_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.v2019_07_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\ncreated.:code:*<br>*`<br>`\
\ Possible values are:`<br>``<br>` **Attach** \u2013\nThis value is used when\
\ you are using a specialized disk to create the virtual\nmachine.:code:*<br>*`<br>`\
\ **FromImage** \u2013 This value is used when you are using an\nimage to create\
\ the virtual machine. If you are using a platform image, you also use the\n\
imageReference element described above. If you are using a marketplace image,\
\ you also use the\nplan element previously described. Required. Known values\
\ are: \"FromImage\", \"Empty\", and\n\"Attach\"."
types:
- <xref:str>
- <xref:azure.mgmt.compute.v2019_07_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.v2019_07_01.models.ManagedDiskParameters>
- name: to_be_detached
description: 'Specifies whether the data disk is in process of detachment from
the
VirtualMachine/VirtualMachineScaleset.'
types:
- <xref:bool>
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.v2019_07_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.v2019_07_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.v2019_07_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\ncreated.:code:*<br>*`<br>`\
\ Possible values are:`<br>``<br>` **Attach** \u2013\nThis value is used when\
\ you are using a specialized disk to create the virtual\nmachine.:code:*<br>*`<br>`\
\ **FromImage** \u2013 This value is used when you are using an\nimage to create\
\ the virtual machine. If you are using a platform image, you also use the\nimageReference\
\ element described above. If you are using a marketplace image, you also use\
\ the\nplan element previously described. Required. Known values are: \"FromImage\"\
, \"Empty\", and\n\"Attach\"."
name: create_option
types:
- <xref:str>
- <xref:azure.mgmt.compute.v2019_07_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.v2019_07_01.models.ManagedDiskParameters>
- description: 'Specifies whether the data disk is in process of detachment from the
VirtualMachine/VirtualMachineScaleset.'
name: to_be_detached
types:
- <xref:bool>
- description: 'Specifies the Read-Write IOPS for the managed disk when
StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet
VM disks. Can be
updated only via updates to the VirtualMachine Scale Set.'
name: disk_iops_read_write
types:
- <xref:int>
- description: 'Specifies the bandwidth in MB per second for the managed disk when
StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet
VM disks. Can be
updated only via updates to the VirtualMachine Scale Set.'
name: disk_m_bps_read_write
types:
- <xref:int>