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

VirtualMachineScaleSetsOperations 类

警告

请勿直接实例化此类。

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

ComputeManagementClient's

<xref:virtual_machine_scale_sets> 属性。

继承
builtins.object
VirtualMachineScaleSetsOperations

构造函数

VirtualMachineScaleSetsOperations(*args, **kwargs)

方法

begin_create_or_update

创建或更新 VM 规模集。

begin_deallocate

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

begin_delete

删除 VM 规模集。

begin_delete_instances

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

begin_perform_maintenance

在 VM 规模集中的一个或多个虚拟机上执行维护。 对不符合执行维护条件的实例的操作将失败。 有关更多详细信息,请参阅最佳做法: https://docs.microsoft.com/en-us/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-maintenance-notifications

begin_power_off

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

begin_redeploy

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

begin_reimage

重置映像 (升级操作系统) VM 规模集中没有临时 OS 磁盘的一个或多个虚拟机,对于具有临时 OS 磁盘的虚拟机,虚拟机将重置为初始状态。

begin_reimage_all

重置所有磁盘 ( 映像,包括 VM 规模集中虚拟机中 ) 的数据磁盘。 仅托管磁盘支持此操作。

begin_restart

重启 VM 规模集中的一个或多个虚拟机。

begin_start

启动 VM 规模集中的一个或多个虚拟机。

begin_update

更新 VM 规模集。

begin_update_instances

将一个或多个虚拟机升级到 VM 规模集模型中的最新 SKU 集。

force_recovery_service_fabric_platform_update_domain_walk

手动平台更新域用于更新 Service Fabric 虚拟机规模集中的虚拟机。

get

显示有关虚拟机规模集的信息。

get_instance_view

获取 VM 规模集实例的状态。

get_os_upgrade_history

获取 VM 规模集实例上的 OS 升级列表。

list

获取资源组下所有 VM 规模集的列表。

list_all

获取订阅中所有 VM 规模集的列表,而不考虑关联的资源组。 在响应中使用 nextLink 属性获取 VM 规模集的下一页。 执行此操作,直到 nextLink 为 null 可提取所有 VM 规模集。

list_skus

获取可用于 VM 规模集的 SKU 列表,包括每个 SKU 允许的最小和最大 VM 实例数。

begin_create_or_update

创建或更新 VM 规模集。

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

参数

resource_group_name
str
必需

资源组的名称。 必需。

vm_scale_set_name
str
必需

要创建或更新的 VM 规模集的名称。 必需。

parameters
VirtualMachineScaleSetIO
必需

规模集对象。 是 VirtualMachineScaleSet 类型或 IO 类型。 必需。

content_type
str

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

cls
callable

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

continuation_token
str

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

polling
boolPollingMethod

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

polling_interval
int

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

返回

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

返回类型

例外

begin_deallocate

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

