VirtualMachines interface
Interface representing a VirtualMachines.
Methods
Method Details
beginRedeploy(string, string, string, VirtualMachinesRedeployOptionalParams)
Action to redeploy a lab virtual machine to a different compute node. For troubleshooting connectivity.
function beginRedeploy(resourceGroupName: string, labName: string, virtualMachineName: string, options?: VirtualMachinesRedeployOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- labName
-
string
The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
- virtualMachineName
-
string
The ID of the virtual machine that uniquely identifies it within the containing lab. Used in resource URIs.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginRedeployAndWait(string, string, string, VirtualMachinesRedeployOptionalParams)
Action to redeploy a lab virtual machine to a different compute node. For troubleshooting connectivity.
function beginRedeployAndWait(resourceGroupName: string, labName: string, virtualMachineName: string, options?: VirtualMachinesRedeployOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- labName
-
string
The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
- virtualMachineName
-
string
The ID of the virtual machine that uniquely identifies it within the containing lab. Used in resource URIs.
The options parameters.
Returns
Promise<void>
beginReimage(string, string, string, VirtualMachinesReimageOptionalParams)
Re-image a lab virtual machine. The virtual machine will be deleted and recreated using the latest published snapshot of the reference environment of the lab.
function beginReimage(resourceGroupName: string, labName: string, virtualMachineName: string, options?: VirtualMachinesReimageOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- labName
-
string
The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
- virtualMachineName
-
string
The ID of the virtual machine that uniquely identifies it within the containing lab. Used in resource URIs.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginReimageAndWait(string, string, string, VirtualMachinesReimageOptionalParams)
Re-image a lab virtual machine. The virtual machine will be deleted and recreated using the latest published snapshot of the reference environment of the lab.
function beginReimageAndWait(resourceGroupName: string, labName: string, virtualMachineName: string, options?: VirtualMachinesReimageOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- labName
-
string
The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
- virtualMachineName
-
string
The ID of the virtual machine that uniquely identifies it within the containing lab. Used in resource URIs.
The options parameters.
Returns
Promise<void>
beginResetPassword(string, string, string, ResetPasswordBody, VirtualMachinesResetPasswordOptionalParams)
Resets a lab virtual machine password.
function beginResetPassword(resourceGroupName: string, labName: string, virtualMachineName: string, body: ResetPasswordBody, options?: VirtualMachinesResetPasswordOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- labName
-
string
The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
- virtualMachineName
-
string
The ID of the virtual machine that uniquely identifies it within the containing lab. Used in resource URIs.
- body
- ResetPasswordBody
The request body.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginResetPasswordAndWait(string, string, string, ResetPasswordBody, VirtualMachinesResetPasswordOptionalParams)
Resets a lab virtual machine password.
function beginResetPasswordAndWait(resourceGroupName: string, labName: string, virtualMachineName: string, body: ResetPasswordBody, options?: VirtualMachinesResetPasswordOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- labName
-
string
The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
- virtualMachineName
-
string
The ID of the virtual machine that uniquely identifies it within the containing lab. Used in resource URIs.
- body
- ResetPasswordBody
The request body.
The options parameters.
Returns
Promise<void>
beginStart(string, string, string, VirtualMachinesStartOptionalParams)
Action to start a lab virtual machine.
function beginStart(resourceGroupName: string, labName: string, virtualMachineName: string, options?: VirtualMachinesStartOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- labName
-
string
The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
- virtualMachineName
-
string
The ID of the virtual machine that uniquely identifies it within the containing lab. Used in resource URIs.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginStartAndWait(string, string, string, VirtualMachinesStartOptionalParams)
Action to start a lab virtual machine.
function beginStartAndWait(resourceGroupName: string, labName: string, virtualMachineName: string, options?: VirtualMachinesStartOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- labName
-
string
The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
- virtualMachineName
-
string
The ID of the virtual machine that uniquely identifies it within the containing lab. Used in resource URIs.
The options parameters.
Returns
Promise<void>
beginStop(string, string, string, VirtualMachinesStopOptionalParams)
Action to stop a lab virtual machine.
function beginStop(resourceGroupName: string, labName: string, virtualMachineName: string, options?: VirtualMachinesStopOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- labName
-
string
The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
- virtualMachineName
-
string
The ID of the virtual machine that uniquely identifies it within the containing lab. Used in resource URIs.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginStopAndWait(string, string, string, VirtualMachinesStopOptionalParams)
Action to stop a lab virtual machine.
function beginStopAndWait(resourceGroupName: string, labName: string, virtualMachineName: string, options?: VirtualMachinesStopOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- labName
-
string
The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
- virtualMachineName
-
string
The ID of the virtual machine that uniquely identifies it within the containing lab. Used in resource URIs.
The options parameters.
Returns
Promise<void>
get(string, string, string, VirtualMachinesGetOptionalParams)
Returns the properties for a lab virtual machine.
function get(resourceGroupName: string, labName: string, virtualMachineName: string, options?: VirtualMachinesGetOptionalParams): Promise<VirtualMachine>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- labName
-
string
The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
- virtualMachineName
-
string
The ID of the virtual machine that uniquely identifies it within the containing lab. Used in resource URIs.
- options
- VirtualMachinesGetOptionalParams
The options parameters.
Returns
Promise<VirtualMachine>
listByLab(string, string, VirtualMachinesListByLabOptionalParams)
Returns a list of all virtual machines for a lab.
function listByLab(resourceGroupName: string, labName: string, options?: VirtualMachinesListByLabOptionalParams): PagedAsyncIterableIterator<VirtualMachine, VirtualMachine[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- labName
-
string
The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
The options parameters.