-
Notifications
You must be signed in to change notification settings - Fork 232
/
azure.mgmt.compute.v2018_04_01.models.VirtualMachine.yml
262 lines (217 loc) · 10.2 KB
/
azure.mgmt.compute.v2018_04_01.models.VirtualMachine.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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
### YamlMime:PythonClass
uid: azure.mgmt.compute.v2018_04_01.models.VirtualMachine
name: VirtualMachine
fullName: azure.mgmt.compute.v2018_04_01.models.VirtualMachine
module: azure.mgmt.compute.v2018_04_01.models
inheritances:
- azure.mgmt.compute.v2018_04_01.models._models_py3.Resource
summary: 'Describes a Virtual Machine.
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: 'VirtualMachine(*, location: str, tags: Dict[str, str] | None = None, plan:
_models.Plan | None = None, identity: _models.VirtualMachineIdentity | None =
None, zones: List[str] | None = None, hardware_profile: _models.HardwareProfile
| None = None, storage_profile: _models.StorageProfile | None = None, os_profile:
_models.OSProfile | None = None, network_profile: _models.NetworkProfile | None
= None, diagnostics_profile: _models.DiagnosticsProfile | None = None, availability_set:
_models.SubResource | None = None, proximity_placement_group: _models.SubResource
| None = None, license_type: str | None = None, **kwargs: Any)'
keywordOnlyParameters:
- name: location
description: Resource location. Required.
types:
- <xref:str>
- name: tags
description: Resource tags.
types:
- <xref:dict>[<xref:str>, <xref:str>]
- name: plan
description: 'Specifies information about the marketplace image used to create
the virtual
machine. This element is only used for marketplace images. Before you can use
a marketplace
image from an API, you must enable the image for programmatic use. In the Azure
portal, find
the marketplace image that you want to use and then click **Want to deploy programmatically,
Get Started ->**. Enter any required information and then click **Save**.'
types:
- <xref:azure.mgmt.compute.v2018_04_01.models.Plan>
- name: identity
description: The identity of the virtual machine, if configured.
types:
- <xref:azure.mgmt.compute.v2018_04_01.models.VirtualMachineIdentity>
- name: zones
description: The virtual machine zones.
types:
- <xref:list>[<xref:str>]
- name: hardware_profile
description: Specifies the hardware settings for the virtual machine.
types:
- <xref:azure.mgmt.compute.v2018_04_01.models.HardwareProfile>
- name: storage_profile
description: Specifies the storage settings for the virtual machine disks.
types:
- <xref:azure.mgmt.compute.v2018_04_01.models.StorageProfile>
- name: os_profile
description: Specifies the operating system settings for the virtual machine.
types:
- <xref:azure.mgmt.compute.v2018_04_01.models.OSProfile>
- name: network_profile
description: Specifies the network interfaces of the virtual machine.
types:
- <xref:azure.mgmt.compute.v2018_04_01.models.NetworkProfile>
- name: diagnostics_profile
description: 'Specifies the boot diagnostic settings state.
`<br>`:code:>>`<<<br>`Minimum api-version: 2015-06-15.'
types:
- <xref:azure.mgmt.compute.v2018_04_01.models.DiagnosticsProfile>
- name: availability_set
description: 'Specifies information about the availability set that the virtual
machine should be assigned to. Virtual machines specified in the same availability
set are
allocated to different nodes to maximize availability. For more information
about availability
sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). #
pylint: disable=line-too-long
`<br>``<br>` For more information on Azure planned maintenance, see [Planned
maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) #
pylint: disable=line-too-long
`<br>``<br>` Currently, a VM can only be added to availability set at creation
time. An existing VM cannot be added to an availability set.'
types:
- <xref:azure.mgmt.compute.v2018_04_01.models.SubResource>
- name: proximity_placement_group
description: 'Specifies information about the proximity placement group
that the virtual machine should be assigned to. `<br>`:code:>>`<<<br>`Minimum
api-version:
2018-04-01.'
types:
- <xref:azure.mgmt.compute.v2018_04_01.models.SubResource>
- name: license_type
description: 'Specifies that the image or disk that is being used was licensed
on-premises. This element is only used for images that contain the Windows Server
operating
system. `<br>``<br>` Possible values are: `<br>``<br>` Windows_Client
`<br>``<br>` Windows_Server `<br>``<br>` If this element is included in
a request for an update, the value must match the initial value. This value
cannot be updated.
`<br>``<br>` For more information, see [Azure Hybrid Use Benefit for Windows
Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) #
pylint: disable=line-too-long
`<br>``<br>` Minimum api-version: 2015-06-15.'
types:
- <xref:str>
variables:
- description: Resource Id.
name: id
types:
- <xref:str>
- description: Resource name.
name: name
types:
- <xref:str>
- description: Resource type.
name: type
types:
- <xref:str>
- description: Resource location. Required.
name: location
types:
- <xref:str>
- description: Resource tags.
name: tags
types:
- <xref:dict>[<xref:str>, <xref:str>]
- description: 'Specifies information about the marketplace image used to create the
virtual
machine. This element is only used for marketplace images. Before you can use
a marketplace
image from an API, you must enable the image for programmatic use. In the Azure
portal, find
the marketplace image that you want to use and then click **Want to deploy programmatically,
Get Started ->**. Enter any required information and then click **Save**.'
name: plan
types:
- <xref:azure.mgmt.compute.v2018_04_01.models.Plan>
- description: The virtual machine child extension resources.
name: resources
types:
- <xref:list>[<xref:azure.mgmt.compute.v2018_04_01.models.VirtualMachineExtension>]
- description: The identity of the virtual machine, if configured.
name: identity
types:
- <xref:azure.mgmt.compute.v2018_04_01.models.VirtualMachineIdentity>
- description: The virtual machine zones.
name: zones
types:
- <xref:list>[<xref:str>]
- description: Specifies the hardware settings for the virtual machine.
name: hardware_profile
types:
- <xref:azure.mgmt.compute.v2018_04_01.models.HardwareProfile>
- description: Specifies the storage settings for the virtual machine disks.
name: storage_profile
types:
- <xref:azure.mgmt.compute.v2018_04_01.models.StorageProfile>
- description: Specifies the operating system settings for the virtual machine.
name: os_profile
types:
- <xref:azure.mgmt.compute.v2018_04_01.models.OSProfile>
- description: Specifies the network interfaces of the virtual machine.
name: network_profile
types:
- <xref:azure.mgmt.compute.v2018_04_01.models.NetworkProfile>
- description: 'Specifies the boot diagnostic settings state.
`<br>`:code:>>`<<<br>`Minimum api-version: 2015-06-15.'
name: diagnostics_profile
types:
- <xref:azure.mgmt.compute.v2018_04_01.models.DiagnosticsProfile>
- description: 'Specifies information about the availability set that the virtual
machine should be assigned to. Virtual machines specified in the same availability
set are
allocated to different nodes to maximize availability. For more information about
availability
sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). #
pylint: disable=line-too-long
`<br>``<br>` For more information on Azure planned maintenance, see [Planned
maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) #
pylint: disable=line-too-long
`<br>``<br>` Currently, a VM can only be added to availability set at creation
time. An existing VM cannot be added to an availability set.'
name: availability_set
types:
- <xref:azure.mgmt.compute.v2018_04_01.models.SubResource>
- description: 'Specifies information about the proximity placement group that
the virtual machine should be assigned to. `<br>`:code:>>`<<<br>`Minimum api-version:
2018-04-01.'
name: proximity_placement_group
types:
- <xref:azure.mgmt.compute.v2018_04_01.models.SubResource>
- description: The provisioning state, which only appears in the response.
name: provisioning_state
types:
- <xref:str>
- description: The virtual machine instance view.
name: instance_view
types:
- <xref:azure.mgmt.compute.v2018_04_01.models.VirtualMachineInstanceView>
- description: 'Specifies that the image or disk that is being used was licensed
on-premises. This element is only used for images that contain the Windows Server
operating
system. `<br>``<br>` Possible values are: `<br>``<br>` Windows_Client
`<br>``<br>` Windows_Server `<br>``<br>` If this element is included in
a request for an update, the value must match the initial value. This value cannot
be updated.
`<br>``<br>` For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) #
pylint: disable=line-too-long
`<br>``<br>` Minimum api-version: 2015-06-15.'
name: license_type
types:
- <xref:str>
- description: 'Specifies the VM unique ID which is a 128-bits identifier that is
encoded and
stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands.'
name: vm_id
types:
- <xref:str>