你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

VirtualMachinesOperations 类

参考

警告

请勿直接实例化此类。

相反，应通过以下方式访问以下操作：

ComputeManagementClient's

<xref:virtual_machines> 属性。

继承: builtins.object

VirtualMachinesOperations

构造函数

VirtualMachinesOperations(*args, **kwargs)

方法

begin_capture	通过复制 VM 的虚拟硬盘来捕获 VM，并输出可用于创建类似 VM 的模板。
begin_convert_to_managed_disks	将虚拟机磁盘从基于 Blob 的磁盘转换为托管磁盘。在调用此操作之前，必须停止解除分配虚拟机。 >>：code：`<br>`对于 Windows，请参阅 `Convert a virtual machine from unmanaged disks to managed disks. <https://docs.microsoft.com/en-us/azure/virtual-machines/windows/convert-unmanaged-to-managed-disks>`_<<.：code： `For Linux, please refer to` 将虚拟机从非托管磁盘转换为托管磁盘。
begin_create_or_update	用于创建或更新虚拟机的操作。请注意，某些属性只能在创建虚拟机期间设置。
begin_deallocate	关闭虚拟机并释放计算资源。无需为此虚拟机使用的计算资源付费。
begin_delete	用于删除虚拟机的操作。
begin_perform_maintenance	关闭虚拟机，将其移动到已更新的节点，并在计划内维护的自助服务阶段重新打开它。
begin_power_off	关闭电源的操作 (停止) 虚拟机。可以使用相同的预配资源重启虚拟机。你仍需要为此虚拟机付费。
begin_reapply	重新应用虚拟机状态的操作。
begin_redeploy	关闭虚拟机，将其移动到新节点，然后重新打开它。
begin_reimage	将具有临时 OS 磁盘的虚拟机重置为初始状态。
begin_restart	重启虚拟机的操作。
begin_run_command	在 VM 上运行命令。
begin_start	用于启动虚拟机的操作。
begin_update	用于更新虚拟机的操作。
generalize	将虚拟机的 OS 状态设置为通用化。建议在执行此操作之前对虚拟机进行 sysprep。 >>：code：`<br>`对于 Windows，请参阅 `Create a managed image of a generalized VM in Azure <https://docs.microsoft.com/en-us/azure/virtual-machines/windows/capture-image-resource>`_<<.：code： `For Linux, please refer to` 如何创建虚拟机或 VHD 的映像。
get	检索虚拟机的模型视图或实例视图的相关信息。
instance_view	检索有关虚拟机的运行时状态的信息。
list	列出指定资源组中的所有虚拟机。在响应中使用 nextLink 属性获取虚拟机的下一页。
list_all	列出指定订阅中的所有虚拟机。在响应中使用 nextLink 属性获取虚拟机的下一页。
list_available_sizes	列出可以调整指定虚拟机大小的所有可用虚拟机大小。
list_by_location	获取指定位置的指定订阅下的所有虚拟机。

begin_capture

通过复制 VM 的虚拟硬盘来捕获 VM，并输出可用于创建类似 VM 的模板。

begin_capture(resource_group_name: str, vm_name: str, parameters: _models.VirtualMachineCaptureParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.VirtualMachineCaptureResult]

参数

resource_group_name: str

必需

资源组的名称。必需。

vm_name: str

必需

虚拟机的名称。必需。

parameters: VirtualMachineCaptureParameters 或 IO

必需

提供给捕获虚拟机操作的参数。是 VirtualMachineCaptureParameters 类型或 IO 类型。必需。

content_type: str

Body 参数内容类型。已知值为：“application/json”。默认值为 None。

cls: callable

将传递直接响应的自定义类型或函数

continuation_token: str

用于从保存状态重启轮询的继续标记。

polling: bool 或 PollingMethod

默认情况下，轮询方法将为 ARMPolling。将此操作传入 False 以不进行轮询，或为个人轮询策略传入你自己的初始化轮询对象。

polling_interval: int

如果没有 Retry-After 标头，则 LRO 操作的两次轮询之间的默认等待时间。

LROPoller 的实例，返回 VirtualMachineCaptureResult 或 cls 的结果 (响应)

返回类型

LROPoller[VirtualMachineCaptureResult]

例外

HttpResponseError

begin_convert_to_managed_disks

