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

VirtualMachineScaleSetVMsOperations 类

警告

请勿直接实例化此类。

相反,应通过以下方式访问以下操作:

ComputeManagementClient's

<xref:virtual_machine_scale_set_vms> 属性。

继承
builtins.object
VirtualMachineScaleSetVMsOperations

构造函数

VirtualMachineScaleSetVMsOperations(*args, **kwargs)

方法

begin_deallocate

解除分配 VM 规模集中的特定虚拟机。 关闭虚拟机并释放其使用的计算资源。 解除分配后,无需为此虚拟机的计算资源付费。

begin_delete

从 VM 规模集中删除虚拟机。

begin_perform_maintenance

在 VM 规模集中的虚拟机上执行维护。

begin_power_off

关闭 (停止) VM 规模集中的虚拟机。 请注意,资源仍附加,需要为资源付费。 相反,请使用解除分配来释放资源并避免产生费用。

begin_redeploy

关闭虚拟机规模集中的虚拟机,将其移动到新节点,并重新打开它。

begin_reimage

重置映像 (升级 VM 规模集中的特定虚拟机) 操作系统。

begin_reimage_all

允许对 VM 规模集实例中的所有磁盘 ( 包括数据磁盘 ) 重新映像。 仅托管磁盘支持此操作。

begin_restart

重启 VM 规模集中的虚拟机。

begin_run_command

在 VM 规模集中的虚拟机上运行命令。

begin_start

启动 VM 规模集中的虚拟机。

begin_update

汇报 VM 规模集的虚拟机。

get

从 VM 规模集获取虚拟机。

get_instance_view

从 VM 规模集获取虚拟机的状态。

list

获取 VM 规模集中所有虚拟机的列表。

retrieve_boot_diagnostics_data

用于检索 VM 规模集中虚拟机的启动诊断日志的 SAS URI 的操作。

simulate_eviction

用于模拟 VM 规模集中逐出现成虚拟机的操作。

begin_deallocate

解除分配 VM 规模集中的特定虚拟机。 关闭虚拟机并释放其使用的计算资源。 解除分配后,无需为此虚拟机的计算资源付费。

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

参数

resource_group_name
str
必需

资源组的名称。 必需。

vm_scale_set_name
str
必需

VM 规模集的名称。 必需。

instance_id
str
必需

虚拟机的实例 ID。 必需。

cls
callable

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

continuation_token
str

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

polling
boolPollingMethod

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

polling_interval
int

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

返回

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

返回类型

例外

begin_delete

从 VM 规模集中删除虚拟机。

begin_delete(resource_group_name: str, vm_scale_set_name: str, instance_id: str, *, force_deletion: bool | None = None, **kwargs: Any) -> LROPoller[None]

参数

resource_group_name
str
必需

资源组的名称。 必需。

vm_scale_set_name
str
必需

VM 规模集的名称。 必需。

instance_id
str
必需

虚拟机的实例 ID。 必需。

force_deletion
bool

