-
Notifications
You must be signed in to change notification settings - Fork 234
/
azure.mgmt.compute.v2019_03_01.models.OSDisk.yml
219 lines (175 loc) · 7.56 KB
/
azure.mgmt.compute.v2019_03_01.models.OSDisk.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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
### YamlMime:PythonClass
uid: azure.mgmt.compute.v2019_03_01.models.OSDisk
name: OSDisk
fullName: azure.mgmt.compute.v2019_03_01.models.OSDisk
module: azure.mgmt.compute.v2019_03_01.models
inheritances:
- azure.mgmt.compute._serialization.Model
summary: 'Specifies information about the operating system disk used by the virtual
machine.
`<br>``<br>` For more information about disks, see [About disks and VHDs for Azure
virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).
All required parameters must be populated in order to send to server.'
constructor:
syntax: 'OSDisk(*, create_option: str | _models.DiskCreateOptionTypes, os_type:
str | _models.OperatingSystemTypes | None = None, encryption_settings: _models.DiskEncryptionSettings
| None = None, 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, diff_disk_settings:
_models.DiffDiskSettings | None = None, disk_size_gb: int | None = None, managed_disk:
_models.ManagedDiskParameters | None = None, **kwargs: Any)'
keywordOnlyParameters:
- 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 user-image or a specialized VHD. `<br>``<br>`
Possible values are: `<br>``<br>` **Windows** `<br>``<br>` **Linux**.
Known values are: "Windows" and "Linux".'
types:
- <xref:str>
- <xref:azure.mgmt.compute.v2019_03_01.models.OperatingSystemTypes>
- name: encryption_settings
description: 'Specifies the encryption settings for the OS Disk.
`<br>``<br>` Minimum api-version: 2015-06-15.'
types:
- <xref:azure.mgmt.compute.v2019_03_01.models.DiskEncryptionSettings>
- name: name
description: The disk name.
types:
- <xref:str>
- name: vhd
description: The virtual hard disk.
types:
- <xref:azure.mgmt.compute.v2019_03_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_03_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_03_01.models.CachingTypes>
- name: write_accelerator_enabled
description: 'Specifies whether writeAccelerator should be enabled or
disabled on the disk.'
types:
- <xref:bool>
- name: diff_disk_settings
description: 'Specifies the ephemeral Disk Settings for the operating system
disk used by the virtual machine.'
types:
- <xref:azure.mgmt.compute.v2019_03_01.models.DiffDiskSettings>
- 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.v2019_03_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_03_01.models.ManagedDiskParameters>
variables:
- description: 'This property allows you to specify the type of the OS that is included
in the
disk if creating a VM from user-image or a specialized VHD. `<br>``<br>` Possible
values are: `<br>``<br>` **Windows** `<br>``<br>` **Linux**. Known
values are: "Windows" and "Linux".'
name: os_type
types:
- <xref:str>
- <xref:azure.mgmt.compute.v2019_03_01.models.OperatingSystemTypes>
- description: 'Specifies the encryption settings for the OS Disk.
`<br>``<br>` Minimum api-version: 2015-06-15.'
name: encryption_settings
types:
- <xref:azure.mgmt.compute.v2019_03_01.models.DiskEncryptionSettings>
- description: The disk name.
name: name
types:
- <xref:str>
- description: The virtual hard disk.
name: vhd
types:
- <xref:azure.mgmt.compute.v2019_03_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_03_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_03_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 ephemeral Disk Settings for the operating system disk
used by the virtual machine.'
name: diff_disk_settings
types:
- <xref:azure.mgmt.compute.v2019_03_01.models.DiffDiskSettings>
- 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.v2019_03_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_03_01.models.ManagedDiskParameters>