将虚拟机磁盘从基于 Blob 的磁盘转换为托管磁盘。在调用此操作之前，必须停止解除分配虚拟机。 >>：code：<br>对于 Windows，请参阅 Convert a virtual machine from unmanaged disks to managed disks. <https://docs.microsoft.com/en-us/azure/virtual-machines/windows/convert-unmanaged-to-managed-disks>_<<.：code：
For Linux, please refer to 将虚拟机从非托管磁盘转换为托管磁盘。

begin_convert_to_managed_disks(resource_group_name: str, vm_name: str, **kwargs: Any) -> LROPoller[None]

参数

resource_group_name: str

必需

资源组的名称。必需。

vm_name: str

必需

虚拟机的名称。必需。

cls: callable

将传递直接响应的自定义类型或函数

continuation_token: str

用于从保存状态重启轮询的继续标记。

polling: bool 或 PollingMethod

默认情况下，轮询方法将为 ARMPolling。将此操作传入 False 以不进行轮询，或为个人轮询策略传入你自己的初始化轮询对象。

polling_interval: int

如果没有 Retry-After 标头，则 LRO 操作的两次轮询之间的默认等待时间。

LROPoller 的实例，返回 None 或 cls 的结果 (响应)

返回类型

LROPoller[None]

例外

HttpResponseError

begin_create_or_update

用于创建或更新虚拟机的操作。请注意，某些属性只能在创建虚拟机期间设置。

begin_create_or_update(resource_group_name: str, vm_name: str, parameters: _models.VirtualMachine, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.VirtualMachine]

参数

resource_group_name: str

必需

资源组的名称。必需。

vm_name: str

必需

虚拟机的名称。必需。

parameters: VirtualMachine 或 IO

必需

提供给“创建虚拟机”操作的参数。是 VirtualMachine 类型或 IO 类型。必需。

content_type: str

Body 参数内容类型。已知值为：“application/json”。默认值为 None。

cls: callable

将传递直接响应的自定义类型或函数

continuation_token: str

用于从保存状态重启轮询的继续标记。

polling: bool 或 PollingMethod

默认情况下，轮询方法将为 ARMPolling。将此操作传入 False 以不进行轮询，或为个人轮询策略传入你自己的初始化轮询对象。

polling_interval: int

如果没有 Retry-After 标头，则 LRO 操作的两次轮询之间的默认等待时间。

LROPoller 的实例，返回 VirtualMachine 或 cls 的结果 (响应)

返回类型

LROPoller[VirtualMachine]

例外

HttpResponseError

begin_deallocate

关闭虚拟机并释放计算资源。无需为此虚拟机使用的计算资源付费。

begin_deallocate(resource_group_name: str, vm_name: str, **kwargs: Any) -> LROPoller[None]

参数

resource_group_name: str

必需

资源组的名称。必需。

vm_name: str

必需

虚拟机的名称。必需。

cls: callable

将传递直接响应的自定义类型或函数

continuation_token: str

用于从保存状态重启轮询的继续标记。

polling: bool 或 PollingMethod

默认情况下，轮询方法将为 ARMPolling。将此操作传入 False 以不进行轮询，或为个人轮询策略传入你自己的初始化轮询对象。

polling_interval: int

如果没有 Retry-After 标头，则 LRO 操作的两次轮询之间的默认等待时间。

LROPoller 的实例，返回 None 或 cls 的结果 (响应)

返回类型

LROPoller[None]

例外

HttpResponseError

begin_delete

用于删除虚拟机的操作。

begin_delete(resource_group_name: str, vm_name: str, **kwargs: Any) -> LROPoller[None]

参数

resource_group_name: str

必需

资源组的名称。必需。

vm_name: str

必需

虚拟机的名称。必需。

cls: callable

将传递直接响应的自定义类型或函数

continuation_token: str

用于从保存状态重启轮询的继续标记。

polling: bool 或 PollingMethod

默认情况下，轮询方法将为 ARMPolling。将此操作传入 False 以不进行轮询，或为个人轮询策略传入你自己的初始化轮询对象。

polling_interval: int

如果没有 Retry-After 标头，则 LRO 操作的两次轮询之间的默认等待时间。

LROPoller 的实例，返回 None 或 cls 的结果 (响应)

返回类型

LROPoller[None]

例外

HttpResponseError

begin_perform_maintenance

关闭虚拟机，将其移动到已更新的节点，并在计划内维护的自助服务阶段重新打开它。

