你当前正在访问 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<SimplePollerLike<OperationState<VirtualMachineAssessPatchesResult>, VirtualMachineAssessPatchesResult>>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualMachineAssessPatchesResult>, VirtualMachineAssessPatchesResult>>
beginAssessPatchesAndWait(string, string, VirtualMachinesAssessPatchesOptionalParams)
评估 VM 上的修补程序。
function beginAssessPatchesAndWait(resourceGroupName: string, vmName: string, options?: VirtualMachinesAssessPatchesOptionalParams): Promise<VirtualMachineAssessPatchesResult>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
选项参数。
返回
Promise<VirtualMachineAssessPatchesResult>
beginAttachDetachDataDisks(string, string, AttachDetachDataDisksRequest, VirtualMachinesAttachDetachDataDisksOptionalParams)
在虚拟机中附加和分离数据磁盘。
function beginAttachDetachDataDisks(resourceGroupName: string, vmName: string, parameters: AttachDetachDataDisksRequest, options?: VirtualMachinesAttachDetachDataDisksOptionalParams): Promise<SimplePollerLike<OperationState<StorageProfile>, StorageProfile>>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
- parameters
- AttachDetachDataDisksRequest
提供给虚拟机上的附加和分离数据磁盘操作的参数。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<StorageProfile>, StorageProfile>>
beginAttachDetachDataDisksAndWait(string, string, AttachDetachDataDisksRequest, VirtualMachinesAttachDetachDataDisksOptionalParams)
在虚拟机中附加和分离数据磁盘。
function beginAttachDetachDataDisksAndWait(resourceGroupName: string, vmName: string, parameters: AttachDetachDataDisksRequest, options?: VirtualMachinesAttachDetachDataDisksOptionalParams): Promise<StorageProfile>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
- parameters
- AttachDetachDataDisksRequest
提供给虚拟机上的附加和分离数据磁盘操作的参数。
选项参数。
返回
Promise<StorageProfile>
beginCapture(string, string, VirtualMachineCaptureParameters, VirtualMachinesCaptureOptionalParams)
通过复制 VM 的虚拟硬盘来捕获 VM，并输出可用于创建类似 VM 的模板。
function beginCapture(resourceGroupName: string, vmName: string, parameters: VirtualMachineCaptureParameters, options?: VirtualMachinesCaptureOptionalParams): Promise<SimplePollerLike<OperationState<VirtualMachineCaptureResult>, VirtualMachineCaptureResult>>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
- parameters
- VirtualMachineCaptureParameters
提供给捕获虚拟机操作的参数。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<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<SimplePollerLike<OperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<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<SimplePollerLike<OperationState<VirtualMachine>, VirtualMachine>>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
- parameters
- VirtualMachine
提供给“创建虚拟机”操作的参数。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<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<SimplePollerLike<OperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<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<SimplePollerLike<OperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, VirtualMachinesDeleteOptionalParams)
用于删除虚拟机的操作。
function beginDeleteAndWait(resourceGroupName: string, vmName: string, options?: VirtualMachinesDeleteOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
选项参数。
返回
Promise<void>
beginInstallPatches(string, string, VirtualMachineInstallPatchesParameters, VirtualMachinesInstallPatchesOptionalParams)
在 VM 上安装修补程序。
function beginInstallPatches(resourceGroupName: string, vmName: string, installPatchesInput: VirtualMachineInstallPatchesParameters, options?: VirtualMachinesInstallPatchesOptionalParams): Promise<SimplePollerLike<OperationState<VirtualMachineInstallPatchesResult>, VirtualMachineInstallPatchesResult>>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
- installPatchesInput
- VirtualMachineInstallPatchesParameters
API 直接接收的 InstallPatches 的输入
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualMachineInstallPatchesResult>, VirtualMachineInstallPatchesResult>>
beginInstallPatchesAndWait(string, string, VirtualMachineInstallPatchesParameters, VirtualMachinesInstallPatchesOptionalParams)
在 VM 上安装修补程序。
function beginInstallPatchesAndWait(resourceGroupName: string, vmName: string, installPatchesInput: VirtualMachineInstallPatchesParameters, options?: VirtualMachinesInstallPatchesOptionalParams): Promise<VirtualMachineInstallPatchesResult>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
- installPatchesInput
- VirtualMachineInstallPatchesParameters
API 直接接收的 InstallPatches 的输入
选项参数。
返回
Promise<VirtualMachineInstallPatchesResult>
beginPerformMaintenance(string, string, VirtualMachinesPerformMaintenanceOptionalParams)
在虚拟机上执行维护的操作。
function beginPerformMaintenance(resourceGroupName: string, vmName: string, options?: VirtualMachinesPerformMaintenanceOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<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<SimplePollerLike<OperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<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<SimplePollerLike<OperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<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<SimplePollerLike<OperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<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 磁盘的虚拟机，重置虚拟机重置为初始状态（升级操作系统）。 注意：保留旧 OS 磁盘取决于 OS 磁盘 deleteOption 的值。 如果 deleteOption 是分离的，则会在重置映像后保留旧的 OS 磁盘。 如果 deleteOption 被删除，则会在重置映像后删除旧的 OS 磁盘。 在执行重置映像之前，应相应地更新 OS 磁盘的 deleteOption。
function beginReimage(resourceGroupName: string, vmName: string, options?: VirtualMachinesReimageOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginReimageAndWait(string, string, VirtualMachinesReimageOptionalParams)
对于具有临时 OS 磁盘的虚拟机，重置虚拟机重置为初始状态（升级操作系统）。 注意：保留旧 OS 磁盘取决于 OS 磁盘 deleteOption 的值。 如果 deleteOption 是分离的，则会在重置映像后保留旧的 OS 磁盘。 如果 deleteOption 被删除，则会在重置映像后删除旧的 OS 磁盘。 在执行重置映像之前，应相应地更新 OS 磁盘的 deleteOption。
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<SimplePollerLike<OperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginRestartAndWait(string, string, VirtualMachinesRestartOptionalParams)
重启虚拟机的操作。
function beginRestartAndWait(resourceGroupName: string, vmName: string, options?: VirtualMachinesRestartOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
选项参数。
返回
Promise<void>
beginRunCommand(string, string, RunCommandInput, VirtualMachinesRunCommandOptionalParams)
在 VM 上运行命令。
function beginRunCommand(resourceGroupName: string, vmName: string, parameters: RunCommandInput, options?: VirtualMachinesRunCommandOptionalParams): Promise<SimplePollerLike<OperationState<RunCommandResult>, RunCommandResult>>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
- parameters
- RunCommandInput
提供给 Run 命令操作的参数。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<RunCommandResult>, RunCommandResult>>
beginRunCommandAndWait(string, string, RunCommandInput, VirtualMachinesRunCommandOptionalParams)
在 VM 上运行命令。
function beginRunCommandAndWait(resourceGroupName: string, vmName: string, parameters: RunCommandInput, options?: VirtualMachinesRunCommandOptionalParams): Promise<RunCommandResult>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
- parameters
- RunCommandInput
提供给 Run 命令操作的参数。
选项参数。
返回
Promise<RunCommandResult>
beginStart(string, string, VirtualMachinesStartOptionalParams)
启动虚拟机的操作。
function beginStart(resourceGroupName: string, vmName: string, options?: VirtualMachinesStartOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<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<SimplePollerLike<OperationState<VirtualMachine>, VirtualMachine>>参数
- resourceGroupName
-
string
资源组的名称。
- vmName
-
string
虚拟机的名称。
- parameters
- VirtualMachineUpdate
提供给更新虚拟机操作的参数。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<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>