VirtualMachineScaleSets interface
表示 VirtualMachineScaleSets 的接口。
方法
方法详细信息
beginCreateOrUpdate(string, string, VirtualMachineScaleSet, VirtualMachineScaleSetsCreateOrUpdateOptionalParams)
创建或更新 VM 规模集。
function beginCreateOrUpdate(resourceGroupName: string, vmScaleSetName: string, parameters: VirtualMachineScaleSet, options?: VirtualMachineScaleSetsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<VirtualMachineScaleSet>, VirtualMachineScaleSet>>参数
- resourceGroupName
-
string
资源组的名称。
- vmScaleSetName
-
string
要创建或更新的 VM 规模集的名称。
- parameters
- VirtualMachineScaleSet
规模集对象。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<VirtualMachineScaleSet>, VirtualMachineScaleSet>>
beginCreateOrUpdateAndWait(string, string, VirtualMachineScaleSet, VirtualMachineScaleSetsCreateOrUpdateOptionalParams)
创建或更新 VM 规模集。
function beginCreateOrUpdateAndWait(resourceGroupName: string, vmScaleSetName: string, parameters: VirtualMachineScaleSet, options?: VirtualMachineScaleSetsCreateOrUpdateOptionalParams): Promise<VirtualMachineScaleSet>参数
- resourceGroupName
-
string
资源组的名称。
- vmScaleSetName
-
string
要创建或更新的 VM 规模集的名称。
- parameters
- VirtualMachineScaleSet
规模集对象。
选项参数。
返回
Promise<VirtualMachineScaleSet>
beginDeallocate(string, string, VirtualMachineScaleSetsDeallocateOptionalParams)
解除分配 VM 规模集中的特定虚拟机。 关闭虚拟机并释放计算资源。 不会为此虚拟机规模集解除分配的计算资源付费。
function beginDeallocate(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsDeallocateOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。
- vmScaleSetName
-
string
VM 规模集的名称。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeallocateAndWait(string, string, VirtualMachineScaleSetsDeallocateOptionalParams)
解除分配 VM 规模集中的特定虚拟机。 关闭虚拟机并释放计算资源。 不会为此虚拟机规模集解除分配的计算资源付费。
function beginDeallocateAndWait(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsDeallocateOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。
- vmScaleSetName
-
string
VM 规模集的名称。
选项参数。
返回
Promise<void>
beginDelete(string, string, VirtualMachineScaleSetsDeleteOptionalParams)
删除 VM 规模集。
function beginDelete(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。
- vmScaleSetName
-
string
VM 规模集的名称。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeleteAndWait(string, string, VirtualMachineScaleSetsDeleteOptionalParams)
删除 VM 规模集。
function beginDeleteAndWait(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsDeleteOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。
- vmScaleSetName
-
string
VM 规模集的名称。
选项参数。
返回
Promise<void>
beginDeleteInstances(string, string, VirtualMachineScaleSetVMInstanceRequiredIDs, VirtualMachineScaleSetsDeleteInstancesOptionalParams)
删除 VM 规模集中的虚拟机。
function beginDeleteInstances(resourceGroupName: string, vmScaleSetName: string, vmInstanceIDs: VirtualMachineScaleSetVMInstanceRequiredIDs, options?: VirtualMachineScaleSetsDeleteInstancesOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。
- vmScaleSetName
-
string
VM 规模集的名称。
- vmInstanceIDs
- VirtualMachineScaleSetVMInstanceRequiredIDs
VM 规模集中的虚拟机实例 ID 的列表。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeleteInstancesAndWait(string, string, VirtualMachineScaleSetVMInstanceRequiredIDs, VirtualMachineScaleSetsDeleteInstancesOptionalParams)
删除 VM 规模集中的虚拟机。
function beginDeleteInstancesAndWait(resourceGroupName: string, vmScaleSetName: string, vmInstanceIDs: VirtualMachineScaleSetVMInstanceRequiredIDs, options?: VirtualMachineScaleSetsDeleteInstancesOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。
- vmScaleSetName
-
string
VM 规模集的名称。
- vmInstanceIDs
- VirtualMachineScaleSetVMInstanceRequiredIDs
VM 规模集中的虚拟机实例 ID 的列表。
选项参数。
返回
Promise<void>
beginPerformMaintenance(string, string, VirtualMachineScaleSetsPerformMaintenanceOptionalParams)
在 VM 规模集中的一个或多个虚拟机上执行维护。 对不符合执行维护条件的实例的作将失败。 有关更多详细信息，请参阅最佳做法：https://docs.microsoft.com/en-us/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-maintenance-notifications
function beginPerformMaintenance(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsPerformMaintenanceOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。
- vmScaleSetName
-
string
VM 规模集的名称。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginPerformMaintenanceAndWait(string, string, VirtualMachineScaleSetsPerformMaintenanceOptionalParams)
在 VM 规模集中的一个或多个虚拟机上执行维护。 对不符合执行维护条件的实例的作将失败。 有关更多详细信息，请参阅最佳做法：https://docs.microsoft.com/en-us/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-maintenance-notifications
function beginPerformMaintenanceAndWait(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsPerformMaintenanceOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。
- vmScaleSetName
-
string
VM 规模集的名称。
选项参数。
返回
Promise<void>
beginPowerOff(string, string, VirtualMachineScaleSetsPowerOffOptionalParams)
关闭（停止）VM 规模集中的一个或多个虚拟机。 请注意，资源仍附加，并且需要为资源付费。 而是使用解除分配释放资源并避免产生费用。
function beginPowerOff(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsPowerOffOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。
- vmScaleSetName
-
string
VM 规模集的名称。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginPowerOffAndWait(string, string, VirtualMachineScaleSetsPowerOffOptionalParams)
关闭（停止）VM 规模集中的一个或多个虚拟机。 请注意，资源仍附加，并且需要为资源付费。 而是使用解除分配释放资源并避免产生费用。
function beginPowerOffAndWait(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsPowerOffOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。
- vmScaleSetName
-
string
VM 规模集的名称。
选项参数。
返回
Promise<void>
beginRedeploy(string, string, VirtualMachineScaleSetsRedeployOptionalParams)
关闭虚拟机规模集中的所有虚拟机，将其移动到新节点，并重新启用它们。
function beginRedeploy(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsRedeployOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。
- vmScaleSetName
-
string
VM 规模集的名称。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginRedeployAndWait(string, string, VirtualMachineScaleSetsRedeployOptionalParams)
关闭虚拟机规模集中的所有虚拟机，将其移动到新节点，并重新启用它们。
function beginRedeployAndWait(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsRedeployOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。
- vmScaleSetName
-
string
VM 规模集的名称。
选项参数。
返回
Promise<void>
beginReimage(string, string, VirtualMachineScaleSetsReimageOptionalParams)
对于具有临时 OS 磁盘的虚拟机，虚拟机重置为初始状态的 VM 规模集中的一个或多个虚拟机（升级作系统）（升级作系统）。
function beginReimage(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsReimageOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。
- vmScaleSetName
-
string
VM 规模集的名称。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginReimageAll(string, string, VirtualMachineScaleSetsReimageAllOptionalParams)
重置 VM 规模集中虚拟机中所有磁盘（包括数据磁盘）的映像。 仅托管磁盘支持此作。
function beginReimageAll(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsReimageAllOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。
- vmScaleSetName
-
string
VM 规模集的名称。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginReimageAllAndWait(string, string, VirtualMachineScaleSetsReimageAllOptionalParams)
重置 VM 规模集中虚拟机中所有磁盘（包括数据磁盘）的映像。 仅托管磁盘支持此作。
function beginReimageAllAndWait(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsReimageAllOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。
- vmScaleSetName
-
string
VM 规模集的名称。
选项参数。
返回
Promise<void>
beginReimageAndWait(string, string, VirtualMachineScaleSetsReimageOptionalParams)
对于具有临时 OS 磁盘的虚拟机，虚拟机重置为初始状态的 VM 规模集中的一个或多个虚拟机（升级作系统）（升级作系统）。
function beginReimageAndWait(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsReimageOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。
- vmScaleSetName
-
string
VM 规模集的名称。
选项参数。
返回
Promise<void>
beginRestart(string, string, VirtualMachineScaleSetsRestartOptionalParams)
重启 VM 规模集中的一个或多个虚拟机。
function beginRestart(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsRestartOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。
- vmScaleSetName
-
string
VM 规模集的名称。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginRestartAndWait(string, string, VirtualMachineScaleSetsRestartOptionalParams)
重启 VM 规模集中的一个或多个虚拟机。
function beginRestartAndWait(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsRestartOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。
- vmScaleSetName
-
string
VM 规模集的名称。
选项参数。
返回
Promise<void>
beginSetOrchestrationServiceState(string, string, OrchestrationServiceStateInput, VirtualMachineScaleSetsSetOrchestrationServiceStateOptionalParams)
更改给定服务的 ServiceState 属性
function beginSetOrchestrationServiceState(resourceGroupName: string, vmScaleSetName: string, parameters: OrchestrationServiceStateInput, options?: VirtualMachineScaleSetsSetOrchestrationServiceStateOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。
- vmScaleSetName
-
string
要创建或更新的虚拟机规模集的名称。
- parameters
- OrchestrationServiceStateInput
SetOrchestrationServiceState API 的输入对象。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginSetOrchestrationServiceStateAndWait(string, string, OrchestrationServiceStateInput, VirtualMachineScaleSetsSetOrchestrationServiceStateOptionalParams)
更改给定服务的 ServiceState 属性
function beginSetOrchestrationServiceStateAndWait(resourceGroupName: string, vmScaleSetName: string, parameters: OrchestrationServiceStateInput, options?: VirtualMachineScaleSetsSetOrchestrationServiceStateOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。
- vmScaleSetName
-
string
要创建或更新的虚拟机规模集的名称。
- parameters
- OrchestrationServiceStateInput
SetOrchestrationServiceState API 的输入对象。
返回
Promise<void>
beginStart(string, string, VirtualMachineScaleSetsStartOptionalParams)
在 VM 规模集中启动一个或多个虚拟机。
function beginStart(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsStartOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。
- vmScaleSetName
-
string
VM 规模集的名称。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginStartAndWait(string, string, VirtualMachineScaleSetsStartOptionalParams)
在 VM 规模集中启动一个或多个虚拟机。
function beginStartAndWait(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsStartOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。
- vmScaleSetName
-
string
VM 规模集的名称。
选项参数。
返回
Promise<void>
beginUpdate(string, string, VirtualMachineScaleSetUpdate, VirtualMachineScaleSetsUpdateOptionalParams)
更新 VM 规模集。
function beginUpdate(resourceGroupName: string, vmScaleSetName: string, parameters: VirtualMachineScaleSetUpdate, options?: VirtualMachineScaleSetsUpdateOptionalParams): Promise<PollerLike<PollOperationState<VirtualMachineScaleSet>, VirtualMachineScaleSet>>参数
- resourceGroupName
-
string
资源组的名称。
- vmScaleSetName
-
string
要创建或更新的 VM 规模集的名称。
- parameters
- VirtualMachineScaleSetUpdate
规模集对象。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<VirtualMachineScaleSet>, VirtualMachineScaleSet>>
beginUpdateAndWait(string, string, VirtualMachineScaleSetUpdate, VirtualMachineScaleSetsUpdateOptionalParams)
更新 VM 规模集。
function beginUpdateAndWait(resourceGroupName: string, vmScaleSetName: string, parameters: VirtualMachineScaleSetUpdate, options?: VirtualMachineScaleSetsUpdateOptionalParams): Promise<VirtualMachineScaleSet>参数
- resourceGroupName
-
string
资源组的名称。
- vmScaleSetName
-
string
要创建或更新的 VM 规模集的名称。
- parameters
- VirtualMachineScaleSetUpdate
规模集对象。
选项参数。
返回
Promise<VirtualMachineScaleSet>
beginUpdateInstances(string, string, VirtualMachineScaleSetVMInstanceRequiredIDs, VirtualMachineScaleSetsUpdateInstancesOptionalParams)
将一个或多个虚拟机升级到 VM 规模集模型中的最新 SKU 集。
function beginUpdateInstances(resourceGroupName: string, vmScaleSetName: string, vmInstanceIDs: VirtualMachineScaleSetVMInstanceRequiredIDs, options?: VirtualMachineScaleSetsUpdateInstancesOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。
- vmScaleSetName
-
string
VM 规模集的名称。
- vmInstanceIDs
- VirtualMachineScaleSetVMInstanceRequiredIDs
VM 规模集中的虚拟机实例 ID 的列表。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginUpdateInstancesAndWait(string, string, VirtualMachineScaleSetVMInstanceRequiredIDs, VirtualMachineScaleSetsUpdateInstancesOptionalParams)
将一个或多个虚拟机升级到 VM 规模集模型中的最新 SKU 集。
function beginUpdateInstancesAndWait(resourceGroupName: string, vmScaleSetName: string, vmInstanceIDs: VirtualMachineScaleSetVMInstanceRequiredIDs, options?: VirtualMachineScaleSetsUpdateInstancesOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。
- vmScaleSetName
-
string
VM 规模集的名称。
- vmInstanceIDs
- VirtualMachineScaleSetVMInstanceRequiredIDs
VM 规模集中的虚拟机实例 ID 的列表。
选项参数。
返回
Promise<void>
convertToSinglePlacementGroup(string, string, VMScaleSetConvertToSinglePlacementGroupInput, VirtualMachineScaleSetsConvertToSinglePlacementGroupOptionalParams)
将现有虚拟机规模集的 SinglePlacementGroup 属性转换为 false。
function convertToSinglePlacementGroup(resourceGroupName: string, vmScaleSetName: string, parameters: VMScaleSetConvertToSinglePlacementGroupInput, options?: VirtualMachineScaleSetsConvertToSinglePlacementGroupOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。
- vmScaleSetName
-
string
要创建或更新的虚拟机规模集的名称。
- parameters
- VMScaleSetConvertToSinglePlacementGroupInput
ConvertToSinglePlacementGroup API 的输入对象。
返回
Promise<void>
forceRecoveryServiceFabricPlatformUpdateDomainWalk(string, string, number, VirtualMachineScaleSetsForceRecoveryServiceFabricPlatformUpdateDomainWalkOptionalParams)
手动平台更新域演练以更新 Service Fabric 虚拟机规模集中的虚拟机。
function forceRecoveryServiceFabricPlatformUpdateDomainWalk(resourceGroupName: string, vmScaleSetName: string, platformUpdateDomain: number, options?: VirtualMachineScaleSetsForceRecoveryServiceFabricPlatformUpdateDomainWalkOptionalParams): Promise<RecoveryWalkResponse>参数
- resourceGroupName
-
string
资源组的名称。
- vmScaleSetName
-
string
VM 规模集的名称。
- platformUpdateDomain
-
number
为其请求手动恢复演练的平台更新域
选项参数。
返回
Promise<RecoveryWalkResponse>
get(string, string, VirtualMachineScaleSetsGetOptionalParams)
显示有关虚拟机规模集的信息。
function get(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsGetOptionalParams): Promise<VirtualMachineScaleSet>参数
- resourceGroupName
-
string
资源组的名称。
- vmScaleSetName
-
string
VM 规模集的名称。
选项参数。
返回
Promise<VirtualMachineScaleSet>
getInstanceView(string, string, VirtualMachineScaleSetsGetInstanceViewOptionalParams)
获取 VM 规模集实例的状态。
function getInstanceView(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsGetInstanceViewOptionalParams): Promise<VirtualMachineScaleSetInstanceView>参数
- resourceGroupName
-
string
资源组的名称。
- vmScaleSetName
-
string
VM 规模集的名称。
选项参数。
返回
Promise<VirtualMachineScaleSetInstanceView>
list(string, VirtualMachineScaleSetsListOptionalParams)
获取资源组下所有 VM 规模集的列表。
function list(resourceGroupName: string, options?: VirtualMachineScaleSetsListOptionalParams): PagedAsyncIterableIterator<VirtualMachineScaleSet, VirtualMachineScaleSet[], PageSettings>参数
- resourceGroupName
-
string
资源组的名称。
选项参数。
返回
listAll(VirtualMachineScaleSetsListAllOptionalParams)
获取订阅中所有 VM 规模集的列表，而不考虑关联的资源组。 在响应中使用 nextLink 属性获取 VM 规模集的下一页。 执行此作，直到 nextLink 为 null 以提取所有 VM 规模集。
function listAll(options?: VirtualMachineScaleSetsListAllOptionalParams): PagedAsyncIterableIterator<VirtualMachineScaleSet, VirtualMachineScaleSet[], PageSettings>参数
选项参数。
返回
listOSUpgradeHistory(string, string, VirtualMachineScaleSetsGetOSUpgradeHistoryOptionalParams)
获取 VM 规模集实例上的 OS 升级列表。
function listOSUpgradeHistory(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsGetOSUpgradeHistoryOptionalParams): PagedAsyncIterableIterator<UpgradeOperationHistoricalStatusInfo, UpgradeOperationHistoricalStatusInfo[], PageSettings>参数
- resourceGroupName
-
string
资源组的名称。
- vmScaleSetName
-
string
VM 规模集的名称。
选项参数。
返回
listSkus(string, string, VirtualMachineScaleSetsListSkusOptionalParams)
获取可用于 VM 规模集的 SKU 列表，包括每个 SKU 允许的最小和最大 VM 实例。
function listSkus(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsListSkusOptionalParams): PagedAsyncIterableIterator<VirtualMachineScaleSetSku, VirtualMachineScaleSetSku[], PageSettings>参数
- resourceGroupName
-
string
资源组的名称。
- vmScaleSetName
-
string
VM 规模集的名称。
选项参数。