/
azure.mgmt.compute.v2022_08_01.operations.VirtualMachinesOperations.yml
763 lines (720 loc) · 27.7 KB
/
azure.mgmt.compute.v2022_08_01.operations.VirtualMachinesOperations.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
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
### YamlMime:PythonClass
uid: azure.mgmt.compute.v2022_08_01.operations.VirtualMachinesOperations
name: VirtualMachinesOperations
fullName: azure.mgmt.compute.v2022_08_01.operations.VirtualMachinesOperations
module: azure.mgmt.compute.v2022_08_01.operations
inheritances:
- builtins.object
summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
\ you should access the following operations through\n>\n> <xref:azure.mgmt.compute.v2022_08_01.ComputeManagementClient>'s\n\
>\n> <xref:virtual_machines> attribute.\n>"
constructor:
syntax: VirtualMachinesOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.compute.v2022_08_01.operations.VirtualMachinesOperations.begin_assess_patches
name: begin_assess_patches
summary: Assess patches on the VM.
signature: 'begin_assess_patches(resource_group_name: str, vm_name: str, **kwargs:
Any) -> LROPoller[VirtualMachineAssessPatchesResult]'
parameters:
- name: resource_group_name
description: The name of the resource group. Required.
isRequired: true
types:
- <xref:str>
- name: vm_name
description: The name of the virtual machine. Required.
isRequired: true
types:
- <xref:str>
return:
description: 'An instance of LROPoller that returns either VirtualMachineAssessPatchesResult
or the
result of cls(response)'
types:
- <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.compute.v2022_08_01.models.VirtualMachineAssessPatchesResult>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2022_08_01.operations.VirtualMachinesOperations.begin_capture
name: begin_capture
summary: 'Captures the VM by copying virtual hard disks of the VM and outputs a
template that can be used
to create similar VMs.'
signature: 'begin_capture(resource_group_name: str, vm_name: str, parameters: _models.VirtualMachineCaptureParameters,
*, content_type: str = ''application/json'', **kwargs: Any) -> LROPoller[_models.VirtualMachineCaptureResult]'
parameters:
- name: resource_group_name
description: The name of the resource group. Required.
isRequired: true
types:
- <xref:str>
- name: vm_name
description: The name of the virtual machine. Required.
isRequired: true
types:
- <xref:str>
- name: parameters
description: 'Parameters supplied to the Capture Virtual Machine operation. Is
either a
VirtualMachineCaptureParameters type or a IO[bytes] type. Required.'
isRequired: true
types:
- <xref:azure.mgmt.compute.v2022_08_01.models.VirtualMachineCaptureParameters>
- <xref:typing.IO>[<xref:bytes>]
return:
description: 'An instance of LROPoller that returns either VirtualMachineCaptureResult
or the result
of cls(response)'
types:
- <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.compute.v2022_08_01.models.VirtualMachineCaptureResult>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2022_08_01.operations.VirtualMachinesOperations.begin_convert_to_managed_disks
name: begin_convert_to_managed_disks
summary: 'Converts virtual machine disks from blob-based to managed disks. Virtual
machine must be
stop-deallocated before invoking this operation.'
signature: 'begin_convert_to_managed_disks(resource_group_name: str, vm_name: str,
**kwargs: Any) -> LROPoller[None]'
parameters:
- name: resource_group_name
description: The name of the resource group. Required.
isRequired: true
types:
- <xref:str>
- name: vm_name
description: The name of the virtual machine. Required.
isRequired: true
types:
- <xref:str>
return:
description: An instance of LROPoller that returns either None or the result of
cls(response)
types:
- <xref:azure.core.polling.LROPoller>[<xref:None>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2022_08_01.operations.VirtualMachinesOperations.begin_create_or_update
name: begin_create_or_update
summary: 'The operation to create or update a virtual machine. Please note some
properties can be set
only during virtual machine creation.'
signature: 'begin_create_or_update(resource_group_name: str, vm_name: str, parameters:
_models.VirtualMachine, *, content_type: str = ''application/json'', **kwargs:
Any) -> LROPoller[_models.VirtualMachine]'
parameters:
- name: resource_group_name
description: The name of the resource group. Required.
isRequired: true
types:
- <xref:str>
- name: vm_name
description: The name of the virtual machine. Required.
isRequired: true
types:
- <xref:str>
- name: parameters
description: 'Parameters supplied to the Create Virtual Machine operation. Is
either a
VirtualMachine type or a IO[bytes] type. Required.'
isRequired: true
types:
- <xref:azure.mgmt.compute.v2022_08_01.models.VirtualMachine>
- <xref:typing.IO>[<xref:bytes>]
return:
description: 'An instance of LROPoller that returns either VirtualMachine or the
result of
cls(response)'
types:
- <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.compute.v2022_08_01.models.VirtualMachine>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2022_08_01.operations.VirtualMachinesOperations.begin_deallocate
name: begin_deallocate
summary: 'Shuts down the virtual machine and releases the compute resources. You
are not billed for the
compute resources that this virtual machine uses.'
signature: 'begin_deallocate(resource_group_name: str, vm_name: str, *, hibernate:
bool | None = None, **kwargs: Any) -> LROPoller[None]'
parameters:
- name: resource_group_name
description: The name of the resource group. Required.
isRequired: true
types:
- <xref:str>
- name: vm_name
description: The name of the virtual machine. Required.
isRequired: true
types:
- <xref:str>
keywordOnlyParameters:
- name: hibernate
description: 'Optional parameter to hibernate a virtual machine. (Feature in Preview).
Default value is None.'
types:
- <xref:bool>
return:
description: An instance of LROPoller that returns either None or the result of
cls(response)
types:
- <xref:azure.core.polling.LROPoller>[<xref:None>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2022_08_01.operations.VirtualMachinesOperations.begin_delete
name: begin_delete
summary: The operation to delete a virtual machine.
signature: 'begin_delete(resource_group_name: str, vm_name: str, *, force_deletion:
bool | None = None, **kwargs: Any) -> LROPoller[None]'
parameters:
- name: resource_group_name
description: The name of the resource group. Required.
isRequired: true
types:
- <xref:str>
- name: vm_name
description: The name of the virtual machine. Required.
isRequired: true
types:
- <xref:str>
keywordOnlyParameters:
- name: force_deletion
description: 'Optional parameter to force delete virtual machines. Default value
is
None.'
types:
- <xref:bool>
return:
description: An instance of LROPoller that returns either None or the result of
cls(response)
types:
- <xref:azure.core.polling.LROPoller>[<xref:None>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2022_08_01.operations.VirtualMachinesOperations.begin_install_patches
name: begin_install_patches
summary: Installs patches on the VM.
signature: 'begin_install_patches(resource_group_name: str, vm_name: str, install_patches_input:
_models.VirtualMachineInstallPatchesParameters, *, content_type: str = ''application/json'',
**kwargs: Any) -> LROPoller[_models.VirtualMachineInstallPatchesResult]'
parameters:
- name: resource_group_name
description: The name of the resource group. Required.
isRequired: true
types:
- <xref:str>
- name: vm_name
description: The name of the virtual machine. Required.
isRequired: true
types:
- <xref:str>
- name: install_patches_input
description: 'Input for InstallPatches as directly received by the API. Is
either a VirtualMachineInstallPatchesParameters type or a IO[bytes] type. Required.'
isRequired: true
types:
- <xref:azure.mgmt.compute.v2022_08_01.models.VirtualMachineInstallPatchesParameters>
- <xref:typing.IO>[<xref:bytes>]
return:
description: 'An instance of LROPoller that returns either VirtualMachineInstallPatchesResult
or the
result of cls(response)'
types:
- <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.compute.v2022_08_01.models.VirtualMachineInstallPatchesResult>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2022_08_01.operations.VirtualMachinesOperations.begin_perform_maintenance
name: begin_perform_maintenance
summary: The operation to perform maintenance on a virtual machine.
signature: 'begin_perform_maintenance(resource_group_name: str, vm_name: str, **kwargs:
Any) -> LROPoller[None]'
parameters:
- name: resource_group_name
description: The name of the resource group. Required.
isRequired: true
types:
- <xref:str>
- name: vm_name
description: The name of the virtual machine. Required.
isRequired: true
types:
- <xref:str>
return:
description: An instance of LROPoller that returns either None or the result of
cls(response)
types:
- <xref:azure.core.polling.LROPoller>[<xref:None>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2022_08_01.operations.VirtualMachinesOperations.begin_power_off
name: begin_power_off
summary: 'The operation to power off (stop) a virtual machine. The virtual machine
can be restarted with
the same provisioned resources. You are still charged for this virtual machine.'
signature: 'begin_power_off(resource_group_name: str, vm_name: str, *, skip_shutdown:
bool = False, **kwargs: Any) -> LROPoller[None]'
parameters:
- name: resource_group_name
description: The name of the resource group. Required.
isRequired: true
types:
- <xref:str>
- name: vm_name
description: The name of the virtual machine. Required.
isRequired: true
types:
- <xref:str>
keywordOnlyParameters:
- name: skip_shutdown
description: 'The parameter to request non-graceful VM shutdown. True value for
this
flag indicates non-graceful shutdown whereas false indicates otherwise. Default
value for this
flag is false if not specified. Default value is False.'
types:
- <xref:bool>
return:
description: An instance of LROPoller that returns either None or the result of
cls(response)
types:
- <xref:azure.core.polling.LROPoller>[<xref:None>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2022_08_01.operations.VirtualMachinesOperations.begin_reapply
name: begin_reapply
summary: The operation to reapply a virtual machine's state.
signature: 'begin_reapply(resource_group_name: str, vm_name: str, **kwargs: Any)
-> LROPoller[None]'
parameters:
- name: resource_group_name
description: The name of the resource group. Required.
isRequired: true
types:
- <xref:str>
- name: vm_name
description: The name of the virtual machine. Required.
isRequired: true
types:
- <xref:str>
return:
description: An instance of LROPoller that returns either None or the result of
cls(response)
types:
- <xref:azure.core.polling.LROPoller>[<xref:None>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2022_08_01.operations.VirtualMachinesOperations.begin_redeploy
name: begin_redeploy
summary: Shuts down the virtual machine, moves it to a new node, and powers it back
on.
signature: 'begin_redeploy(resource_group_name: str, vm_name: str, **kwargs: Any)
-> LROPoller[None]'
parameters:
- name: resource_group_name
description: The name of the resource group. Required.
isRequired: true
types:
- <xref:str>
- name: vm_name
description: The name of the virtual machine. Required.
isRequired: true
types:
- <xref:str>
return:
description: An instance of LROPoller that returns either None or the result of
cls(response)
types:
- <xref:azure.core.polling.LROPoller>[<xref:None>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2022_08_01.operations.VirtualMachinesOperations.begin_reimage
name: begin_reimage
summary: Reimages the virtual machine which has an ephemeral OS disk back to its
initial state.
signature: 'begin_reimage(resource_group_name: str, vm_name: str, parameters: _models.VirtualMachineReimageParameters
| None = None, *, content_type: str = ''application/json'', **kwargs: Any) ->
LROPoller[None]'
parameters:
- name: resource_group_name
description: The name of the resource group. Required.
isRequired: true
types:
- <xref:str>
- name: vm_name
description: The name of the virtual machine. Required.
isRequired: true
types:
- <xref:str>
- name: parameters
description: 'Parameters supplied to the Reimage Virtual Machine operation. Is
either a
VirtualMachineReimageParameters type or a IO[bytes] type. Default value is None.'
isRequired: true
types:
- <xref:azure.mgmt.compute.v2022_08_01.models.VirtualMachineReimageParameters>
- <xref:typing.IO>[<xref:bytes>]
return:
description: An instance of LROPoller that returns either None or the result of
cls(response)
types:
- <xref:azure.core.polling.LROPoller>[<xref:None>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2022_08_01.operations.VirtualMachinesOperations.begin_restart
name: begin_restart
summary: The operation to restart a virtual machine.
signature: 'begin_restart(resource_group_name: str, vm_name: str, **kwargs: Any)
-> LROPoller[None]'
parameters:
- name: resource_group_name
description: The name of the resource group. Required.
isRequired: true
types:
- <xref:str>
- name: vm_name
description: The name of the virtual machine. Required.
isRequired: true
types:
- <xref:str>
return:
description: An instance of LROPoller that returns either None or the result of
cls(response)
types:
- <xref:azure.core.polling.LROPoller>[<xref:None>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2022_08_01.operations.VirtualMachinesOperations.begin_run_command
name: begin_run_command
summary: Run command on the VM.
signature: 'begin_run_command(resource_group_name: str, vm_name: str, parameters:
_models.RunCommandInput, *, content_type: str = ''application/json'', **kwargs:
Any) -> LROPoller[_models.RunCommandResult]'
parameters:
- name: resource_group_name
description: The name of the resource group. Required.
isRequired: true
types:
- <xref:str>
- name: vm_name
description: The name of the virtual machine. Required.
isRequired: true
types:
- <xref:str>
- name: parameters
description: 'Parameters supplied to the Run command operation. Is either a
RunCommandInput type or a IO[bytes] type. Required.'
isRequired: true
types:
- <xref:azure.mgmt.compute.v2022_08_01.models.RunCommandInput>
- <xref:typing.IO>[<xref:bytes>]
return:
description: 'An instance of LROPoller that returns either RunCommandResult or
the result of
cls(response)'
types:
- <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.compute.v2022_08_01.models.RunCommandResult>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2022_08_01.operations.VirtualMachinesOperations.begin_start
name: begin_start
summary: The operation to start a virtual machine.
signature: 'begin_start(resource_group_name: str, vm_name: str, **kwargs: Any) ->
LROPoller[None]'
parameters:
- name: resource_group_name
description: The name of the resource group. Required.
isRequired: true
types:
- <xref:str>
- name: vm_name
description: The name of the virtual machine. Required.
isRequired: true
types:
- <xref:str>
return:
description: An instance of LROPoller that returns either None or the result of
cls(response)
types:
- <xref:azure.core.polling.LROPoller>[<xref:None>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2022_08_01.operations.VirtualMachinesOperations.begin_update
name: begin_update
summary: The operation to update a virtual machine.
signature: 'begin_update(resource_group_name: str, vm_name: str, parameters: _models.VirtualMachineUpdate,
*, content_type: str = ''application/json'', **kwargs: Any) -> LROPoller[_models.VirtualMachine]'
parameters:
- name: resource_group_name
description: The name of the resource group. Required.
isRequired: true
types:
- <xref:str>
- name: vm_name
description: The name of the virtual machine. Required.
isRequired: true
types:
- <xref:str>
- name: parameters
description: 'Parameters supplied to the Update Virtual Machine operation. Is
either a
VirtualMachineUpdate type or a IO[bytes] type. Required.'
isRequired: true
types:
- <xref:azure.mgmt.compute.v2022_08_01.models.VirtualMachineUpdate>
- <xref:typing.IO>[<xref:bytes>]
return:
description: 'An instance of LROPoller that returns either VirtualMachine or the
result of
cls(response)'
types:
- <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.compute.v2022_08_01.models.VirtualMachine>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2022_08_01.operations.VirtualMachinesOperations.generalize
name: generalize
summary: 'Sets the OS state of the virtual machine to generalized. It is recommended
to sysprep the
virtual machine before performing this operation. >>:code:`<br>`For Windows, please
refer to
`Create a managed image of a generalized VM in Azure
<https://docs.microsoft.com/azure/virtual-machines/windows/capture-image-resource>`_<<.:code:[<br>`For
Linux, please refer to `How to create an image of a virtual machine or VHD](https://docs.microsoft.com/azure/virtual-machines/linux/capture-image).'
signature: 'generalize(resource_group_name: str, vm_name: str, **kwargs: Any) ->
None'
parameters:
- name: resource_group_name
description: The name of the resource group. Required.
isRequired: true
types:
- <xref:str>
- name: vm_name
description: The name of the virtual machine. Required.
isRequired: true
types:
- <xref:str>
return:
description: None or the result of cls(response)
types:
- <xref:None>
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2022_08_01.operations.VirtualMachinesOperations.get
name: get
summary: Retrieves information about the model view or the instance view of a virtual
machine.
signature: 'get(resource_group_name: str, vm_name: str, *, expand: str | InstanceViewTypes
| None = None, **kwargs: Any) -> VirtualMachine'
parameters:
- name: resource_group_name
description: The name of the resource group. Required.
isRequired: true
types:
- <xref:str>
- name: vm_name
description: The name of the virtual machine. Required.
isRequired: true
types:
- <xref:str>
keywordOnlyParameters:
- name: expand
description: 'The expand expression to apply on the operation. ''InstanceView''
retrieves a
snapshot of the runtime properties of the virtual machine that is managed by
the platform and
can change outside of control plane operations. ''UserData'' retrieves the UserData
property as
part of the VM model view that was provided by the user during the VM Create/Update
operation.
Known values are: "instanceView" and "userData". Default value is None.'
types:
- <xref:str>
- <xref:azure.mgmt.compute.v2022_08_01.models.InstanceViewTypes>
return:
description: VirtualMachine or the result of cls(response)
types:
- <xref:azure.mgmt.compute.v2022_08_01.models.VirtualMachine>
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2022_08_01.operations.VirtualMachinesOperations.instance_view
name: instance_view
summary: Retrieves information about the run-time state of a virtual machine.
signature: 'instance_view(resource_group_name: str, vm_name: str, **kwargs: Any)
-> VirtualMachineInstanceView'
parameters:
- name: resource_group_name
description: The name of the resource group. Required.
isRequired: true
types:
- <xref:str>
- name: vm_name
description: The name of the virtual machine. Required.
isRequired: true
types:
- <xref:str>
return:
description: VirtualMachineInstanceView or the result of cls(response)
types:
- <xref:azure.mgmt.compute.v2022_08_01.models.VirtualMachineInstanceView>
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2022_08_01.operations.VirtualMachinesOperations.list
name: list
summary: 'Lists all of the virtual machines in the specified resource group. Use
the nextLink property in
the response to get the next page of virtual machines.'
signature: 'list(resource_group_name: str, *, filter: str | None = None, **kwargs:
Any) -> Iterable[VirtualMachine]'
parameters:
- name: resource_group_name
description: The name of the resource group. Required.
isRequired: true
types:
- <xref:str>
keywordOnlyParameters:
- name: filter
description: 'The system query option to filter VMs returned in the response.
Allowed value
is ''virtualMachineScaleSet/id'' eq
/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmssName}''.
Default value is None.'
types:
- <xref:str>
return:
description: An iterator like instance of either VirtualMachine or the result
of cls(response)
types:
- <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.compute.v2022_08_01.models.VirtualMachine>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2022_08_01.operations.VirtualMachinesOperations.list_all
name: list_all
summary: 'Lists all of the virtual machines in the specified subscription. Use the
nextLink property in
the response to get the next page of virtual machines.'
signature: 'list_all(*, status_only: str | None = None, filter: str | None = None,
**kwargs: Any) -> Iterable[VirtualMachine]'
keywordOnlyParameters:
- name: status_only
description: 'statusOnly=true enables fetching run time status of all Virtual
Machines
in the subscription. Default value is None.'
types:
- <xref:str>
- name: filter
description: 'The system query option to filter VMs returned in the response.
Allowed value
is ''virtualMachineScaleSet/id'' eq
/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmssName}''.
Default value is None.'
types:
- <xref:str>
return:
description: An iterator like instance of either VirtualMachine or the result
of cls(response)
types:
- <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.compute.v2022_08_01.models.VirtualMachine>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2022_08_01.operations.VirtualMachinesOperations.list_available_sizes
name: list_available_sizes
summary: 'Lists all available virtual machine sizes to which the specified virtual
machine can be
resized.'
signature: 'list_available_sizes(resource_group_name: str, vm_name: str, **kwargs:
Any) -> Iterable[VirtualMachineSize]'
parameters:
- name: resource_group_name
description: The name of the resource group. Required.
isRequired: true
types:
- <xref:str>
- name: vm_name
description: The name of the virtual machine. Required.
isRequired: true
types:
- <xref:str>
return:
description: An iterator like instance of either VirtualMachineSize or the result
of cls(response)
types:
- <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.compute.v2022_08_01.models.VirtualMachineSize>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2022_08_01.operations.VirtualMachinesOperations.list_by_location
name: list_by_location
summary: Gets all the virtual machines under the specified subscription for the
specified location.
signature: 'list_by_location(location: str, **kwargs: Any) -> Iterable[VirtualMachine]'
parameters:
- name: location
description: 'The location for which virtual machines under the subscription are
queried.
Required.'
isRequired: true
types:
- <xref:str>
return:
description: An iterator like instance of either VirtualMachine or the result
of cls(response)
types:
- <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.compute.v2022_08_01.models.VirtualMachine>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2022_08_01.operations.VirtualMachinesOperations.retrieve_boot_diagnostics_data
name: retrieve_boot_diagnostics_data
summary: The operation to retrieve SAS URIs for a virtual machine's boot diagnostic
logs.
signature: 'retrieve_boot_diagnostics_data(resource_group_name: str, vm_name: str,
*, sas_uri_expiration_time_in_minutes: int | None = None, **kwargs: Any) -> RetrieveBootDiagnosticsDataResult'
parameters:
- name: resource_group_name
description: The name of the resource group. Required.
isRequired: true
types:
- <xref:str>
- name: vm_name
description: The name of the virtual machine. Required.
isRequired: true
types:
- <xref:str>
keywordOnlyParameters:
- name: sas_uri_expiration_time_in_minutes
description: 'Expiration duration in minutes for the SAS URIs
with a value between 1 to 1440 minutes. `<br>`:code:>>`<<<br>`NOTE: If not specified,
SAS
URIs will be generated with a default expiration duration of 120 minutes. Default
value is
None.'
types:
- <xref:int>
return:
description: RetrieveBootDiagnosticsDataResult or the result of cls(response)
types:
- <xref:azure.mgmt.compute.v2022_08_01.models.RetrieveBootDiagnosticsDataResult>
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2022_08_01.operations.VirtualMachinesOperations.simulate_eviction
name: simulate_eviction
summary: The operation to simulate the eviction of spot virtual machine.
signature: 'simulate_eviction(resource_group_name: str, vm_name: str, **kwargs:
Any) -> None'
parameters:
- name: resource_group_name
description: The name of the resource group. Required.
isRequired: true
types:
- <xref:str>
- name: vm_name
description: The name of the virtual machine. Required.
isRequired: true
types:
- <xref:str>
return:
description: None or the result of cls(response)
types:
- <xref:None>
exceptions:
- type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.compute.v2022_08_01.operations.VirtualMachinesOperations.models
name: models
signature: models = <module 'azure.mgmt.compute.v2022_08_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\compute\\v2022_08_01\\models\\__init__.py'>