-
Notifications
You must be signed in to change notification settings - Fork 232
/
azure.mgmt.compute.v2023_03_01.models.VirtualMachineScaleSetVM.yml
330 lines (276 loc) · 12.2 KB
/
azure.mgmt.compute.v2023_03_01.models.VirtualMachineScaleSetVM.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
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
### YamlMime:PythonClass
uid: azure.mgmt.compute.v2023_03_01.models.VirtualMachineScaleSetVM
name: VirtualMachineScaleSetVM
fullName: azure.mgmt.compute.v2023_03_01.models.VirtualMachineScaleSetVM
module: azure.mgmt.compute.v2023_03_01.models
inheritances:
- azure.mgmt.compute.v2023_03_01.models._models_py3.Resource
summary: 'Describes a virtual machine scale set 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: 'VirtualMachineScaleSetVM(*, location: str, tags: Dict[str, str] | None
= None, plan: _models.Plan | None = None, identity: _models.VirtualMachineIdentity
| None = None, hardware_profile: _models.HardwareProfile | None = None, storage_profile:
_models.StorageProfile | None = None, additional_capabilities: _models.AdditionalCapabilities
| None = None, os_profile: _models.OSProfile | None = None, security_profile:
_models.SecurityProfile | None = None, network_profile: _models.NetworkProfile
| None = None, network_profile_configuration: _models.VirtualMachineScaleSetVMNetworkProfileConfiguration
| None = None, diagnostics_profile: _models.DiagnosticsProfile | None = None,
availability_set: _models.SubResource | None = None, license_type: str | None
= None, protection_policy: _models.VirtualMachineScaleSetVMProtectionPolicy |
None = None, user_data: 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.v2023_03_01.models.Plan>
- name: identity
description: The identity of the virtual machine, if configured.
types:
- <xref:azure.mgmt.compute.v2023_03_01.models.VirtualMachineIdentity>
- name: hardware_profile
description: Specifies the hardware settings for the virtual machine.
types:
- <xref:azure.mgmt.compute.v2023_03_01.models.HardwareProfile>
- name: storage_profile
description: Specifies the storage settings for the virtual machine disks.
types:
- <xref:azure.mgmt.compute.v2023_03_01.models.StorageProfile>
- name: additional_capabilities
description: 'Specifies additional capabilities enabled or disabled on the
virtual machine in the scale set. For instance: whether the virtual machine
has the capability
to support attaching managed data disks with UltraSSD_LRS storage account type.'
types:
- <xref:azure.mgmt.compute.v2023_03_01.models.AdditionalCapabilities>
- name: os_profile
description: Specifies the operating system settings for the virtual machine.
types:
- <xref:azure.mgmt.compute.v2023_03_01.models.OSProfile>
- name: security_profile
description: 'Specifies the Security related profile settings for the virtual
machine.'
types:
- <xref:azure.mgmt.compute.v2023_03_01.models.SecurityProfile>
- name: network_profile
description: Specifies the network interfaces of the virtual machine.
types:
- <xref:azure.mgmt.compute.v2023_03_01.models.NetworkProfile>
- name: network_profile_configuration
description: 'Specifies the network profile configuration of the
virtual machine.'
types:
- <xref:azure.mgmt.compute.v2023_03_01.models.VirtualMachineScaleSetVMNetworkProfileConfiguration>
- name: diagnostics_profile
description: 'Specifies the boot diagnostic settings state. Minimum
api-version: 2015-06-15.'
types:
- <xref:azure.mgmt.compute.v2023_03_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 [Availability sets overview](https://docs.microsoft.com/azure/virtual-machines/availability-set-overview).
For more
information on Azure planned maintenance, see [Maintenance and updates for Virtual
Machines in
Azure](https://docs.microsoft.com/azure/virtual-machines/maintenance-and-updates).
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.v2023_03_01.models.SubResource>
- name: license_type
description: 'Specifies that the image or disk that is being used was licensed
on-premises. `<br>``<br>` Possible values for Windows Server operating system
are:
`<br>``<br>` Windows_Client `<br>``<br>` Windows_Server
`<br>``<br>` Possible values for Linux Server operating system are:
`<br>``<br>` RHEL_BYOS (for RHEL) `<br>``<br>` SLES_BYOS (for SUSE)
`<br>``<br>` For more information, see [Azure Hybrid Use Benefit for Windows
Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)
`<br>``<br>` [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)
`<br>``<br>` Minimum api-version: 2015-06-15.'
types:
- <xref:str>
- name: protection_policy
description: Specifies the protection policy of the virtual machine.
types:
- <xref:azure.mgmt.compute.v2023_03_01.models.VirtualMachineScaleSetVMProtectionPolicy>
- name: user_data
description: 'UserData for the VM, which must be base-64 encoded. Customer should
not
pass any secrets in here. `<br>`:code:>>`<<<br>`Minimum api-version: 2021-03-01.'
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: The virtual machine instance ID.
name: instance_id
types:
- <xref:str>
- description: The virtual machine SKU.
name: sku
types:
- <xref:azure.mgmt.compute.v2023_03_01.models.Sku>
- 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.v2023_03_01.models.Plan>
- description: The virtual machine child extension resources.
name: resources
types:
- <xref:list>[<xref:azure.mgmt.compute.v2023_03_01.models.VirtualMachineExtension>]
- description: The virtual machine zones.
name: zones
types:
- <xref:list>[<xref:str>]
- description: The identity of the virtual machine, if configured.
name: identity
types:
- <xref:azure.mgmt.compute.v2023_03_01.models.VirtualMachineIdentity>
- description: 'Specifies whether the latest model has been applied to the virtual
machine.'
name: latest_model_applied
types:
- <xref:bool>
- description: Azure VM unique ID.
name: vm_id
types:
- <xref:str>
- description: The virtual machine instance view.
name: instance_view
types:
- <xref:azure.mgmt.compute.v2023_03_01.models.VirtualMachineScaleSetVMInstanceView>
- description: Specifies the hardware settings for the virtual machine.
name: hardware_profile
types:
- <xref:azure.mgmt.compute.v2023_03_01.models.HardwareProfile>
- description: Specifies the storage settings for the virtual machine disks.
name: storage_profile
types:
- <xref:azure.mgmt.compute.v2023_03_01.models.StorageProfile>
- description: 'Specifies additional capabilities enabled or disabled on the
virtual machine in the scale set. For instance: whether the virtual machine has
the capability
to support attaching managed data disks with UltraSSD_LRS storage account type.'
name: additional_capabilities
types:
- <xref:azure.mgmt.compute.v2023_03_01.models.AdditionalCapabilities>
- description: Specifies the operating system settings for the virtual machine.
name: os_profile
types:
- <xref:azure.mgmt.compute.v2023_03_01.models.OSProfile>
- description: 'Specifies the Security related profile settings for the virtual
machine.'
name: security_profile
types:
- <xref:azure.mgmt.compute.v2023_03_01.models.SecurityProfile>
- description: Specifies the network interfaces of the virtual machine.
name: network_profile
types:
- <xref:azure.mgmt.compute.v2023_03_01.models.NetworkProfile>
- description: 'Specifies the network profile configuration of the virtual
machine.'
name: network_profile_configuration
types:
- <xref:azure.mgmt.compute.v2023_03_01.models.VirtualMachineScaleSetVMNetworkProfileConfiguration>
- description: 'Specifies the boot diagnostic settings state. Minimum api-version:
2015-06-15.'
name: diagnostics_profile
types:
- <xref:azure.mgmt.compute.v2023_03_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 [Availability sets overview](https://docs.microsoft.com/azure/virtual-machines/availability-set-overview).
For more
information on Azure planned maintenance, see [Maintenance and updates for Virtual
Machines in
Azure](https://docs.microsoft.com/azure/virtual-machines/maintenance-and-updates).
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.v2023_03_01.models.SubResource>
- description: The provisioning state, which only appears in the response.
name: provisioning_state
types:
- <xref:str>
- description: 'Specifies that the image or disk that is being used was licensed
on-premises. `<br>``<br>` Possible values for Windows Server operating system
are:
`<br>``<br>` Windows_Client `<br>``<br>` Windows_Server
`<br>``<br>` Possible values for Linux Server operating system are:
`<br>``<br>` RHEL_BYOS (for RHEL) `<br>``<br>` SLES_BYOS (for SUSE)
`<br>``<br>` For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)
`<br>``<br>` [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)
`<br>``<br>` Minimum api-version: 2015-06-15.'
name: license_type
types:
- <xref:str>
- description: 'Specifies whether the model applied to the virtual machine is
the model of the virtual machine scale set or the customized model for the virtual
machine.'
name: model_definition_applied
types:
- <xref:str>
- description: Specifies the protection policy of the virtual machine.
name: protection_policy
types:
- <xref:azure.mgmt.compute.v2023_03_01.models.VirtualMachineScaleSetVMProtectionPolicy>
- description: 'UserData for the VM, which must be base-64 encoded. Customer should
not pass
any secrets in here. `<br>`:code:>>`<<<br>`Minimum api-version: 2021-03-01.'
name: user_data
types:
- <xref:str>