begin_deallocate(resource_group_name: str, vm_scale_set_name: str, vm_instance_i_ds: _models.VirtualMachineScaleSetVMInstanceIDs | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

参数

resource_group_name
str
必需

资源组的名称。 必需。

vm_scale_set_name
str
必需

VM 规模集的名称。 必需。

vm_instance_i_ds
VirtualMachineScaleSetVMInstanceIDsIO
必需

VM 规模集中的虚拟机实例 ID 列表。 是 VirtualMachineScaleSetVMInstanceIDs 类型或 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_delete

删除 VM 规模集。

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

参数

resource_group_name
str
必需

资源组的名称。 必需。

vm_scale_set_name
str
必需

VM 规模集的名称。 必需。

cls
callable

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

continuation_token
str

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

polling
boolPollingMethod

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

polling_interval
int

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

返回

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

返回类型

例外

begin_delete_instances

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

begin_delete_instances(resource_group_name: str, vm_scale_set_name: str, vm_instance_i_ds: _models.VirtualMachineScaleSetVMInstanceRequiredIDs, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

参数

resource_group_name
str
必需

资源组的名称。 必需。

vm_scale_set_name
str
必需

VM 规模集的名称。 必需。

vm_instance_i_ds
VirtualMachineScaleSetVMInstanceRequiredIDsIO
必需

VM 规模集中的虚拟机实例 ID 列表。 是 VirtualMachineScaleSetVMInstanceRequiredIDs 类型或 IO 类型。 必需。

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_perform_maintenance

在 VM 规模集中的一个或多个虚拟机上执行维护。 对不符合执行维护条件的实例的操作将失败。 有关更多详细信息,请参阅最佳做法: https://docs.microsoft.com/en-us/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-maintenance-notifications

begin_perform_maintenance(resource_group_name: str, vm_scale_set_name: str, vm_instance_i_ds: _models.VirtualMachineScaleSetVMInstanceIDs | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

参数

resource_group_name
str
必需

资源组的名称。 必需。

vm_scale_set_name
str
必需

VM 规模集的名称。 必需。

vm_instance_i_ds
VirtualMachineScaleSetVMInstanceIDsIO
必需

VM 规模集中的虚拟机实例 ID 列表。 是 VirtualMachineScaleSetVMInstanceIDs 类型或 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_power_off

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

begin_power_off(resource_group_name: str, vm_scale_set_name: str, vm_instance_i_ds: _models.VirtualMachineScaleSetVMInstanceIDs | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

参数

resource_group_name
str
必需

资源组的名称。 必需。

vm_scale_set_name
str
必需

VM 规模集的名称。 必需。

vm_instance_i_ds
VirtualMachineScaleSetVMInstanceIDsIO
必需

VM 规模集中的虚拟机实例 ID 列表。 是 VirtualMachineScaleSetVMInstanceIDs 类型或 IO 类型。 默认值为 None。

content_type
str

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

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, vm_instance_i_ds: _models.VirtualMachineScaleSetVMInstanceIDs | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

参数

resource_group_name
str
必需

资源组的名称。 必需。

vm_scale_set_name
str
必需

VM 规模集的名称。 必需。

vm_instance_i_ds
VirtualMachineScaleSetVMInstanceIDsIO
必需

VM 规模集中的虚拟机实例 ID 列表。 是 VirtualMachineScaleSetVMInstanceIDs 类型或 IO 类型。 默认值为 None。

content_type
str

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

cls
callable

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

continuation_token
str

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

polling
boolPollingMethod

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

polling_interval
int

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

返回

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

返回类型

例外

begin_reimage

重置映像 (升级操作系统) VM 规模集中没有临时 OS 磁盘的一个或多个虚拟机,对于具有临时 OS 磁盘的虚拟机,虚拟机将重置为初始状态。

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

参数

resource_group_name
str
必需

资源组的名称。 必需。

vm_scale_set_name
str
必需

VM 规模集的名称。 必需。

vm_scale_set_reimage_input
VirtualMachineScaleSetReimageParametersIO
必需

用于重置 VM ScaleSet 映像的参数。 是 VirtualMachineScaleSetReimageParameters 类型或 IO 类型。 默认值为 None。

content_type
str

正文参数内容类型。 已知值为:“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, vm_instance_i_ds: _models.VirtualMachineScaleSetVMInstanceIDs | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

参数

resource_group_name
str
必需

资源组的名称。 必需。

vm_scale_set_name
str
必需

VM 规模集的名称。 必需。

vm_instance_i_ds
VirtualMachineScaleSetVMInstanceIDsIO
必需

VM 规模集中的虚拟机实例 ID 列表。 是 VirtualMachineScaleSetVMInstanceIDs 类型或 IO 类型。 默认值为 None。

content_type
str

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

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, vm_instance_i_ds: _models.VirtualMachineScaleSetVMInstanceIDs | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

参数

resource_group_name
str
必需

资源组的名称。 必需。

vm_scale_set_name
str
必需

VM 规模集的名称。 必需。

vm_instance_i_ds
VirtualMachineScaleSetVMInstanceIDsIO
必需

VM 规模集中的虚拟机实例 ID 列表。 是 VirtualMachineScaleSetVMInstanceIDs 类型或 IO 类型。 默认值为 None。

content_type
str

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

cls
callable

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

continuation_token
str

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

polling
boolPollingMethod

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

polling_interval
int

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

返回

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

返回类型

例外

begin_start

启动 VM 规模集中的一个或多个虚拟机。

begin_start(resource_group_name: str, vm_scale_set_name: str, vm_instance_i_ds: _models.VirtualMachineScaleSetVMInstanceIDs | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

参数

resource_group_name
str
必需

资源组的名称。 必需。

vm_scale_set_name
str
必需

VM 规模集的名称。 必需。

vm_instance_i_ds
VirtualMachineScaleSetVMInstanceIDsIO
必需

VM 规模集中的虚拟机实例 ID 列表。 是 VirtualMachineScaleSetVMInstanceIDs 类型或 IO 类型。 默认值为 None。

content_type
str

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

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, parameters: _models.VirtualMachineScaleSetUpdate, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.VirtualMachineScaleSet]

参数

resource_group_name
str
必需

资源组的名称。 必需。

vm_scale_set_name
str
必需

要创建或更新的 VM 规模集的名称。 必需。

parameters
VirtualMachineScaleSetUpdateIO
必需

规模集对象。 是 VirtualMachineScaleSetUpdate 类型或 IO 类型。 必需。

content_type
str

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

cls
callable

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

continuation_token
str

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

polling
boolPollingMethod

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

polling_interval
int

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

返回

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

返回类型

例外

begin_update_instances

将一个或多个虚拟机升级到 VM 规模集模型中的最新 SKU 集。

begin_update_instances(resource_group_name: str, vm_scale_set_name: str, vm_instance_i_ds: _models.VirtualMachineScaleSetVMInstanceRequiredIDs, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

参数

resource_group_name
str
必需

资源组的名称。 必需。

vm_scale_set_name
str
必需

VM 规模集的名称。 必需。

vm_instance_i_ds
VirtualMachineScaleSetVMInstanceRequiredIDsIO
必需

VM 规模集中的虚拟机实例 ID 列表。 是 VirtualMachineScaleSetVMInstanceRequiredIDs 类型或 IO 类型。 必需。

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 的结果 (响应)

返回类型

例外

force_recovery_service_fabric_platform_update_domain_walk

手动平台更新域用于更新 Service Fabric 虚拟机规模集中的虚拟机。

force_recovery_service_fabric_platform_update_domain_walk(resource_group_name: str, vm_scale_set_name: str, *, platform_update_domain: int, **kwargs: Any) -> RecoveryWalkResponse

参数

resource_group_name
str
必需

资源组的名称。 必需。

vm_scale_set_name
str
必需

VM 规模集的名称。 必需。

platform_update_domain
int

为其请求手动恢复演练的平台更新域。 必需。

cls
callable

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

返回

RecoveryWalkResponse 或 cls 的结果 (响应)

返回类型

例外

get

显示有关虚拟机规模集的信息。

get(resource_group_name: str, vm_scale_set_name: str, **kwargs: Any) -> VirtualMachineScaleSet

参数

resource_group_name
str
必需

资源组的名称。 必需。

vm_scale_set_name
str
必需

VM 规模集的名称。 必需。

cls
callable

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

返回

VirtualMachineScaleSet 或 cls 的结果 (响应)

返回类型

例外

get_instance_view

获取 VM 规模集实例的状态。

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

参数

resource_group_name
str
必需

资源组的名称。 必需。

vm_scale_set_name
str
必需

VM 规模集的名称。 必需。

cls
callable

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

返回

VirtualMachineScaleSetInstanceView 或 cls 的结果 (响应)

返回类型

例外

get_os_upgrade_history

获取 VM 规模集实例上的 OS 升级列表。

get_os_upgrade_history(resource_group_name: str, vm_scale_set_name: str, **kwargs: Any) -> Iterable[UpgradeOperationHistoricalStatusInfo]

参数

resource_group_name
str
必需

资源组的名称。 必需。

vm_scale_set_name
str
必需

VM 规模集的名称。 必需。

cls
callable

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

返回

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

返回类型

例外

list

获取资源组下所有 VM 规模集的列表。

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

参数

resource_group_name
str
必需

资源组的名称。 必需。

cls
callable

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

返回

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

返回类型

例外

list_all

获取订阅中所有 VM 规模集的列表,而不考虑关联的资源组。 在响应中使用 nextLink 属性获取 VM 规模集的下一页。 执行此操作,直到 nextLink 为 null 可提取所有 VM 规模集。

list_all(**kwargs: Any) -> Iterable[VirtualMachineScaleSet]

参数

cls
callable

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

返回

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

返回类型

例外

list_skus

获取可用于 VM 规模集的 SKU 列表,包括每个 SKU 允许的最小和最大 VM 实例数。

list_skus(resource_group_name: str, vm_scale_set_name: str, **kwargs: Any) -> Iterable[VirtualMachineScaleSetSku]

参数

resource_group_name
str
必需

资源组的名称。 必需。

vm_scale_set_name
str
必需

VM 规模集的名称。 必需。

cls
callable

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

返回

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

返回类型

例外

属性

models

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