你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
VirtualMachines interface
表示 VirtualMachines 的接口。
方法
方法详细信息
beginAddDataDisk(string, string, string, DataDiskProperties, VirtualMachinesAddDataDiskOptionalParams)
将新的或现有的数据磁盘附加到虚拟机。 此作可能需要一段时间才能完成。
function beginAddDataDisk(resourceGroupName: string, labName: string, name: string, dataDiskProperties: DataDiskProperties, options?: VirtualMachinesAddDataDiskOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。
- labName
-
string
实验室的名称。
- name
-
string
虚拟机的名称。
- dataDiskProperties
- DataDiskProperties
向虚拟机添加新或现有数据磁盘的请求正文。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginAddDataDiskAndWait(string, string, string, DataDiskProperties, VirtualMachinesAddDataDiskOptionalParams)
将新的或现有的数据磁盘附加到虚拟机。 此作可能需要一段时间才能完成。
function beginAddDataDiskAndWait(resourceGroupName: string, labName: string, name: string, dataDiskProperties: DataDiskProperties, options?: VirtualMachinesAddDataDiskOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。
- labName
-
string
实验室的名称。
- name
-
string
虚拟机的名称。
- dataDiskProperties
- DataDiskProperties
向虚拟机添加新或现有数据磁盘的请求正文。
选项参数。
返回
Promise<void>
beginApplyArtifacts(string, string, string, ApplyArtifactsRequest, VirtualMachinesApplyArtifactsOptionalParams)
将项目应用于虚拟机。 此作可能需要一段时间才能完成。
function beginApplyArtifacts(resourceGroupName: string, labName: string, name: string, applyArtifactsRequest: ApplyArtifactsRequest, options?: VirtualMachinesApplyArtifactsOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。
- labName
-
string
实验室的名称。
- name
-
string
虚拟机的名称。
- applyArtifactsRequest
- ApplyArtifactsRequest
将项目应用到虚拟机的请求正文。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginApplyArtifactsAndWait(string, string, string, ApplyArtifactsRequest, VirtualMachinesApplyArtifactsOptionalParams)
将项目应用于虚拟机。 此作可能需要一段时间才能完成。
function beginApplyArtifactsAndWait(resourceGroupName: string, labName: string, name: string, applyArtifactsRequest: ApplyArtifactsRequest, options?: VirtualMachinesApplyArtifactsOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。
- labName
-
string
实验室的名称。
- name
-
string
虚拟机的名称。
- applyArtifactsRequest
- ApplyArtifactsRequest
将项目应用到虚拟机的请求正文。
选项参数。
返回
Promise<void>
beginClaim(string, string, string, VirtualMachinesClaimOptionalParams)
获取现有虚拟机的所有权。此作可能需要一段时间才能完成。
function beginClaim(resourceGroupName: string, labName: string, name: string, options?: VirtualMachinesClaimOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。
- labName
-
string
实验室的名称。
- name
-
string
虚拟机的名称。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginClaimAndWait(string, string, string, VirtualMachinesClaimOptionalParams)
获取现有虚拟机的所有权。此作可能需要一段时间才能完成。
function beginClaimAndWait(resourceGroupName: string, labName: string, name: string, options?: VirtualMachinesClaimOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。
- labName
-
string
实验室的名称。
- name
-
string
虚拟机的名称。
选项参数。
返回
Promise<void>
beginCreateOrUpdate(string, string, string, LabVirtualMachine, VirtualMachinesCreateOrUpdateOptionalParams)
创建或替换现有虚拟机。 此作可能需要一段时间才能完成。
function beginCreateOrUpdate(resourceGroupName: string, labName: string, name: string, labVirtualMachine: LabVirtualMachine, options?: VirtualMachinesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<LabVirtualMachine>, LabVirtualMachine>>参数
- resourceGroupName
-
string
资源组的名称。
- labName
-
string
实验室的名称。
- name
-
string
虚拟机的名称。
- labVirtualMachine
- LabVirtualMachine
虚拟机。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<LabVirtualMachine>, LabVirtualMachine>>
beginCreateOrUpdateAndWait(string, string, string, LabVirtualMachine, VirtualMachinesCreateOrUpdateOptionalParams)
创建或替换现有虚拟机。 此作可能需要一段时间才能完成。
function beginCreateOrUpdateAndWait(resourceGroupName: string, labName: string, name: string, labVirtualMachine: LabVirtualMachine, options?: VirtualMachinesCreateOrUpdateOptionalParams): Promise<LabVirtualMachine>参数
- resourceGroupName
-
string
资源组的名称。
- labName
-
string
实验室的名称。
- name
-
string
虚拟机的名称。
- labVirtualMachine
- LabVirtualMachine
虚拟机。
选项参数。
返回
Promise<LabVirtualMachine>
beginDelete(string, string, string, VirtualMachinesDeleteOptionalParams)
删除虚拟机。 此作可能需要一段时间才能完成。
function beginDelete(resourceGroupName: string, labName: string, name: string, options?: VirtualMachinesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。
- labName
-
string
实验室的名称。
- name
-
string
虚拟机的名称。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeleteAndWait(string, string, string, VirtualMachinesDeleteOptionalParams)
删除虚拟机。 此作可能需要一段时间才能完成。
function beginDeleteAndWait(resourceGroupName: string, labName: string, name: string, options?: VirtualMachinesDeleteOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。
- labName
-
string
实验室的名称。
- name
-
string
虚拟机的名称。
选项参数。
返回
Promise<void>
beginDetachDataDisk(string, string, string, DetachDataDiskProperties, VirtualMachinesDetachDataDiskOptionalParams)
从虚拟机中分离指定的磁盘。 此作可能需要一段时间才能完成。
function beginDetachDataDisk(resourceGroupName: string, labName: string, name: string, detachDataDiskProperties: DetachDataDiskProperties, options?: VirtualMachinesDetachDataDiskOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。
- labName
-
string
实验室的名称。
- name
-
string
虚拟机的名称。
- detachDataDiskProperties
- DetachDataDiskProperties
用于从虚拟机分离数据磁盘的请求正文。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDetachDataDiskAndWait(string, string, string, DetachDataDiskProperties, VirtualMachinesDetachDataDiskOptionalParams)
从虚拟机中分离指定的磁盘。 此作可能需要一段时间才能完成。
function beginDetachDataDiskAndWait(resourceGroupName: string, labName: string, name: string, detachDataDiskProperties: DetachDataDiskProperties, options?: VirtualMachinesDetachDataDiskOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。
- labName
-
string
实验室的名称。
- name
-
string
虚拟机的名称。
- detachDataDiskProperties
- DetachDataDiskProperties
用于从虚拟机分离数据磁盘的请求正文。
选项参数。
返回
Promise<void>
beginRedeploy(string, string, string, VirtualMachinesRedeployOptionalParams)
重新部署虚拟机此作可能需要一段时间才能完成。
function beginRedeploy(resourceGroupName: string, labName: string, name: string, options?: VirtualMachinesRedeployOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。
- labName
-
string
实验室的名称。
- name
-
string
虚拟机的名称。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginRedeployAndWait(string, string, string, VirtualMachinesRedeployOptionalParams)
重新部署虚拟机此作可能需要一段时间才能完成。
function beginRedeployAndWait(resourceGroupName: string, labName: string, name: string, options?: VirtualMachinesRedeployOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。
- labName
-
string
实验室的名称。
- name
-
string
虚拟机的名称。
选项参数。
返回
Promise<void>
beginResize(string, string, string, ResizeLabVirtualMachineProperties, VirtualMachinesResizeOptionalParams)
调整虚拟机大小。 此作可能需要一段时间才能完成。
function beginResize(resourceGroupName: string, labName: string, name: string, resizeLabVirtualMachineProperties: ResizeLabVirtualMachineProperties, options?: VirtualMachinesResizeOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。
- labName
-
string
实验室的名称。
- name
-
string
虚拟机的名称。
- resizeLabVirtualMachineProperties
- ResizeLabVirtualMachineProperties
重设虚拟机大小的请求正文。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginResizeAndWait(string, string, string, ResizeLabVirtualMachineProperties, VirtualMachinesResizeOptionalParams)
调整虚拟机大小。 此作可能需要一段时间才能完成。
function beginResizeAndWait(resourceGroupName: string, labName: string, name: string, resizeLabVirtualMachineProperties: ResizeLabVirtualMachineProperties, options?: VirtualMachinesResizeOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。
- labName
-
string
实验室的名称。
- name
-
string
虚拟机的名称。
- resizeLabVirtualMachineProperties
- ResizeLabVirtualMachineProperties
重设虚拟机大小的请求正文。
选项参数。
返回
Promise<void>
beginRestart(string, string, string, VirtualMachinesRestartOptionalParams)
重启虚拟机。 此作可能需要一段时间才能完成。
function beginRestart(resourceGroupName: string, labName: string, name: string, options?: VirtualMachinesRestartOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。
- labName
-
string
实验室的名称。
- name
-
string
虚拟机的名称。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginRestartAndWait(string, string, string, VirtualMachinesRestartOptionalParams)
重启虚拟机。 此作可能需要一段时间才能完成。
function beginRestartAndWait(resourceGroupName: string, labName: string, name: string, options?: VirtualMachinesRestartOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。
- labName
-
string
实验室的名称。
- name
-
string
虚拟机的名称。
选项参数。
返回
Promise<void>
beginStart(string, string, string, VirtualMachinesStartOptionalParams)
启动虚拟机。 此作可能需要一段时间才能完成。
function beginStart(resourceGroupName: string, labName: string, name: string, options?: VirtualMachinesStartOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。
- labName
-
string
实验室的名称。
- name
-
string
虚拟机的名称。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginStartAndWait(string, string, string, VirtualMachinesStartOptionalParams)
启动虚拟机。 此作可能需要一段时间才能完成。
function beginStartAndWait(resourceGroupName: string, labName: string, name: string, options?: VirtualMachinesStartOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。
- labName
-
string
实验室的名称。
- name
-
string
虚拟机的名称。
选项参数。
返回
Promise<void>
beginStop(string, string, string, VirtualMachinesStopOptionalParams)
停止虚拟机此作可能需要一段时间才能完成。
function beginStop(resourceGroupName: string, labName: string, name: string, options?: VirtualMachinesStopOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。
- labName
-
string
实验室的名称。
- name
-
string
虚拟机的名称。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginStopAndWait(string, string, string, VirtualMachinesStopOptionalParams)
停止虚拟机此作可能需要一段时间才能完成。
function beginStopAndWait(resourceGroupName: string, labName: string, name: string, options?: VirtualMachinesStopOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。
- labName
-
string
实验室的名称。
- name
-
string
虚拟机的名称。
选项参数。
返回
Promise<void>
beginTransferDisks(string, string, string, VirtualMachinesTransferDisksOptionalParams)
传输附加到虚拟机的所有数据磁盘，以由当前用户拥有。 此作可能需要一段时间才能完成。
function beginTransferDisks(resourceGroupName: string, labName: string, name: string, options?: VirtualMachinesTransferDisksOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。
- labName
-
string
实验室的名称。
- name
-
string
虚拟机的名称。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginTransferDisksAndWait(string, string, string, VirtualMachinesTransferDisksOptionalParams)
传输附加到虚拟机的所有数据磁盘，以由当前用户拥有。 此作可能需要一段时间才能完成。
function beginTransferDisksAndWait(resourceGroupName: string, labName: string, name: string, options?: VirtualMachinesTransferDisksOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。
- labName
-
string
实验室的名称。
- name
-
string
虚拟机的名称。
选项参数。
返回
Promise<void>
beginUnClaim(string, string, string, VirtualMachinesUnClaimOptionalParams)
释放现有虚拟机的所有权此作可能需要一段时间才能完成。
function beginUnClaim(resourceGroupName: string, labName: string, name: string, options?: VirtualMachinesUnClaimOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。
- labName
-
string
实验室的名称。
- name
-
string
虚拟机的名称。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginUnClaimAndWait(string, string, string, VirtualMachinesUnClaimOptionalParams)
释放现有虚拟机的所有权此作可能需要一段时间才能完成。
function beginUnClaimAndWait(resourceGroupName: string, labName: string, name: string, options?: VirtualMachinesUnClaimOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。
- labName
-
string
实验室的名称。
- name
-
string
虚拟机的名称。
选项参数。
返回
Promise<void>
get(string, string, string, VirtualMachinesGetOptionalParams)
获取虚拟机。
function get(resourceGroupName: string, labName: string, name: string, options?: VirtualMachinesGetOptionalParams): Promise<LabVirtualMachine>参数
- resourceGroupName
-
string
资源组的名称。
- labName
-
string
实验室的名称。
- name
-
string
虚拟机的名称。
- options
- VirtualMachinesGetOptionalParams
选项参数。
返回
Promise<LabVirtualMachine>
getRdpFileContents(string, string, string, VirtualMachinesGetRdpFileContentsOptionalParams)
获取一个字符串，表示虚拟机的 RDP 文件的内容
function getRdpFileContents(resourceGroupName: string, labName: string, name: string, options?: VirtualMachinesGetRdpFileContentsOptionalParams): Promise<RdpConnection>参数
- resourceGroupName
-
string
资源组的名称。
- labName
-
string
实验室的名称。
- name
-
string
虚拟机的名称。
选项参数。
返回
Promise<RdpConnection>
list(string, string, VirtualMachinesListOptionalParams)
列出给定实验室中的虚拟机。
function list(resourceGroupName: string, labName: string, options?: VirtualMachinesListOptionalParams): PagedAsyncIterableIterator<LabVirtualMachine, LabVirtualMachine[], PageSettings>参数
- resourceGroupName
-
string
资源组的名称。
- labName
-
string
实验室的名称。
选项参数。
返回
listApplicableSchedules(string, string, string, VirtualMachinesListApplicableSchedulesOptionalParams)
列出适用的启动/停止计划（如果有）。
function listApplicableSchedules(resourceGroupName: string, labName: string, name: string, options?: VirtualMachinesListApplicableSchedulesOptionalParams): Promise<ApplicableSchedule>参数
- resourceGroupName
-
string
资源组的名称。
- labName
-
string
实验室的名称。
- name
-
string
虚拟机的名称。
选项参数。
返回
Promise<ApplicableSchedule>
update(string, string, string, LabVirtualMachineFragment, VirtualMachinesUpdateOptionalParams)
允许修改虚拟机的标记。 将忽略所有其他属性。
function update(resourceGroupName: string, labName: string, name: string, labVirtualMachine: LabVirtualMachineFragment, options?: VirtualMachinesUpdateOptionalParams): Promise<LabVirtualMachine>参数
- resourceGroupName
-
string
资源组的名称。
- labName
-
string
实验室的名称。
- name
-
string
虚拟机的名称。
- labVirtualMachine
- LabVirtualMachineFragment
虚拟机。
选项参数。
返回
Promise<LabVirtualMachine>