begin_perform_maintenance(resource_group_name: str, vm_name: str, **kwargs: Any) -> LROPoller[None]

参数

resource_group_name: str

必需

资源组的名称。必需。

vm_name: str

必需

虚拟机的名称。必需。

cls: callable

将传递直接响应的自定义类型或函数

continuation_token: str

用于从保存状态重启轮询的继续标记。

polling: bool 或 PollingMethod

默认情况下，轮询方法将为 ARMPolling。将此操作传入 False 以不进行轮询，或为个人轮询策略传入你自己的初始化轮询对象。

polling_interval: int

如果没有 Retry-After 标头，则 LRO 操作的两次轮询之间的默认等待时间。

LROPoller 的实例，返回 None 或 cls 的结果 (响应)

返回类型

LROPoller[None]

例外

HttpResponseError

begin_power_off

关闭电源的操作 (停止) 虚拟机。可以使用相同的预配资源重启虚拟机。你仍需要为此虚拟机付费。

begin_power_off(resource_group_name: str, vm_name: str, *, skip_shutdown: bool = False, **kwargs: Any) -> LROPoller[None]

参数

resource_group_name: str

必需

资源组的名称。必需。

vm_name: str

必需

虚拟机的名称。必需。

skip_shutdown: bool

用于请求非正常 VM 关闭的参数。此标志的 True 值指示非正常关闭，而 false 指示否则。如果未指定，则此标志的默认值为 false。默认值为 False。

cls: callable

将传递直接响应的自定义类型或函数

continuation_token: str

用于从保存状态重启轮询的继续标记。

polling: bool 或 PollingMethod

默认情况下，轮询方法将为 ARMPolling。将此操作传入 False 以不进行轮询，或为个人轮询策略传入你自己的初始化轮询对象。

polling_interval: int

如果没有 Retry-After 标头，则 LRO 操作的两次轮询之间的默认等待时间。

LROPoller 的实例，返回 None 或 cls 的结果 (响应)

返回类型

LROPoller[None]

例外

HttpResponseError

begin_reapply

重新应用虚拟机状态的操作。

begin_reapply(resource_group_name: str, vm_name: str, **kwargs: Any) -> LROPoller[None]

参数

resource_group_name: str

必需

资源组的名称。必需。

vm_name: str

必需

虚拟机的名称。必需。

cls: callable

将传递直接响应的自定义类型或函数

continuation_token: str

用于从保存状态重启轮询的继续标记。

polling: bool 或 PollingMethod

默认情况下，轮询方法将为 ARMPolling。将此操作传入 False 以不进行轮询，或为个人轮询策略传入你自己的初始化轮询对象。

polling_interval: int

如果没有 Retry-After 标头，则 LRO 操作的两次轮询之间的默认等待时间。

LROPoller 的实例，返回 None 或 cls 的结果 (响应)

返回类型

LROPoller[None]

例外

HttpResponseError

begin_redeploy

关闭虚拟机，将其移动到新节点，然后重新打开它。

begin_redeploy(resource_group_name: str, vm_name: str, **kwargs: Any) -> LROPoller[None]

参数

resource_group_name: str

必需

资源组的名称。必需。

vm_name: str

必需

虚拟机的名称。必需。

cls: callable

将传递直接响应的自定义类型或函数

continuation_token: str

用于从保存状态重启轮询的继续标记。

polling: bool 或 PollingMethod

默认情况下，轮询方法将为 ARMPolling。将此操作传入 False 以不进行轮询，或为个人轮询策略传入你自己的初始化轮询对象。

polling_interval: int

如果没有 Retry-After 标头，则 LRO 操作的两次轮询之间的默认等待时间。

LROPoller 的实例，返回 None 或 cls 的结果 (响应)

返回类型

LROPoller[None]

例外

HttpResponseError

begin_reimage

将具有临时 OS 磁盘的虚拟机重置为初始状态。

