你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
VirtualMachines interface
表示 VirtualMachines 的接口。
方法
方法详细信息
beginAssessPatches(string, string, VirtualMachinesAssessPatchesOptionalParams)
评估 VM 上的修补程序。
function beginAssessPatches(resourceGroupName: string, vmName: string, options?: VirtualMachinesAssessPatchesOptionalParams): Promise<PollerLike<PollOperationState<VirtualMachineAssessPatchesResult>, VirtualMachineAssessPatchesResult>>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<VirtualMachineAssessPatchesResult>, VirtualMachineAssessPatchesResult>>
beginAssessPatchesAndWait(string, string, VirtualMachinesAssessPatchesOptionalParams)
评估 VM 上的修补程序。
function beginAssessPatchesAndWait(resourceGroupName: string, vmName: string, options?: VirtualMachinesAssessPatchesOptionalParams): Promise<VirtualMachineAssessPatchesResult>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
选项参数。
返回
Promise<VirtualMachineAssessPatchesResult>
beginCapture(string, string, VirtualMachineCaptureParameters, VirtualMachinesCaptureOptionalParams)
通过复制 VM 的虚拟硬盘捕获 VM，并输出可用于创建类似 VM 的模板。
function beginCapture(resourceGroupName: string, vmName: string, parameters: VirtualMachineCaptureParameters, options?: VirtualMachinesCaptureOptionalParams): Promise<PollerLike<PollOperationState<VirtualMachineCaptureResult>, VirtualMachineCaptureResult>>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
- parameters
- VirtualMachineCaptureParameters
提供给捕获虚拟机操作的参数。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<VirtualMachineCaptureResult>, VirtualMachineCaptureResult>>
beginCaptureAndWait(string, string, VirtualMachineCaptureParameters, VirtualMachinesCaptureOptionalParams)
通过复制 VM 的虚拟硬盘捕获 VM，并输出可用于创建类似 VM 的模板。
function beginCaptureAndWait(resourceGroupName: string, vmName: string, parameters: VirtualMachineCaptureParameters, options?: VirtualMachinesCaptureOptionalParams): Promise<VirtualMachineCaptureResult>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
- parameters
- VirtualMachineCaptureParameters
提供给捕获虚拟机操作的参数。
选项参数。
返回
Promise<VirtualMachineCaptureResult>
beginConvertToManagedDisks(string, string, VirtualMachinesConvertToManagedDisksOptionalParams)
将虚拟机磁盘从基于 Blob 的磁盘转换为托管磁盘。 在调用此操作之前，必须停止解除分配虚拟机。
function beginConvertToManagedDisks(resourceGroupName: string, vmName: string, options?: VirtualMachinesConvertToManagedDisksOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginConvertToManagedDisksAndWait(string, string, VirtualMachinesConvertToManagedDisksOptionalParams)
将虚拟机磁盘从基于 Blob 的磁盘转换为托管磁盘。 在调用此操作之前，必须停止解除分配虚拟机。
function beginConvertToManagedDisksAndWait(resourceGroupName: string, vmName: string, options?: VirtualMachinesConvertToManagedDisksOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
选项参数。
返回
Promise<void>
beginCreateOrUpdate(string, string, VirtualMachine, VirtualMachinesCreateOrUpdateOptionalParams)
创建或更新虚拟机的操作。 请注意，某些属性只能在创建虚拟机期间设置。
function beginCreateOrUpdate(resourceGroupName: string, vmName: string, parameters: VirtualMachine, options?: VirtualMachinesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<VirtualMachine>, VirtualMachine>>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
- parameters
- VirtualMachine
提供给“创建虚拟机”操作的参数。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<VirtualMachine>, VirtualMachine>>
beginCreateOrUpdateAndWait(string, string, VirtualMachine, VirtualMachinesCreateOrUpdateOptionalParams)
创建或更新虚拟机的操作。 请注意，某些属性只能在创建虚拟机期间设置。
function beginCreateOrUpdateAndWait(resourceGroupName: string, vmName: string, parameters: VirtualMachine, options?: VirtualMachinesCreateOrUpdateOptionalParams): Promise<VirtualMachine>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
- parameters
- VirtualMachine
提供给“创建虚拟机”操作的参数。
选项参数。
返回
Promise<VirtualMachine>
beginDeallocate(string, string, VirtualMachinesDeallocateOptionalParams)
关闭虚拟机并释放计算资源。 无需为此虚拟机使用的计算资源付费。
function beginDeallocate(resourceGroupName: string, vmName: string, options?: VirtualMachinesDeallocateOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeallocateAndWait(string, string, VirtualMachinesDeallocateOptionalParams)
关闭虚拟机并释放计算资源。 无需为此虚拟机使用的计算资源付费。
function beginDeallocateAndWait(resourceGroupName: string, vmName: string, options?: VirtualMachinesDeallocateOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
选项参数。
返回
Promise<void>
beginDelete(string, string, VirtualMachinesDeleteOptionalParams)
删除虚拟机的操作。
function beginDelete(resourceGroupName: string, vmName: string, options?: VirtualMachinesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeleteAndWait(string, string, VirtualMachinesDeleteOptionalParams)
删除虚拟机的操作。
function beginDeleteAndWait(resourceGroupName: string, vmName: string, options?: VirtualMachinesDeleteOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
选项参数。
返回
Promise<void>
beginPerformMaintenance(string, string, VirtualMachinesPerformMaintenanceOptionalParams)
在虚拟机上执行维护的操作。
function beginPerformMaintenance(resourceGroupName: string, vmName: string, options?: VirtualMachinesPerformMaintenanceOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginPerformMaintenanceAndWait(string, string, VirtualMachinesPerformMaintenanceOptionalParams)
在虚拟机上执行维护的操作。
function beginPerformMaintenanceAndWait(resourceGroupName: string, vmName: string, options?: VirtualMachinesPerformMaintenanceOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
选项参数。
返回
Promise<void>
beginPowerOff(string, string, VirtualMachinesPowerOffOptionalParams)
关闭电源的操作 (停止) 虚拟机。 可以使用相同的预配资源重启虚拟机。 仍需要为此虚拟机付费。
function beginPowerOff(resourceGroupName: string, vmName: string, options?: VirtualMachinesPowerOffOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginPowerOffAndWait(string, string, VirtualMachinesPowerOffOptionalParams)
关闭电源的操作 (停止) 虚拟机。 可以使用相同的预配资源重启虚拟机。 仍需要为此虚拟机付费。
function beginPowerOffAndWait(resourceGroupName: string, vmName: string, options?: VirtualMachinesPowerOffOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
选项参数。
返回
Promise<void>
beginReapply(string, string, VirtualMachinesReapplyOptionalParams)
重新应用虚拟机状态的操作。
function beginReapply(resourceGroupName: string, vmName: string, options?: VirtualMachinesReapplyOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginReapplyAndWait(string, string, VirtualMachinesReapplyOptionalParams)
重新应用虚拟机状态的操作。
function beginReapplyAndWait(resourceGroupName: string, vmName: string, options?: VirtualMachinesReapplyOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
选项参数。
返回
Promise<void>
beginRedeploy(string, string, VirtualMachinesRedeployOptionalParams)
关闭虚拟机，将其移动到新节点，并重新打开它。
function beginRedeploy(resourceGroupName: string, vmName: string, options?: VirtualMachinesRedeployOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginRedeployAndWait(string, string, VirtualMachinesRedeployOptionalParams)
关闭虚拟机，将其移动到新节点，并重新打开它。
function beginRedeployAndWait(resourceGroupName: string, vmName: string, options?: VirtualMachinesRedeployOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
选项参数。
返回
Promise<void>
beginReimage(string, string, VirtualMachinesReimageOptionalParams)
将具有临时 OS 磁盘的虚拟机重置为初始状态。
function beginReimage(resourceGroupName: string, vmName: string, options?: VirtualMachinesReimageOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginReimageAndWait(string, string, VirtualMachinesReimageOptionalParams)
将具有临时 OS 磁盘的虚拟机重置为初始状态。
function beginReimageAndWait(resourceGroupName: string, vmName: string, options?: VirtualMachinesReimageOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
选项参数。
返回
Promise<void>
beginRestart(string, string, VirtualMachinesRestartOptionalParams)
重启虚拟机的操作。
function beginRestart(resourceGroupName: string, vmName: string, options?: VirtualMachinesRestartOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginRestartAndWait(string, string, VirtualMachinesRestartOptionalParams)
重启虚拟机的操作。
function beginRestartAndWait(resourceGroupName: string, vmName: string, options?: VirtualMachinesRestartOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
选项参数。
返回
Promise<void>
beginStart(string, string, VirtualMachinesStartOptionalParams)
用于启动虚拟机的操作。
function beginStart(resourceGroupName: string, vmName: string, options?: VirtualMachinesStartOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginStartAndWait(string, string, VirtualMachinesStartOptionalParams)
用于启动虚拟机的操作。
function beginStartAndWait(resourceGroupName: string, vmName: string, options?: VirtualMachinesStartOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
选项参数。
返回
Promise<void>
beginUpdate(string, string, VirtualMachineUpdate, VirtualMachinesUpdateOptionalParams)
用于更新虚拟机的操作。
function beginUpdate(resourceGroupName: string, vmName: string, parameters: VirtualMachineUpdate, options?: VirtualMachinesUpdateOptionalParams): Promise<PollerLike<PollOperationState<VirtualMachine>, VirtualMachine>>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
- parameters
- VirtualMachineUpdate
提供给更新虚拟机操作的参数。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<VirtualMachine>, VirtualMachine>>
beginUpdateAndWait(string, string, VirtualMachineUpdate, VirtualMachinesUpdateOptionalParams)
用于更新虚拟机的操作。
function beginUpdateAndWait(resourceGroupName: string, vmName: string, parameters: VirtualMachineUpdate, options?: VirtualMachinesUpdateOptionalParams): Promise<VirtualMachine>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
- parameters
- VirtualMachineUpdate
提供给更新虚拟机操作的参数。
选项参数。
返回
Promise<VirtualMachine>
generalize(string, string, VirtualMachinesGeneralizeOptionalParams)
将虚拟机的 OS 状态设置为通用化。 建议在执行此操作之前对虚拟机进行 sysprep。
对于 Windows，请参阅 在 Azure 中创建通用化 VM 的托管映像。
对于 Linux，请参阅 如何创建虚拟机或 VHD 的映像。
function generalize(resourceGroupName: string, vmName: string, options?: VirtualMachinesGeneralizeOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
选项参数。
返回
Promise<void>
get(string, string, VirtualMachinesGetOptionalParams)
检索虚拟机的模型视图或实例视图的相关信息。
function get(resourceGroupName: string, vmName: string, options?: VirtualMachinesGetOptionalParams): Promise<VirtualMachine>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
- options
- VirtualMachinesGetOptionalParams
选项参数。
返回
Promise<VirtualMachine>
instanceView(string, string, VirtualMachinesInstanceViewOptionalParams)
检索有关虚拟机的运行时状态的信息。
function instanceView(resourceGroupName: string, vmName: string, options?: VirtualMachinesInstanceViewOptionalParams): Promise<VirtualMachineInstanceView>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
选项参数。
返回
Promise<VirtualMachineInstanceView>
list(string, VirtualMachinesListOptionalParams)
列出指定资源组中的所有虚拟机。 在响应中使用 nextLink 属性获取虚拟机的下一页。
function list(resourceGroupName: string, options?: VirtualMachinesListOptionalParams): PagedAsyncIterableIterator<VirtualMachine, VirtualMachine[], PageSettings>参数
- resourceGroupName
-
string
资源组的名称。
选项参数。
返回
listAll(VirtualMachinesListAllOptionalParams)
列出指定订阅中的所有虚拟机。 在响应中使用 nextLink 属性获取虚拟机的下一页。
function listAll(options?: VirtualMachinesListAllOptionalParams): PagedAsyncIterableIterator<VirtualMachine, VirtualMachine[], PageSettings>参数
选项参数。
返回
listAvailableSizes(string, string, VirtualMachinesListAvailableSizesOptionalParams)
列出可以调整指定虚拟机大小的所有可用虚拟机大小。
function listAvailableSizes(resourceGroupName: string, vmName: string, options?: VirtualMachinesListAvailableSizesOptionalParams): PagedAsyncIterableIterator<VirtualMachineSize, VirtualMachineSize[], PageSettings>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
选项参数。
返回
listByLocation(string, VirtualMachinesListByLocationOptionalParams)
获取指定位置的指定订阅下的所有虚拟机。
function listByLocation(location: string, options?: VirtualMachinesListByLocationOptionalParams): PagedAsyncIterableIterator<VirtualMachine, VirtualMachine[], PageSettings>参数
- location
-
string
查询订阅下虚拟机的位置。
选项参数。
返回
retrieveBootDiagnosticsData(string, string, VirtualMachinesRetrieveBootDiagnosticsDataOptionalParams)
用于检索虚拟机启动诊断日志的 SAS URI 的操作。
function retrieveBootDiagnosticsData(resourceGroupName: string, vmName: string, options?: VirtualMachinesRetrieveBootDiagnosticsDataOptionalParams): Promise<RetrieveBootDiagnosticsDataResult>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
选项参数。
返回
Promise<RetrieveBootDiagnosticsDataResult>
simulateEviction(string, string, VirtualMachinesSimulateEvictionOptionalParams)
用于模拟逐出现成虚拟机的操作。
function simulateEviction(resourceGroupName: string, vmName: string, options?: VirtualMachinesSimulateEvictionOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
选项参数。
返回
Promise<void>