强制从 VM 规模集中删除虚拟机的可选参数。 预览版) 中的 (功能。 默认值为 None。

cls
callable

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

continuation_token
str

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

polling
boolPollingMethod

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

polling_interval
int

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

返回

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

返回类型

例外

begin_perform_maintenance

在 VM 规模集中的虚拟机上执行维护。

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

参数

resource_group_name
str
必需

资源组的名称。 必需。

vm_scale_set_name
str
必需

VM 规模集的名称。 必需。

instance_id
str
必需

虚拟机的实例 ID。 必需。

cls
callable

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

continuation_token
str

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

polling
boolPollingMethod

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

polling_interval
int

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

返回

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

返回类型

例外

begin_power_off

关闭 (停止) VM 规模集中的虚拟机。 请注意,资源仍附加,需要为资源付费。 相反,请使用解除分配来释放资源并避免产生费用。

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

参数

resource_group_name
str
必需

资源组的名称。 必需。

vm_scale_set_name
str
必需

VM 规模集的名称。 必需。

instance_id
str
必需

虚拟机的实例 ID。 必需。

skip_shutdown
bool

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

cls
callable

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

continuation_token
str

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

polling
boolPollingMethod

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

polling_interval
int

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

返回

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

返回类型

例外

begin_redeploy

关闭虚拟机规模集中的虚拟机,将其移动到新节点,并重新打开它。

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

参数

resource_group_name
str
必需

资源组的名称。 必需。

vm_scale_set_name
str
必需

VM 规模集的名称。 必需。

instance_id
str
必需

虚拟机的实例 ID。 必需。

cls
callable

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

continuation_token
str

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

polling
boolPollingMethod

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

polling_interval
int

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

返回

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

返回类型

例外

begin_reimage

重置映像 (升级 VM 规模集中的特定虚拟机) 操作系统。

begin_reimage(resource_group_name: str, vm_scale_set_name: str, instance_id: str, vm_scale_set_vm_reimage_input: _models.VirtualMachineScaleSetVMReimageParameters | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

参数

resource_group_name
str
必需

资源组的名称。 必需。

vm_scale_set_name
str
必需

VM 规模集的名称。 必需。

instance_id
str
必需

虚拟机的实例 ID。 必需。

vm_scale_set_vm_reimage_input
VirtualMachineScaleSetVMReimageParametersIO
必需

用于在 ScaleSet 中重置虚拟机映像的参数。 是 VirtualMachineScaleSetVMReimageParameters 类型或 IO 类型。 默认值为 None。

content_type
str

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

cls
callable

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

continuation_token
str

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

polling
boolPollingMethod

默认情况下,轮询方法将为 ARMPolling。 如果此操作不轮询,则传入 False,或者为个人轮询策略传入你自己的初始化轮询对象。

polling_interval
int

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

返回

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

返回类型

例外

begin_reimage_all

允许对 VM 规模集实例中的所有磁盘 ( 包括数据磁盘 ) 重新映像。 仅托管磁盘支持此操作。

begin_reimage_all(resource_group_name: str, vm_scale_set_name: str, instance_id: str, **kwargs: Any) -> LROPoller[None]

参数

resource_group_name
str
必需

资源组的名称。 必需。

vm_scale_set_name
str
必需

VM 规模集的名称。 必需。

instance_id
str
必需

虚拟机的实例 ID。 必需。

cls
callable

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

continuation_token
str

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

polling
boolPollingMethod

默认情况下,轮询方法将为 ARMPolling。 如果此操作不轮询,则传入 False,或者为个人轮询策略传入你自己的初始化轮询对象。

polling_interval
int

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

返回

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

返回类型

例外

begin_restart

重启 VM 规模集中的虚拟机。

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

参数

resource_group_name
str
必需

资源组的名称。 必需。

vm_scale_set_name
str
必需

VM 规模集的名称。 必需。

instance_id
str
必需

虚拟机的实例 ID。 必需。

cls
callable

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

continuation_token
str

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

polling
boolPollingMethod

默认情况下,轮询方法将为 ARMPolling。 如果此操作不轮询,则传入 False,或者为个人轮询策略传入你自己的初始化轮询对象。

polling_interval
int

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

返回

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

返回类型

例外

begin_run_command

在 VM 规模集中的虚拟机上运行命令。

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

参数

resource_group_name
str
必需

资源组的名称。 必需。

vm_scale_set_name
str
必需

VM 规模集的名称。 必需。

instance_id
str
必需

虚拟机的实例 ID。 必需。

parameters
RunCommandInputIO
必需

提供给运行命令操作的参数。 是 RunCommandInput 类型还是 IO 类型。 必需。

content_type
str

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

cls
callable

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

continuation_token
str

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

polling
boolPollingMethod

默认情况下,轮询方法将为 ARMPolling。 如果此操作不轮询,则传入 False,或者为个人轮询策略传入你自己的初始化轮询对象。

polling_interval
int

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

返回

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

返回类型

例外

begin_start

启动 VM 规模集中的虚拟机。

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

参数

resource_group_name
str
必需

资源组的名称。 必需。

vm_scale_set_name
str
必需

VM 规模集的名称。 必需。

instance_id
str
必需

虚拟机的实例 ID。 必需。

cls
callable

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

continuation_token
str

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

polling
boolPollingMethod

默认情况下,轮询方法将为 ARMPolling。 如果此操作不轮询,则传入 False,或者为个人轮询策略传入你自己的初始化轮询对象。

polling_interval
int

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

返回

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

返回类型

例外

begin_update

汇报 VM 规模集的虚拟机。

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

参数

resource_group_name
str
必需

资源组的名称。 必需。

vm_scale_set_name
str
必需

应在其中创建或更新扩展的 VM 规模集的名称。 必需。

instance_id
str
必需

虚拟机的实例 ID。 必需。

parameters
VirtualMachineScaleSetVMIO
必需

提供给更新虚拟机规模集 VM 操作的参数。 是 VirtualMachineScaleSetVM 类型还是 IO 类型。 必需。

content_type
str

正文参数内容类型。 已知值为:“application/json”。 默认值为 None。

cls
callable

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

continuation_token
str

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

polling
boolPollingMethod

默认情况下,轮询方法将为 ARMPolling。 如果此操作不轮询,则传入 False,或者为个人轮询策略传入你自己的初始化轮询对象。

polling_interval
int

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

返回

LROPoller 的实例,返回 VirtualMachineScaleSetVM 或 cls (响应)

返回类型

例外

get

从 VM 规模集获取虚拟机。

get(resource_group_name: str, vm_scale_set_name: str, instance_id: str, *, expand: str | InstanceViewTypes | None = None, **kwargs: Any) -> VirtualMachineScaleSetVM

参数

resource_group_name
str
必需

资源组的名称。 必需。

vm_scale_set_name
str
必需

VM 规模集的名称。 必需。

instance_id
str
必需

虚拟机的实例 ID。 必需。

expand
strInstanceViewTypes

要应用于操作的 expand 表达式。 “InstanceView”将检索虚拟机的实例视图。 “UserData”将检索虚拟机的 UserData。 已知值为:“instanceView”和“userData”。 默认值为 None。

cls
callable

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

返回

VirtualMachineScaleSetVM 或 cls 的结果 (响应)

返回类型

例外

get_instance_view

从 VM 规模集获取虚拟机的状态。

get_instance_view(resource_group_name: str, vm_scale_set_name: str, instance_id: str, **kwargs: Any) -> VirtualMachineScaleSetVMInstanceView

参数

resource_group_name
str
必需

资源组的名称。 必需。

vm_scale_set_name
str
必需

VM 规模集的名称。 必需。

instance_id
str
必需

虚拟机的实例 ID。 必需。

cls
callable

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

返回

VirtualMachineScaleSetVMInstanceView 或 cls 的结果 (响应)

返回类型

例外

list

获取 VM 规模集中所有虚拟机的列表。

list(resource_group_name: str, virtual_machine_scale_set_name: str, *, filter: str | None = None, select: str | None = None, expand: str | None = None, **kwargs: Any) -> Iterable[VirtualMachineScaleSetVM]

参数

resource_group_name
str
必需

资源组的名称。 必需。

virtual_machine_scale_set_name
str
必需

VM 规模集的名称。 必需。

filter
str

要应用于操作的筛选器。 允许的值为“startswith (instanceView/statuses/code、'PowerState') eq true”、“properties/latestModelApplied eq true”、“properties/latestModelApplied eq false”。 默认值为 None。

select
str

列表参数。 允许的值为“instanceView”、“instanceView/statuses”。 默认值为 None。

expand
str

要应用于操作的 expand 表达式。 允许的值为“instanceView”。 默认值为 None。

cls
callable

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

返回

迭代器,例如 VirtualMachineScaleSetVM 的实例或 cls 的结果 (响应)

返回类型

例外

retrieve_boot_diagnostics_data

用于检索 VM 规模集中虚拟机的启动诊断日志的 SAS URI 的操作。

retrieve_boot_diagnostics_data(resource_group_name: str, vm_scale_set_name: str, instance_id: str, *, sas_uri_expiration_time_in_minutes: int | None = None, **kwargs: Any) -> RetrieveBootDiagnosticsDataResult

参数

resource_group_name
str
必需

资源组的名称。 必需。

vm_scale_set_name
str
必需

VM 规模集的名称。 必需。

instance_id
str
必需

虚拟机的实例 ID。 必需。

sas_uri_expiration_time_in_minutes
int

值为 1 到 1440 分钟的 SAS URI 的过期持续时间(以分钟为单位)。 注意: 如果未指定,则会生成默认过期持续时间为 120 分钟的 SAS URI。 默认值为 None。

cls
callable

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

返回

RetrieveBootDiagnosticsDataResult 或 cls 的结果 (响应)

返回类型

例外

simulate_eviction

用于模拟 VM 规模集中逐出现成虚拟机的操作。

simulate_eviction(resource_group_name: str, vm_scale_set_name: str, instance_id: str, **kwargs: Any) -> None

参数

resource_group_name
str
必需

资源组的名称。 必需。

vm_scale_set_name
str
必需

VM 规模集的名称。 必需。

instance_id
str
必需

虚拟机的实例 ID。 必需。

cls
callable

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

返回

无或 cls 的结果 (响应)

返回类型

例外

属性

models

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