begin_reimage(resource_group_name: str, vm_name: str, parameters: _models.VirtualMachineReimageParameters | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

参数

resource_group_name: str

必需

资源组的名称。必需。

vm_name: str

必需

虚拟机的名称。必需。

parameters: VirtualMachineReimageParameters 或 IO

必需

提供给“重置虚拟机映像”操作的参数。是 VirtualMachineReimageParameters 类型或 IO 类型。默认值为 None。

content_type: str

Body 参数内容类型。已知值为：“application/json”。默认值为 None。

cls: callable

将传递直接响应的自定义类型或函数

continuation_token: str

用于从保存状态重启轮询的继续标记。

polling: bool 或 PollingMethod

默认情况下，轮询方法将为 ARMPolling。将此操作传入 False 以不进行轮询，或为个人轮询策略传入你自己的初始化轮询对象。

polling_interval: int

如果没有 Retry-After 标头，则 LRO 操作的两次轮询之间的默认等待时间。

LROPoller 的实例，返回 None 或 cls 的结果 (响应)

返回类型

LROPoller[None]

例外

HttpResponseError

begin_restart

重启虚拟机的操作。

begin_restart(resource_group_name: str, vm_name: str, **kwargs: Any) -> LROPoller[None]

参数

resource_group_name: str

必需

资源组的名称。必需。

vm_name: str

必需

虚拟机的名称。必需。

cls: callable

将传递直接响应的自定义类型或函数

continuation_token: str

用于从保存状态重启轮询的继续标记。

polling: bool 或 PollingMethod

默认情况下，轮询方法将为 ARMPolling。将此操作传入 False 以不进行轮询，或为个人轮询策略传入你自己的初始化轮询对象。

polling_interval: int

如果没有 Retry-After 标头，则 LRO 操作的两次轮询之间的默认等待时间。

LROPoller 的实例，返回 None 或 cls 的结果 (响应)

返回类型

LROPoller[None]

例外

HttpResponseError

begin_run_command

在 VM 上运行命令。

begin_run_command(resource_group_name: str, vm_name: str, parameters: _models.RunCommandInput, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.RunCommandResult]

参数

resource_group_name: str

必需

资源组的名称。必需。

vm_name: str

必需

虚拟机的名称。必需。

parameters: RunCommandInput 或 IO

必需

提供给 Run 命令操作的参数。是 RunCommandInput 类型或 IO 类型。必需。

content_type: str

Body 参数内容类型。已知值为：“application/json”、“text/json”。默认值为 None。

cls: callable

将传递直接响应的自定义类型或函数

continuation_token: str

用于从保存状态重启轮询的继续标记。

polling: bool 或 PollingMethod

默认情况下，轮询方法将为 ARMPolling。将此操作传入 False 以不进行轮询，或为个人轮询策略传入你自己的初始化轮询对象。

polling_interval: int

如果没有 Retry-After 标头，则 LRO 操作的两次轮询之间的默认等待时间。

返回 RunCommandResult 或 cls 的结果的 LROPoller 实例， (响应)

返回类型

LROPoller[RunCommandResult]

例外

HttpResponseError

begin_start

用于启动虚拟机的操作。

begin_start(resource_group_name: str, vm_name: str, **kwargs: Any) -> LROPoller[None]

参数

resource_group_name: str

必需

资源组的名称。必需。

vm_name: str

必需

虚拟机的名称。必需。

cls: callable

将传递直接响应的自定义类型或函数

continuation_token: str

用于从保存状态重启轮询的继续标记。

polling: bool 或 PollingMethod

默认情况下，轮询方法将为 ARMPolling。将此操作传入 False 以不进行轮询，或为个人轮询策略传入你自己的初始化轮询对象。

polling_interval: int

如果没有 Retry-After 标头，则 LRO 操作的两次轮询之间的默认等待时间。

LROPoller 的实例，返回 None 或 cls 的结果 (响应)

返回类型

LROPoller[None]

例外

HttpResponseError

begin_update

用于更新虚拟机的操作。

begin_update(resource_group_name: str, vm_name: str, parameters: _models.VirtualMachineUpdate, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.VirtualMachine]

参数

resource_group_name: str

必需

资源组的名称。必需。

vm_name: str

必需

虚拟机的名称。必需。

parameters: VirtualMachineUpdate 或 IO

必需

提供给更新虚拟机操作的参数。是 VirtualMachineUpdate 类型或 IO 类型。必需。

content_type: str

Body 参数内容类型。已知值为：“application/json”。默认值为 None。

cls: callable

将传递直接响应的自定义类型或函数

continuation_token: str

用于从保存状态重启轮询的继续标记。

polling: bool 或 PollingMethod

默认情况下，轮询方法将为 ARMPolling。将此操作传入 False 以不进行轮询，或为个人轮询策略传入你自己的初始化轮询对象。

polling_interval: int

如果没有 Retry-After 标头，则 LRO 操作的两次轮询之间的默认等待时间。

LROPoller 的实例，返回 VirtualMachine 或 cls 的结果 (响应)

返回类型

LROPoller[VirtualMachine]

例外

HttpResponseError

generalize

将虚拟机的 OS 状态设置为通用化。建议在执行此操作之前对虚拟机进行 sysprep。 >>：code：<br>对于 Windows，请参阅 Create a managed image of a generalized VM in Azure <https://docs.microsoft.com/en-us/azure/virtual-machines/windows/capture-image-resource>_<<.：code：
For Linux, please refer to 如何创建虚拟机或 VHD 的映像。

generalize(resource_group_name: str, vm_name: str, **kwargs: Any) -> None

参数

resource_group_name: str

必需

资源组的名称。必需。

vm_name: str

必需

虚拟机的名称。必需。

cls: callable

将传递直接响应的自定义类型或函数

无或 cls 的结果 (响应)

返回类型

None

例外

HttpResponseError

get

检索虚拟机的模型视图或实例视图的相关信息。

get(resource_group_name: str, vm_name: str, *, expand: Literal['instanceView'] = 'instanceView', **kwargs: Any) -> VirtualMachine

参数

resource_group_name: str

必需

资源组的名称。必需。

vm_name: str

必需

虚拟机的名称。必需。

expand: str

要应用于操作的 expand 表达式。已知值为“instanceView”和“无”。默认值为“instanceView”。

cls: callable

将传递直接响应的自定义类型或函数

VirtualMachine 或 cls 的结果 (响应)

返回类型

VirtualMachine

例外

HttpResponseError

instance_view

检索有关虚拟机的运行时状态的信息。

instance_view(resource_group_name: str, vm_name: str, **kwargs: Any) -> VirtualMachineInstanceView

参数

resource_group_name: str

必需

资源组的名称。必需。

vm_name: str

必需

虚拟机的名称。必需。

cls: callable

将传递直接响应的自定义类型或函数

VirtualMachineInstanceView 或 cls 的结果 (响应)

返回类型

VirtualMachineInstanceView

例外

HttpResponseError

list

列出指定资源组中的所有虚拟机。在响应中使用 nextLink 属性获取虚拟机的下一页。

list(resource_group_name: str, **kwargs: Any) -> Iterable[VirtualMachine]

参数

resource_group_name: str

必需

资源组的名称。必需。

cls: callable

将传递直接响应的自定义类型或函数

迭代器，例如 VirtualMachine 的实例或 cls 的结果 (响应)

返回类型

ItemPaged[VirtualMachine]

例外

HttpResponseError

list_all

列出指定订阅中的所有虚拟机。在响应中使用 nextLink 属性获取虚拟机的下一页。

list_all(*, status_only: str | None = None, **kwargs: Any) -> Iterable[VirtualMachine]

参数

status_only: str

statusOnly=true 允许提取订阅中所有虚拟机的运行时状态。默认值为 None。

cls: callable

将传递直接响应的自定义类型或函数

迭代器，例如 VirtualMachine 的实例或 cls 的结果 (响应)

返回类型

ItemPaged[VirtualMachine]

例外

HttpResponseError

list_available_sizes

列出可以调整指定虚拟机大小的所有可用虚拟机大小。

list_available_sizes(resource_group_name: str, vm_name: str, **kwargs: Any) -> Iterable[VirtualMachineSize]

参数

resource_group_name: str

必需

资源组的名称。必需。

vm_name: str

必需

虚拟机的名称。必需。

cls: callable

将传递直接响应的自定义类型或函数

迭代器，例如 VirtualMachineSize 的实例或 cls 的结果 (响应)

返回类型

ItemPaged[VirtualMachineSize]

例外

HttpResponseError

list_by_location

获取指定位置的指定订阅下的所有虚拟机。

list_by_location(location: str, **kwargs: Any) -> Iterable[VirtualMachine]

参数

location: str

必需

查询订阅下虚拟机的位置。必需。

cls: callable

将传递直接响应的自定义类型或函数

迭代器，例如 VirtualMachine 的实例或 cls 的结果 (响应)

返回类型

ItemPaged[VirtualMachine]

例外

HttpResponseError

属性

models

models = <module 'azure.mgmt.compute.v2019_07_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\compute\\v2019_07_01\\models\\__init__.py'>