VirtualMachines interface
Interface representing a VirtualMachines.
Methods
Method Details
beginAddDataDisk(string, string, string, DataDiskProperties, VirtualMachinesAddDataDiskOptionalParams)
Attach a new or existing data disk to virtual machine. This operation can take a while to complete.
function beginAddDataDisk(resourceGroupName: string, labName: string, name: string, dataDiskProperties: DataDiskProperties, options?: VirtualMachinesAddDataDiskOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- name
-
string
The name of the virtual machine.
- dataDiskProperties
- DataDiskProperties
Request body for adding a new or existing data disk to a virtual machine.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginAddDataDiskAndWait(string, string, string, DataDiskProperties, VirtualMachinesAddDataDiskOptionalParams)
Attach a new or existing data disk to virtual machine. This operation can take a while to complete.
function beginAddDataDiskAndWait(resourceGroupName: string, labName: string, name: string, dataDiskProperties: DataDiskProperties, options?: VirtualMachinesAddDataDiskOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- name
-
string
The name of the virtual machine.
- dataDiskProperties
- DataDiskProperties
Request body for adding a new or existing data disk to a virtual machine.
The options parameters.
Returns
Promise<void>
beginApplyArtifacts(string, string, string, ApplyArtifactsRequest, VirtualMachinesApplyArtifactsOptionalParams)
Apply artifacts to virtual machine. This operation can take a while to complete.
function beginApplyArtifacts(resourceGroupName: string, labName: string, name: string, applyArtifactsRequest: ApplyArtifactsRequest, options?: VirtualMachinesApplyArtifactsOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- name
-
string
The name of the virtual machine.
- applyArtifactsRequest
- ApplyArtifactsRequest
Request body for applying artifacts to a virtual machine.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginApplyArtifactsAndWait(string, string, string, ApplyArtifactsRequest, VirtualMachinesApplyArtifactsOptionalParams)
Apply artifacts to virtual machine. This operation can take a while to complete.
function beginApplyArtifactsAndWait(resourceGroupName: string, labName: string, name: string, applyArtifactsRequest: ApplyArtifactsRequest, options?: VirtualMachinesApplyArtifactsOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- name
-
string
The name of the virtual machine.
- applyArtifactsRequest
- ApplyArtifactsRequest
Request body for applying artifacts to a virtual machine.
The options parameters.
Returns
Promise<void>
beginClaim(string, string, string, VirtualMachinesClaimOptionalParams)
Take ownership of an existing virtual machine This operation can take a while to complete.
function beginClaim(resourceGroupName: string, labName: string, name: string, options?: VirtualMachinesClaimOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- name
-
string
The name of the virtual machine.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginClaimAndWait(string, string, string, VirtualMachinesClaimOptionalParams)
Take ownership of an existing virtual machine This operation can take a while to complete.
function beginClaimAndWait(resourceGroupName: string, labName: string, name: string, options?: VirtualMachinesClaimOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- name
-
string
The name of the virtual machine.
The options parameters.
Returns
Promise<void>
beginCreateOrUpdate(string, string, string, LabVirtualMachine, VirtualMachinesCreateOrUpdateOptionalParams)
Create or replace an existing virtual machine. This operation can take a while to complete.
function beginCreateOrUpdate(resourceGroupName: string, labName: string, name: string, labVirtualMachine: LabVirtualMachine, options?: VirtualMachinesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<LabVirtualMachine>, LabVirtualMachine>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- name
-
string
The name of the virtual machine.
- labVirtualMachine
- LabVirtualMachine
A virtual machine.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<LabVirtualMachine>, LabVirtualMachine>>
beginCreateOrUpdateAndWait(string, string, string, LabVirtualMachine, VirtualMachinesCreateOrUpdateOptionalParams)
Create or replace an existing virtual machine. This operation can take a while to complete.
function beginCreateOrUpdateAndWait(resourceGroupName: string, labName: string, name: string, labVirtualMachine: LabVirtualMachine, options?: VirtualMachinesCreateOrUpdateOptionalParams): Promise<LabVirtualMachine>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- name
-
string
The name of the virtual machine.
- labVirtualMachine
- LabVirtualMachine
A virtual machine.
The options parameters.
Returns
Promise<LabVirtualMachine>
beginDelete(string, string, string, VirtualMachinesDeleteOptionalParams)
Delete virtual machine. This operation can take a while to complete.
function beginDelete(resourceGroupName: string, labName: string, name: string, options?: VirtualMachinesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- name
-
string
The name of the virtual machine.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeleteAndWait(string, string, string, VirtualMachinesDeleteOptionalParams)
Delete virtual machine. This operation can take a while to complete.
function beginDeleteAndWait(resourceGroupName: string, labName: string, name: string, options?: VirtualMachinesDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- name
-
string
The name of the virtual machine.
The options parameters.
Returns
Promise<void>
beginDetachDataDisk(string, string, string, DetachDataDiskProperties, VirtualMachinesDetachDataDiskOptionalParams)
Detach the specified disk from the virtual machine. This operation can take a while to complete.
function beginDetachDataDisk(resourceGroupName: string, labName: string, name: string, detachDataDiskProperties: DetachDataDiskProperties, options?: VirtualMachinesDetachDataDiskOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- name
-
string
The name of the virtual machine.
- detachDataDiskProperties
- DetachDataDiskProperties
Request body for detaching data disk from a virtual machine.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDetachDataDiskAndWait(string, string, string, DetachDataDiskProperties, VirtualMachinesDetachDataDiskOptionalParams)
Detach the specified disk from the virtual machine. This operation can take a while to complete.
function beginDetachDataDiskAndWait(resourceGroupName: string, labName: string, name: string, detachDataDiskProperties: DetachDataDiskProperties, options?: VirtualMachinesDetachDataDiskOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- name
-
string
The name of the virtual machine.
- detachDataDiskProperties
- DetachDataDiskProperties
Request body for detaching data disk from a virtual machine.
The options parameters.
Returns
Promise<void>
beginRedeploy(string, string, string, VirtualMachinesRedeployOptionalParams)
Redeploy a virtual machine This operation can take a while to complete.
function beginRedeploy(resourceGroupName: string, labName: string, name: string, options?: VirtualMachinesRedeployOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- name
-
string
The name of the virtual machine.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginRedeployAndWait(string, string, string, VirtualMachinesRedeployOptionalParams)
Redeploy a virtual machine This operation can take a while to complete.
function beginRedeployAndWait(resourceGroupName: string, labName: string, name: string, options?: VirtualMachinesRedeployOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- name
-
string
The name of the virtual machine.
The options parameters.
Returns
Promise<void>
beginResize(string, string, string, ResizeLabVirtualMachineProperties, VirtualMachinesResizeOptionalParams)
Resize Virtual Machine. This operation can take a while to complete.
function beginResize(resourceGroupName: string, labName: string, name: string, resizeLabVirtualMachineProperties: ResizeLabVirtualMachineProperties, options?: VirtualMachinesResizeOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- name
-
string
The name of the virtual machine.
- resizeLabVirtualMachineProperties
- ResizeLabVirtualMachineProperties
Request body for resizing a virtual machine.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginResizeAndWait(string, string, string, ResizeLabVirtualMachineProperties, VirtualMachinesResizeOptionalParams)
Resize Virtual Machine. This operation can take a while to complete.
function beginResizeAndWait(resourceGroupName: string, labName: string, name: string, resizeLabVirtualMachineProperties: ResizeLabVirtualMachineProperties, options?: VirtualMachinesResizeOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- name
-
string
The name of the virtual machine.
- resizeLabVirtualMachineProperties
- ResizeLabVirtualMachineProperties
Request body for resizing a virtual machine.
The options parameters.
Returns
Promise<void>
beginRestart(string, string, string, VirtualMachinesRestartOptionalParams)
Restart a virtual machine. This operation can take a while to complete.
function beginRestart(resourceGroupName: string, labName: string, name: string, options?: VirtualMachinesRestartOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- name
-
string
The name of the virtual machine.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginRestartAndWait(string, string, string, VirtualMachinesRestartOptionalParams)
Restart a virtual machine. This operation can take a while to complete.
function beginRestartAndWait(resourceGroupName: string, labName: string, name: string, options?: VirtualMachinesRestartOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- name
-
string
The name of the virtual machine.
The options parameters.
Returns
Promise<void>
beginStart(string, string, string, VirtualMachinesStartOptionalParams)
Start a virtual machine. This operation can take a while to complete.
function beginStart(resourceGroupName: string, labName: string, name: string, options?: VirtualMachinesStartOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- name
-
string
The name of the virtual machine.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginStartAndWait(string, string, string, VirtualMachinesStartOptionalParams)
Start a virtual machine. This operation can take a while to complete.
function beginStartAndWait(resourceGroupName: string, labName: string, name: string, options?: VirtualMachinesStartOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- name
-
string
The name of the virtual machine.
The options parameters.
Returns
Promise<void>
beginStop(string, string, string, VirtualMachinesStopOptionalParams)
Stop a virtual machine This operation can take a while to complete.
function beginStop(resourceGroupName: string, labName: string, name: string, options?: VirtualMachinesStopOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- name
-
string
The name of the virtual machine.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginStopAndWait(string, string, string, VirtualMachinesStopOptionalParams)
Stop a virtual machine This operation can take a while to complete.
function beginStopAndWait(resourceGroupName: string, labName: string, name: string, options?: VirtualMachinesStopOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- name
-
string
The name of the virtual machine.
The options parameters.
Returns
Promise<void>
beginTransferDisks(string, string, string, VirtualMachinesTransferDisksOptionalParams)
Transfers all data disks attached to the virtual machine to be owned by the current user. This operation can take a while to complete.
function beginTransferDisks(resourceGroupName: string, labName: string, name: string, options?: VirtualMachinesTransferDisksOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- name
-
string
The name of the virtual machine.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginTransferDisksAndWait(string, string, string, VirtualMachinesTransferDisksOptionalParams)
Transfers all data disks attached to the virtual machine to be owned by the current user. This operation can take a while to complete.
function beginTransferDisksAndWait(resourceGroupName: string, labName: string, name: string, options?: VirtualMachinesTransferDisksOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- name
-
string
The name of the virtual machine.
The options parameters.
Returns
Promise<void>
beginUnClaim(string, string, string, VirtualMachinesUnClaimOptionalParams)
Release ownership of an existing virtual machine This operation can take a while to complete.
function beginUnClaim(resourceGroupName: string, labName: string, name: string, options?: VirtualMachinesUnClaimOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- name
-
string
The name of the virtual machine.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginUnClaimAndWait(string, string, string, VirtualMachinesUnClaimOptionalParams)
Release ownership of an existing virtual machine This operation can take a while to complete.
function beginUnClaimAndWait(resourceGroupName: string, labName: string, name: string, options?: VirtualMachinesUnClaimOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- name
-
string
The name of the virtual machine.
The options parameters.
Returns
Promise<void>
get(string, string, string, VirtualMachinesGetOptionalParams)
Get virtual machine.
function get(resourceGroupName: string, labName: string, name: string, options?: VirtualMachinesGetOptionalParams): Promise<LabVirtualMachine>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- name
-
string
The name of the virtual machine.
- options
- VirtualMachinesGetOptionalParams
The options parameters.
Returns
Promise<LabVirtualMachine>
getRdpFileContents(string, string, string, VirtualMachinesGetRdpFileContentsOptionalParams)
Gets a string that represents the contents of the RDP file for the virtual machine
function getRdpFileContents(resourceGroupName: string, labName: string, name: string, options?: VirtualMachinesGetRdpFileContentsOptionalParams): Promise<RdpConnection>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- name
-
string
The name of the virtual machine.
The options parameters.
Returns
Promise<RdpConnection>
list(string, string, VirtualMachinesListOptionalParams)
List virtual machines in a given lab.
function list(resourceGroupName: string, labName: string, options?: VirtualMachinesListOptionalParams): PagedAsyncIterableIterator<LabVirtualMachine, LabVirtualMachine[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
The options parameters.
Returns
listApplicableSchedules(string, string, string, VirtualMachinesListApplicableSchedulesOptionalParams)
Lists the applicable start/stop schedules, if any.
function listApplicableSchedules(resourceGroupName: string, labName: string, name: string, options?: VirtualMachinesListApplicableSchedulesOptionalParams): Promise<ApplicableSchedule>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- name
-
string
The name of the virtual machine.
The options parameters.
Returns
Promise<ApplicableSchedule>
update(string, string, string, LabVirtualMachineFragment, VirtualMachinesUpdateOptionalParams)
Allows modifying tags of virtual machines. All other properties will be ignored.
function update(resourceGroupName: string, labName: string, name: string, labVirtualMachine: LabVirtualMachineFragment, options?: VirtualMachinesUpdateOptionalParams): Promise<LabVirtualMachine>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- name
-
string
The name of the virtual machine.
- labVirtualMachine
- LabVirtualMachineFragment
A virtual machine.
The options parameters.
Returns
Promise<LabVirtualMachine>