VirtualMachines interface

Methods

beginCapture(string, string, VirtualMachineCaptureParameters, Object)

Captures the VM by copying virtual hard disks of the VM and outputs a template that can be used to create similar VMs.

beginCapture(string, string, VirtualMachineCaptureParameters, Object, ServiceCallback<VirtualMachineCaptureResult>)

Captures the VM by copying virtual hard disks of the VM and outputs a template that can be used to create similar VMs.

beginCapture(string, string, VirtualMachineCaptureParameters, ServiceCallback<VirtualMachineCaptureResult>)

Captures the VM by copying virtual hard disks of the VM and outputs a template that can be used to create similar VMs.

beginCaptureWithHttpOperationResponse(string, string, VirtualMachineCaptureParameters, Object)

Captures the VM by copying virtual hard disks of the VM and outputs a template that can be used to create similar VMs.

beginConvertToManagedDisks(string, string, Object)

Converts virtual machine disks from blob-based to managed disks. Virtual machine must be stop-deallocated before invoking this operation.

beginConvertToManagedDisks(string, string, Object, ServiceCallback<void>)

Converts virtual machine disks from blob-based to managed disks. Virtual machine must be stop-deallocated before invoking this operation.

beginConvertToManagedDisks(string, string, ServiceCallback<void>)

Converts virtual machine disks from blob-based to managed disks. Virtual machine must be stop-deallocated before invoking this operation.

beginConvertToManagedDisksWithHttpOperationResponse(string, string, Object)

Converts virtual machine disks from blob-based to managed disks. Virtual machine must be stop-deallocated before invoking this operation.

beginCreateOrUpdate(string, string, VirtualMachine, Object)

The operation to create or update a virtual machine.

beginCreateOrUpdate(string, string, VirtualMachine, Object, ServiceCallback<VirtualMachine>)

The operation to create or update a virtual machine.

beginCreateOrUpdate(string, string, VirtualMachine, ServiceCallback<VirtualMachine>)

The operation to create or update a virtual machine.

beginCreateOrUpdateWithHttpOperationResponse(string, string, VirtualMachine, Object)

The operation to create or update a virtual machine.

beginDeallocate(string, string, Object)

Shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses.

beginDeallocate(string, string, Object, ServiceCallback<void>)

Shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses.

beginDeallocate(string, string, ServiceCallback<void>)

Shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses.

beginDeallocateWithHttpOperationResponse(string, string, Object)

Shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses.

beginDeleteMethod(string, string, Object)

The operation to delete a virtual machine.

beginDeleteMethod(string, string, Object, ServiceCallback<void>)

The operation to delete a virtual machine.

beginDeleteMethod(string, string, ServiceCallback<void>)

The operation to delete a virtual machine.

beginDeleteMethodWithHttpOperationResponse(string, string, Object)

The operation to delete a virtual machine.

beginPerformMaintenance(string, string, Object)

The operation to perform maintenance on a virtual machine.

beginPerformMaintenance(string, string, Object, ServiceCallback<void>)

The operation to perform maintenance on a virtual machine.

beginPerformMaintenance(string, string, ServiceCallback<void>)

The operation to perform maintenance on a virtual machine.

beginPerformMaintenanceWithHttpOperationResponse(string, string, Object)

The operation to perform maintenance on a virtual machine.

beginPowerOff(string, string, Object)

The operation to power off (stop) a virtual machine. The virtual machine can be restarted with the same provisioned resources. You are still charged for this virtual machine.

beginPowerOff(string, string, Object, ServiceCallback<void>)

The operation to power off (stop) a virtual machine. The virtual machine can be restarted with the same provisioned resources. You are still charged for this virtual machine.

beginPowerOff(string, string, ServiceCallback<void>)

The operation to power off (stop) a virtual machine. The virtual machine can be restarted with the same provisioned resources. You are still charged for this virtual machine.

beginPowerOffWithHttpOperationResponse(string, string, Object)

The operation to power off (stop) a virtual machine. The virtual machine can be restarted with the same provisioned resources. You are still charged for this virtual machine.

beginRedeploy(string, string, Object)

The operation to redeploy a virtual machine.

beginRedeploy(string, string, Object, ServiceCallback<void>)

The operation to redeploy a virtual machine.

beginRedeploy(string, string, ServiceCallback<void>)

The operation to redeploy a virtual machine.

beginRedeployWithHttpOperationResponse(string, string, Object)

The operation to redeploy a virtual machine.

beginReimage(string, string, Object)

Reimages the virtual machine which has an ephemeral OS disk back to its initial state.

beginReimage(string, string, Object, ServiceCallback<void>)

Reimages the virtual machine which has an ephemeral OS disk back to its initial state.

beginReimage(string, string, ServiceCallback<void>)

Reimages the virtual machine which has an ephemeral OS disk back to its initial state.

beginReimageWithHttpOperationResponse(string, string, Object)

Reimages the virtual machine which has an ephemeral OS disk back to its initial state.

beginRestart(string, string, Object)

The operation to restart a virtual machine.

beginRestart(string, string, Object, ServiceCallback<void>)

The operation to restart a virtual machine.

beginRestart(string, string, ServiceCallback<void>)

The operation to restart a virtual machine.

beginRestartWithHttpOperationResponse(string, string, Object)

The operation to restart a virtual machine.

beginRunCommand(string, string, RunCommandInput, Object)

Run command on the VM.

beginRunCommand(string, string, RunCommandInput, Object, ServiceCallback<RunCommandResult>)

Run command on the VM.

beginRunCommand(string, string, RunCommandInput, ServiceCallback<RunCommandResult>)

Run command on the VM.

beginRunCommandWithHttpOperationResponse(string, string, RunCommandInput, Object)

Run command on the VM.

beginStart(string, string, Object)

The operation to start a virtual machine.

beginStart(string, string, Object, ServiceCallback<void>)

The operation to start a virtual machine.

beginStart(string, string, ServiceCallback<void>)

The operation to start a virtual machine.

beginStartWithHttpOperationResponse(string, string, Object)

The operation to start a virtual machine.

beginUpdate(string, string, VirtualMachineUpdate, Object)

The operation to update a virtual machine.

beginUpdate(string, string, VirtualMachineUpdate, Object, ServiceCallback<VirtualMachine>)

The operation to update a virtual machine.

beginUpdate(string, string, VirtualMachineUpdate, ServiceCallback<VirtualMachine>)

The operation to update a virtual machine.

beginUpdateWithHttpOperationResponse(string, string, VirtualMachineUpdate, Object)

The operation to update a virtual machine.

capture(string, string, VirtualMachineCaptureParameters, Object)

Captures the VM by copying virtual hard disks of the VM and outputs a template that can be used to create similar VMs.

capture(string, string, VirtualMachineCaptureParameters, Object, ServiceCallback<VirtualMachineCaptureResult>)

Captures the VM by copying virtual hard disks of the VM and outputs a template that can be used to create similar VMs.

capture(string, string, VirtualMachineCaptureParameters, ServiceCallback<VirtualMachineCaptureResult>)

Captures the VM by copying virtual hard disks of the VM and outputs a template that can be used to create similar VMs.

captureWithHttpOperationResponse(string, string, VirtualMachineCaptureParameters, Object)

Captures the VM by copying virtual hard disks of the VM and outputs a template that can be used to create similar VMs.

convertToManagedDisks(string, string, Object)

Converts virtual machine disks from blob-based to managed disks. Virtual machine must be stop-deallocated before invoking this operation.

convertToManagedDisks(string, string, Object, ServiceCallback<void>)

Converts virtual machine disks from blob-based to managed disks. Virtual machine must be stop-deallocated before invoking this operation.

convertToManagedDisks(string, string, ServiceCallback<void>)

Converts virtual machine disks from blob-based to managed disks. Virtual machine must be stop-deallocated before invoking this operation.

convertToManagedDisksWithHttpOperationResponse(string, string, Object)

Converts virtual machine disks from blob-based to managed disks. Virtual machine must be stop-deallocated before invoking this operation.

createOrUpdate(string, string, VirtualMachine, Object)

The operation to create or update a virtual machine.

createOrUpdate(string, string, VirtualMachine, Object, ServiceCallback<VirtualMachine>)

The operation to create or update a virtual machine.

createOrUpdate(string, string, VirtualMachine, ServiceCallback<VirtualMachine>)

The operation to create or update a virtual machine.

createOrUpdateWithHttpOperationResponse(string, string, VirtualMachine, Object)

The operation to create or update a virtual machine.

deallocate(string, string, Object)

Shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses.

deallocate(string, string, Object, ServiceCallback<void>)

Shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses.

deallocate(string, string, ServiceCallback<void>)

Shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses.

deallocateWithHttpOperationResponse(string, string, Object)

Shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses.

deleteMethod(string, string, Object)

The operation to delete a virtual machine.

deleteMethod(string, string, Object, ServiceCallback<void>)

The operation to delete a virtual machine.

deleteMethod(string, string, ServiceCallback<void>)

The operation to delete a virtual machine.

deleteMethodWithHttpOperationResponse(string, string, Object)

The operation to delete a virtual machine.

generalize(string, string, Object)

Sets the state of the virtual machine to generalized.

generalize(string, string, Object, ServiceCallback<void>)

Sets the state of the virtual machine to generalized.

generalize(string, string, ServiceCallback<void>)

Sets the state of the virtual machine to generalized.

generalizeWithHttpOperationResponse(string, string, Object)

Sets the state of the virtual machine to generalized.

get(string, string, Object)

Retrieves information about the model view or the instance view of a virtual machine.

get(string, string, Object, ServiceCallback<VirtualMachine>)

Retrieves information about the model view or the instance view of a virtual machine.

get(string, string, ServiceCallback<VirtualMachine>)

Retrieves information about the model view or the instance view of a virtual machine.

getWithHttpOperationResponse(string, string, Object)

Retrieves information about the model view or the instance view of a virtual machine.

instanceView(string, string, Object)

Retrieves information about the run-time state of a virtual machine.

instanceView(string, string, Object, ServiceCallback<VirtualMachineInstanceView>)

Retrieves information about the run-time state of a virtual machine.

instanceView(string, string, ServiceCallback<VirtualMachineInstanceView>)

Retrieves information about the run-time state of a virtual machine.

instanceViewWithHttpOperationResponse(string, string, Object)

Retrieves information about the run-time state of a virtual machine.

list(string, Object)

Lists all of the virtual machines in the specified resource group. Use the nextLink property in the response to get the next page of virtual machines.

list(string, Object, ServiceCallback<VirtualMachineListResult>)

Lists all of the virtual machines in the specified resource group. Use the nextLink property in the response to get the next page of virtual machines.

list(string, ServiceCallback<VirtualMachineListResult>)

Lists all of the virtual machines in the specified resource group. Use the nextLink property in the response to get the next page of virtual machines.

listAll(Object)

Lists all of the virtual machines in the specified subscription. Use the nextLink property in the response to get the next page of virtual machines.

listAll(Object, ServiceCallback<VirtualMachineListResult>)

Lists all of the virtual machines in the specified subscription. Use the nextLink property in the response to get the next page of virtual machines.

listAll(ServiceCallback<VirtualMachineListResult>)

Lists all of the virtual machines in the specified subscription. Use the nextLink property in the response to get the next page of virtual machines.

listAllNext(string, Object)

Lists all of the virtual machines in the specified subscription. Use the nextLink property in the response to get the next page of virtual machines.

listAllNext(string, Object, ServiceCallback<VirtualMachineListResult>)

Lists all of the virtual machines in the specified subscription. Use the nextLink property in the response to get the next page of virtual machines.

listAllNext(string, ServiceCallback<VirtualMachineListResult>)

Lists all of the virtual machines in the specified subscription. Use the nextLink property in the response to get the next page of virtual machines.

listAllNextWithHttpOperationResponse(string, Object)

Lists all of the virtual machines in the specified subscription. Use the nextLink property in the response to get the next page of virtual machines.

listAllWithHttpOperationResponse(Object)

Lists all of the virtual machines in the specified subscription. Use the nextLink property in the response to get the next page of virtual machines.

listAvailableSizes(string, string, Object)

Lists all available virtual machine sizes to which the specified virtual machine can be resized.

listAvailableSizes(string, string, Object, ServiceCallback<VirtualMachineSizeListResult>)

Lists all available virtual machine sizes to which the specified virtual machine can be resized.

listAvailableSizes(string, string, ServiceCallback<VirtualMachineSizeListResult>)

Lists all available virtual machine sizes to which the specified virtual machine can be resized.

listAvailableSizesWithHttpOperationResponse(string, string, Object)

Lists all available virtual machine sizes to which the specified virtual machine can be resized.

listByLocation(string, Object)

Gets all the virtual machines under the specified subscription for the specified location.

listByLocation(string, Object, ServiceCallback<VirtualMachineListResult>)

Gets all the virtual machines under the specified subscription for the specified location.

listByLocation(string, ServiceCallback<VirtualMachineListResult>)

Gets all the virtual machines under the specified subscription for the specified location.

listByLocationNext(string, Object)

Gets all the virtual machines under the specified subscription for the specified location.

listByLocationNext(string, Object, ServiceCallback<VirtualMachineListResult>)

Gets all the virtual machines under the specified subscription for the specified location.

listByLocationNext(string, ServiceCallback<VirtualMachineListResult>)

Gets all the virtual machines under the specified subscription for the specified location.

listByLocationNextWithHttpOperationResponse(string, Object)

Gets all the virtual machines under the specified subscription for the specified location.

listByLocationWithHttpOperationResponse(string, Object)

Gets all the virtual machines under the specified subscription for the specified location.

listNext(string, Object)

Lists all of the virtual machines in the specified resource group. Use the nextLink property in the response to get the next page of virtual machines.

listNext(string, Object, ServiceCallback<VirtualMachineListResult>)

Lists all of the virtual machines in the specified resource group. Use the nextLink property in the response to get the next page of virtual machines.

listNext(string, ServiceCallback<VirtualMachineListResult>)

Lists all of the virtual machines in the specified resource group. Use the nextLink property in the response to get the next page of virtual machines.

listNextWithHttpOperationResponse(string, Object)

Lists all of the virtual machines in the specified resource group. Use the nextLink property in the response to get the next page of virtual machines.

listWithHttpOperationResponse(string, Object)

Lists all of the virtual machines in the specified resource group. Use the nextLink property in the response to get the next page of virtual machines.

performMaintenance(string, string, Object)

The operation to perform maintenance on a virtual machine.

performMaintenance(string, string, Object, ServiceCallback<void>)

The operation to perform maintenance on a virtual machine.

performMaintenance(string, string, ServiceCallback<void>)

The operation to perform maintenance on a virtual machine.

performMaintenanceWithHttpOperationResponse(string, string, Object)

The operation to perform maintenance on a virtual machine.

powerOff(string, string, Object)

The operation to power off (stop) a virtual machine. The virtual machine can be restarted with the same provisioned resources. You are still charged for this virtual machine.

powerOff(string, string, Object, ServiceCallback<void>)

The operation to power off (stop) a virtual machine. The virtual machine can be restarted with the same provisioned resources. You are still charged for this virtual machine.

powerOff(string, string, ServiceCallback<void>)

The operation to power off (stop) a virtual machine. The virtual machine can be restarted with the same provisioned resources. You are still charged for this virtual machine.

powerOffWithHttpOperationResponse(string, string, Object)

The operation to power off (stop) a virtual machine. The virtual machine can be restarted with the same provisioned resources. You are still charged for this virtual machine.

redeploy(string, string, Object)

The operation to redeploy a virtual machine.

redeploy(string, string, Object, ServiceCallback<void>)

The operation to redeploy a virtual machine.

redeploy(string, string, ServiceCallback<void>)

The operation to redeploy a virtual machine.

redeployWithHttpOperationResponse(string, string, Object)

The operation to redeploy a virtual machine.

reimage(string, string, Object)

Reimages the virtual machine which has an ephemeral OS disk back to its initial state.

reimage(string, string, Object, ServiceCallback<void>)

Reimages the virtual machine which has an ephemeral OS disk back to its initial state.

reimage(string, string, ServiceCallback<void>)

Reimages the virtual machine which has an ephemeral OS disk back to its initial state.

reimageWithHttpOperationResponse(string, string, Object)

Reimages the virtual machine which has an ephemeral OS disk back to its initial state.

restart(string, string, Object)

The operation to restart a virtual machine.

restart(string, string, Object, ServiceCallback<void>)

The operation to restart a virtual machine.

restart(string, string, ServiceCallback<void>)

The operation to restart a virtual machine.

restartWithHttpOperationResponse(string, string, Object)

The operation to restart a virtual machine.

runCommand(string, string, RunCommandInput, Object)

Run command on the VM.

runCommand(string, string, RunCommandInput, Object, ServiceCallback<RunCommandResult>)

Run command on the VM.

runCommand(string, string, RunCommandInput, ServiceCallback<RunCommandResult>)

Run command on the VM.

runCommandWithHttpOperationResponse(string, string, RunCommandInput, Object)

Run command on the VM.

start(string, string, Object)

The operation to start a virtual machine.

start(string, string, Object, ServiceCallback<void>)

The operation to start a virtual machine.

start(string, string, ServiceCallback<void>)

The operation to start a virtual machine.

startWithHttpOperationResponse(string, string, Object)

The operation to start a virtual machine.

update(string, string, VirtualMachineUpdate, Object)

The operation to update a virtual machine.

update(string, string, VirtualMachineUpdate, Object, ServiceCallback<VirtualMachine>)

The operation to update a virtual machine.

update(string, string, VirtualMachineUpdate, ServiceCallback<VirtualMachine>)

The operation to update a virtual machine.

updateWithHttpOperationResponse(string, string, VirtualMachineUpdate, Object)

The operation to update a virtual machine.

Method Details

beginCapture(string, string, VirtualMachineCaptureParameters, Object)

Captures the VM by copying virtual hard disks of the VM and outputs a template that can be used to create similar VMs.

function beginCapture(resourceGroupName: string, vmName: string, parameters: VirtualMachineCaptureParameters, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

parameters
VirtualMachineCaptureParameters

Parameters supplied to the Capture Virtual Machine operation.

options
Object

Returns

beginCapture(string, string, VirtualMachineCaptureParameters, Object, ServiceCallback<VirtualMachineCaptureResult>)

Captures the VM by copying virtual hard disks of the VM and outputs a template that can be used to create similar VMs.

function beginCapture(resourceGroupName: string, vmName: string, parameters: VirtualMachineCaptureParameters, options: Object, callback: ServiceCallback<VirtualMachineCaptureResult>)

Parameters

resourceGroupName
string
vmName
string
options
Object
callback
ServiceCallback<VirtualMachineCaptureResult>

Returns

beginCapture(string, string, VirtualMachineCaptureParameters, ServiceCallback<VirtualMachineCaptureResult>)

Captures the VM by copying virtual hard disks of the VM and outputs a template that can be used to create similar VMs.

function beginCapture(resourceGroupName: string, vmName: string, parameters: VirtualMachineCaptureParameters, callback: ServiceCallback<VirtualMachineCaptureResult>)

Parameters

resourceGroupName
string
vmName
string
callback
ServiceCallback<VirtualMachineCaptureResult>

Returns

beginCaptureWithHttpOperationResponse(string, string, VirtualMachineCaptureParameters, Object)

Captures the VM by copying virtual hard disks of the VM and outputs a template that can be used to create similar VMs.

function beginCaptureWithHttpOperationResponse(resourceGroupName: string, vmName: string, parameters: VirtualMachineCaptureParameters, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

parameters
VirtualMachineCaptureParameters

Parameters supplied to the Capture Virtual Machine operation.

options
Object

Returns

Promise<HttpOperationResponse<VirtualMachineCaptureResult>>

beginConvertToManagedDisks(string, string, Object)

Converts virtual machine disks from blob-based to managed disks. Virtual machine must be stop-deallocated before invoking this operation.

function beginConvertToManagedDisks(resourceGroupName: string, vmName: string, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

options
Object

Returns

Promise<void>

beginConvertToManagedDisks(string, string, Object, ServiceCallback<void>)

Converts virtual machine disks from blob-based to managed disks. Virtual machine must be stop-deallocated before invoking this operation.

function beginConvertToManagedDisks(resourceGroupName: string, vmName: string, options: Object, callback: ServiceCallback<void>)

Parameters

resourceGroupName
string
vmName
string
options
Object
callback
ServiceCallback<void>

Returns

Promise<void>

beginConvertToManagedDisks(string, string, ServiceCallback<void>)

Converts virtual machine disks from blob-based to managed disks. Virtual machine must be stop-deallocated before invoking this operation.

function beginConvertToManagedDisks(resourceGroupName: string, vmName: string, callback: ServiceCallback<void>)

Parameters

resourceGroupName
string
vmName
string
callback
ServiceCallback<void>

Returns

Promise<void>

beginConvertToManagedDisksWithHttpOperationResponse(string, string, Object)

Converts virtual machine disks from blob-based to managed disks. Virtual machine must be stop-deallocated before invoking this operation.

function beginConvertToManagedDisksWithHttpOperationResponse(resourceGroupName: string, vmName: string, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

options
Object

Returns

Promise<HttpOperationResponse<void>>

beginCreateOrUpdate(string, string, VirtualMachine, Object)

The operation to create or update a virtual machine.

function beginCreateOrUpdate(resourceGroupName: string, vmName: string, parameters: VirtualMachine, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

parameters
VirtualMachine

Parameters supplied to the Create Virtual Machine operation.

options
Object

Returns

Promise<VirtualMachine>

beginCreateOrUpdate(string, string, VirtualMachine, Object, ServiceCallback<VirtualMachine>)

The operation to create or update a virtual machine.

function beginCreateOrUpdate(resourceGroupName: string, vmName: string, parameters: VirtualMachine, options: Object, callback: ServiceCallback<VirtualMachine>)

Parameters

resourceGroupName
string
vmName
string
parameters
VirtualMachine
options
Object
callback
ServiceCallback<VirtualMachine>

Returns

Promise<VirtualMachine>

beginCreateOrUpdate(string, string, VirtualMachine, ServiceCallback<VirtualMachine>)

The operation to create or update a virtual machine.

function beginCreateOrUpdate(resourceGroupName: string, vmName: string, parameters: VirtualMachine, callback: ServiceCallback<VirtualMachine>)

Parameters

resourceGroupName
string
vmName
string
parameters
VirtualMachine
callback
ServiceCallback<VirtualMachine>

Returns

Promise<VirtualMachine>

beginCreateOrUpdateWithHttpOperationResponse(string, string, VirtualMachine, Object)

The operation to create or update a virtual machine.

function beginCreateOrUpdateWithHttpOperationResponse(resourceGroupName: string, vmName: string, parameters: VirtualMachine, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

parameters
VirtualMachine

Parameters supplied to the Create Virtual Machine operation.

options
Object

Returns

Promise<HttpOperationResponse<VirtualMachine>>

beginDeallocate(string, string, Object)

Shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses.

function beginDeallocate(resourceGroupName: string, vmName: string, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

options
Object

Returns

Promise<void>

beginDeallocate(string, string, Object, ServiceCallback<void>)

Shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses.

function beginDeallocate(resourceGroupName: string, vmName: string, options: Object, callback: ServiceCallback<void>)

Parameters

resourceGroupName
string
vmName
string
options
Object
callback
ServiceCallback<void>

Returns

Promise<void>

beginDeallocate(string, string, ServiceCallback<void>)

Shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses.

function beginDeallocate(resourceGroupName: string, vmName: string, callback: ServiceCallback<void>)

Parameters

resourceGroupName
string
vmName
string
callback
ServiceCallback<void>

Returns

Promise<void>

beginDeallocateWithHttpOperationResponse(string, string, Object)

Shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses.

function beginDeallocateWithHttpOperationResponse(resourceGroupName: string, vmName: string, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

options
Object

Returns

Promise<HttpOperationResponse<void>>

beginDeleteMethod(string, string, Object)

The operation to delete a virtual machine.

function beginDeleteMethod(resourceGroupName: string, vmName: string, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

options
Object

Returns

Promise<void>

beginDeleteMethod(string, string, Object, ServiceCallback<void>)

The operation to delete a virtual machine.

function beginDeleteMethod(resourceGroupName: string, vmName: string, options: Object, callback: ServiceCallback<void>)

Parameters

resourceGroupName
string
vmName
string
options
Object
callback
ServiceCallback<void>

Returns

Promise<void>

beginDeleteMethod(string, string, ServiceCallback<void>)

The operation to delete a virtual machine.

function beginDeleteMethod(resourceGroupName: string, vmName: string, callback: ServiceCallback<void>)

Parameters

resourceGroupName
string
vmName
string
callback
ServiceCallback<void>

Returns

Promise<void>

beginDeleteMethodWithHttpOperationResponse(string, string, Object)

The operation to delete a virtual machine.

function beginDeleteMethodWithHttpOperationResponse(resourceGroupName: string, vmName: string, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

options
Object

Returns

Promise<HttpOperationResponse<void>>

beginPerformMaintenance(string, string, Object)

The operation to perform maintenance on a virtual machine.

function beginPerformMaintenance(resourceGroupName: string, vmName: string, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

options
Object

Returns

Promise<void>

beginPerformMaintenance(string, string, Object, ServiceCallback<void>)

The operation to perform maintenance on a virtual machine.

function beginPerformMaintenance(resourceGroupName: string, vmName: string, options: Object, callback: ServiceCallback<void>)

Parameters

resourceGroupName
string
vmName
string
options
Object
callback
ServiceCallback<void>

Returns

Promise<void>

beginPerformMaintenance(string, string, ServiceCallback<void>)

The operation to perform maintenance on a virtual machine.

function beginPerformMaintenance(resourceGroupName: string, vmName: string, callback: ServiceCallback<void>)

Parameters

resourceGroupName
string
vmName
string
callback
ServiceCallback<void>

Returns

Promise<void>

beginPerformMaintenanceWithHttpOperationResponse(string, string, Object)

The operation to perform maintenance on a virtual machine.

function beginPerformMaintenanceWithHttpOperationResponse(resourceGroupName: string, vmName: string, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

options
Object

Returns

Promise<HttpOperationResponse<void>>

beginPowerOff(string, string, Object)

The operation to power off (stop) a virtual machine. The virtual machine can be restarted with the same provisioned resources. You are still charged for this virtual machine.

function beginPowerOff(resourceGroupName: string, vmName: string, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

options
Object

Returns

Promise<void>

beginPowerOff(string, string, Object, ServiceCallback<void>)

The operation to power off (stop) a virtual machine. The virtual machine can be restarted with the same provisioned resources. You are still charged for this virtual machine.

function beginPowerOff(resourceGroupName: string, vmName: string, options: Object, callback: ServiceCallback<void>)

Parameters

resourceGroupName
string
vmName
string
options
Object
callback
ServiceCallback<void>

Returns

Promise<void>

beginPowerOff(string, string, ServiceCallback<void>)

The operation to power off (stop) a virtual machine. The virtual machine can be restarted with the same provisioned resources. You are still charged for this virtual machine.

function beginPowerOff(resourceGroupName: string, vmName: string, callback: ServiceCallback<void>)

Parameters

resourceGroupName
string
vmName
string
callback
ServiceCallback<void>

Returns

Promise<void>

beginPowerOffWithHttpOperationResponse(string, string, Object)

The operation to power off (stop) a virtual machine. The virtual machine can be restarted with the same provisioned resources. You are still charged for this virtual machine.

function beginPowerOffWithHttpOperationResponse(resourceGroupName: string, vmName: string, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

options
Object

Returns

Promise<HttpOperationResponse<void>>

beginRedeploy(string, string, Object)

The operation to redeploy a virtual machine.

function beginRedeploy(resourceGroupName: string, vmName: string, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

options
Object

Returns

Promise<void>

beginRedeploy(string, string, Object, ServiceCallback<void>)

The operation to redeploy a virtual machine.

function beginRedeploy(resourceGroupName: string, vmName: string, options: Object, callback: ServiceCallback<void>)

Parameters

resourceGroupName
string
vmName
string
options
Object
callback
ServiceCallback<void>

Returns

Promise<void>

beginRedeploy(string, string, ServiceCallback<void>)

The operation to redeploy a virtual machine.

function beginRedeploy(resourceGroupName: string, vmName: string, callback: ServiceCallback<void>)

Parameters

resourceGroupName
string
vmName
string
callback
ServiceCallback<void>

Returns

Promise<void>

beginRedeployWithHttpOperationResponse(string, string, Object)

The operation to redeploy a virtual machine.

function beginRedeployWithHttpOperationResponse(resourceGroupName: string, vmName: string, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

options
Object

Returns

Promise<HttpOperationResponse<void>>

beginReimage(string, string, Object)

Reimages the virtual machine which has an ephemeral OS disk back to its initial state.

function beginReimage(resourceGroupName: string, vmName: string, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

options
Object

Returns

Promise<void>

beginReimage(string, string, Object, ServiceCallback<void>)

Reimages the virtual machine which has an ephemeral OS disk back to its initial state.

function beginReimage(resourceGroupName: string, vmName: string, options: Object, callback: ServiceCallback<void>)

Parameters

resourceGroupName
string
vmName
string
options
Object
callback
ServiceCallback<void>

Returns

Promise<void>

beginReimage(string, string, ServiceCallback<void>)

Reimages the virtual machine which has an ephemeral OS disk back to its initial state.

function beginReimage(resourceGroupName: string, vmName: string, callback: ServiceCallback<void>)

Parameters

resourceGroupName
string
vmName
string
callback
ServiceCallback<void>

Returns

Promise<void>

beginReimageWithHttpOperationResponse(string, string, Object)

Reimages the virtual machine which has an ephemeral OS disk back to its initial state.

function beginReimageWithHttpOperationResponse(resourceGroupName: string, vmName: string, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

options
Object

Returns

Promise<HttpOperationResponse<void>>

beginRestart(string, string, Object)

The operation to restart a virtual machine.

function beginRestart(resourceGroupName: string, vmName: string, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

options
Object

Returns

Promise<void>

beginRestart(string, string, Object, ServiceCallback<void>)

The operation to restart a virtual machine.

function beginRestart(resourceGroupName: string, vmName: string, options: Object, callback: ServiceCallback<void>)

Parameters

resourceGroupName
string
vmName
string
options
Object
callback
ServiceCallback<void>

Returns

Promise<void>

beginRestart(string, string, ServiceCallback<void>)

The operation to restart a virtual machine.

function beginRestart(resourceGroupName: string, vmName: string, callback: ServiceCallback<void>)

Parameters

resourceGroupName
string
vmName
string
callback
ServiceCallback<void>

Returns

Promise<void>

beginRestartWithHttpOperationResponse(string, string, Object)

The operation to restart a virtual machine.

function beginRestartWithHttpOperationResponse(resourceGroupName: string, vmName: string, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

options
Object

Returns

Promise<HttpOperationResponse<void>>

beginRunCommand(string, string, RunCommandInput, Object)

Run command on the VM.

function beginRunCommand(resourceGroupName: string, vmName: string, parameters: RunCommandInput, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

parameters
RunCommandInput

Parameters supplied to the Run command operation.

options
Object

Returns

Promise<RunCommandResult>

beginRunCommand(string, string, RunCommandInput, Object, ServiceCallback<RunCommandResult>)

Run command on the VM.

function beginRunCommand(resourceGroupName: string, vmName: string, parameters: RunCommandInput, options: Object, callback: ServiceCallback<RunCommandResult>)

Parameters

resourceGroupName
string
vmName
string
parameters
RunCommandInput
options
Object
callback
ServiceCallback<RunCommandResult>

Returns

Promise<RunCommandResult>

beginRunCommand(string, string, RunCommandInput, ServiceCallback<RunCommandResult>)

Run command on the VM.

function beginRunCommand(resourceGroupName: string, vmName: string, parameters: RunCommandInput, callback: ServiceCallback<RunCommandResult>)

Parameters

resourceGroupName
string
vmName
string
parameters
RunCommandInput
callback
ServiceCallback<RunCommandResult>

Returns

Promise<RunCommandResult>

beginRunCommandWithHttpOperationResponse(string, string, RunCommandInput, Object)

Run command on the VM.

function beginRunCommandWithHttpOperationResponse(resourceGroupName: string, vmName: string, parameters: RunCommandInput, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

parameters
RunCommandInput

Parameters supplied to the Run command operation.

options
Object

Returns

Promise<HttpOperationResponse<RunCommandResult>>

beginStart(string, string, Object)

The operation to start a virtual machine.

function beginStart(resourceGroupName: string, vmName: string, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

options
Object

Returns

Promise<void>

beginStart(string, string, Object, ServiceCallback<void>)

The operation to start a virtual machine.

function beginStart(resourceGroupName: string, vmName: string, options: Object, callback: ServiceCallback<void>)

Parameters

resourceGroupName
string
vmName
string
options
Object
callback
ServiceCallback<void>

Returns

Promise<void>

beginStart(string, string, ServiceCallback<void>)

The operation to start a virtual machine.

function beginStart(resourceGroupName: string, vmName: string, callback: ServiceCallback<void>)

Parameters

resourceGroupName
string
vmName
string
callback
ServiceCallback<void>

Returns

Promise<void>

beginStartWithHttpOperationResponse(string, string, Object)

The operation to start a virtual machine.

function beginStartWithHttpOperationResponse(resourceGroupName: string, vmName: string, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

options
Object

Returns

Promise<HttpOperationResponse<void>>

beginUpdate(string, string, VirtualMachineUpdate, Object)

The operation to update a virtual machine.

function beginUpdate(resourceGroupName: string, vmName: string, parameters: VirtualMachineUpdate, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

parameters
VirtualMachineUpdate

Parameters supplied to the Update Virtual Machine operation.

options
Object

Returns

Promise<VirtualMachine>

beginUpdate(string, string, VirtualMachineUpdate, Object, ServiceCallback<VirtualMachine>)

The operation to update a virtual machine.

function beginUpdate(resourceGroupName: string, vmName: string, parameters: VirtualMachineUpdate, options: Object, callback: ServiceCallback<VirtualMachine>)

Parameters

resourceGroupName
string
vmName
string
options
Object
callback
ServiceCallback<VirtualMachine>

Returns

Promise<VirtualMachine>

beginUpdate(string, string, VirtualMachineUpdate, ServiceCallback<VirtualMachine>)

The operation to update a virtual machine.

function beginUpdate(resourceGroupName: string, vmName: string, parameters: VirtualMachineUpdate, callback: ServiceCallback<VirtualMachine>)

Parameters

resourceGroupName
string
vmName
string
callback
ServiceCallback<VirtualMachine>

Returns

Promise<VirtualMachine>

beginUpdateWithHttpOperationResponse(string, string, VirtualMachineUpdate, Object)

The operation to update a virtual machine.

function beginUpdateWithHttpOperationResponse(resourceGroupName: string, vmName: string, parameters: VirtualMachineUpdate, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

parameters
VirtualMachineUpdate

Parameters supplied to the Update Virtual Machine operation.

options
Object

Returns

Promise<HttpOperationResponse<VirtualMachine>>

capture(string, string, VirtualMachineCaptureParameters, Object)

Captures the VM by copying virtual hard disks of the VM and outputs a template that can be used to create similar VMs.

function capture(resourceGroupName: string, vmName: string, parameters: VirtualMachineCaptureParameters, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

parameters
VirtualMachineCaptureParameters

Parameters supplied to the Capture Virtual Machine operation.

options
Object

Returns

capture(string, string, VirtualMachineCaptureParameters, Object, ServiceCallback<VirtualMachineCaptureResult>)

Captures the VM by copying virtual hard disks of the VM and outputs a template that can be used to create similar VMs.

function capture(resourceGroupName: string, vmName: string, parameters: VirtualMachineCaptureParameters, options: Object, callback: ServiceCallback<VirtualMachineCaptureResult>)

Parameters

resourceGroupName
string
vmName
string
options
Object
callback
ServiceCallback<VirtualMachineCaptureResult>

Returns

capture(string, string, VirtualMachineCaptureParameters, ServiceCallback<VirtualMachineCaptureResult>)

Captures the VM by copying virtual hard disks of the VM and outputs a template that can be used to create similar VMs.

function capture(resourceGroupName: string, vmName: string, parameters: VirtualMachineCaptureParameters, callback: ServiceCallback<VirtualMachineCaptureResult>)

Parameters

resourceGroupName
string
vmName
string
callback
ServiceCallback<VirtualMachineCaptureResult>

Returns

captureWithHttpOperationResponse(string, string, VirtualMachineCaptureParameters, Object)

Captures the VM by copying virtual hard disks of the VM and outputs a template that can be used to create similar VMs.

function captureWithHttpOperationResponse(resourceGroupName: string, vmName: string, parameters: VirtualMachineCaptureParameters, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

parameters
VirtualMachineCaptureParameters

Parameters supplied to the Capture Virtual Machine operation.

options
Object

Returns

Promise<HttpOperationResponse<VirtualMachineCaptureResult>>

convertToManagedDisks(string, string, Object)

Converts virtual machine disks from blob-based to managed disks. Virtual machine must be stop-deallocated before invoking this operation.

function convertToManagedDisks(resourceGroupName: string, vmName: string, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

options
Object

Returns

Promise<void>

convertToManagedDisks(string, string, Object, ServiceCallback<void>)

Converts virtual machine disks from blob-based to managed disks. Virtual machine must be stop-deallocated before invoking this operation.

function convertToManagedDisks(resourceGroupName: string, vmName: string, options: Object, callback: ServiceCallback<void>)

Parameters

resourceGroupName
string
vmName
string
options
Object
callback
ServiceCallback<void>

Returns

Promise<void>

convertToManagedDisks(string, string, ServiceCallback<void>)

Converts virtual machine disks from blob-based to managed disks. Virtual machine must be stop-deallocated before invoking this operation.

function convertToManagedDisks(resourceGroupName: string, vmName: string, callback: ServiceCallback<void>)

Parameters

resourceGroupName
string
vmName
string
callback
ServiceCallback<void>

Returns

Promise<void>

convertToManagedDisksWithHttpOperationResponse(string, string, Object)

Converts virtual machine disks from blob-based to managed disks. Virtual machine must be stop-deallocated before invoking this operation.

function convertToManagedDisksWithHttpOperationResponse(resourceGroupName: string, vmName: string, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

options
Object

Returns

Promise<HttpOperationResponse<void>>

createOrUpdate(string, string, VirtualMachine, Object)

The operation to create or update a virtual machine.

function createOrUpdate(resourceGroupName: string, vmName: string, parameters: VirtualMachine, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

parameters
VirtualMachine

Parameters supplied to the Create Virtual Machine operation.

options
Object

Returns

Promise<VirtualMachine>

createOrUpdate(string, string, VirtualMachine, Object, ServiceCallback<VirtualMachine>)

The operation to create or update a virtual machine.

function createOrUpdate(resourceGroupName: string, vmName: string, parameters: VirtualMachine, options: Object, callback: ServiceCallback<VirtualMachine>)

Parameters

resourceGroupName
string
vmName
string
parameters
VirtualMachine
options
Object
callback
ServiceCallback<VirtualMachine>

Returns

Promise<VirtualMachine>

createOrUpdate(string, string, VirtualMachine, ServiceCallback<VirtualMachine>)

The operation to create or update a virtual machine.

function createOrUpdate(resourceGroupName: string, vmName: string, parameters: VirtualMachine, callback: ServiceCallback<VirtualMachine>)

Parameters

resourceGroupName
string
vmName
string
parameters
VirtualMachine
callback
ServiceCallback<VirtualMachine>

Returns

Promise<VirtualMachine>

createOrUpdateWithHttpOperationResponse(string, string, VirtualMachine, Object)

The operation to create or update a virtual machine.

function createOrUpdateWithHttpOperationResponse(resourceGroupName: string, vmName: string, parameters: VirtualMachine, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

parameters
VirtualMachine

Parameters supplied to the Create Virtual Machine operation.

options
Object

Returns

Promise<HttpOperationResponse<VirtualMachine>>

deallocate(string, string, Object)

Shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses.

function deallocate(resourceGroupName: string, vmName: string, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

options
Object

Returns

Promise<void>

deallocate(string, string, Object, ServiceCallback<void>)

Shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses.

function deallocate(resourceGroupName: string, vmName: string, options: Object, callback: ServiceCallback<void>)

Parameters

resourceGroupName
string
vmName
string
options
Object
callback
ServiceCallback<void>

Returns

Promise<void>

deallocate(string, string, ServiceCallback<void>)

Shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses.

function deallocate(resourceGroupName: string, vmName: string, callback: ServiceCallback<void>)

Parameters

resourceGroupName
string
vmName
string
callback
ServiceCallback<void>

Returns

Promise<void>

deallocateWithHttpOperationResponse(string, string, Object)

Shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses.

function deallocateWithHttpOperationResponse(resourceGroupName: string, vmName: string, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

options
Object

Returns

Promise<HttpOperationResponse<void>>

deleteMethod(string, string, Object)

The operation to delete a virtual machine.

function deleteMethod(resourceGroupName: string, vmName: string, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

options
Object

Returns

Promise<void>

deleteMethod(string, string, Object, ServiceCallback<void>)

The operation to delete a virtual machine.

function deleteMethod(resourceGroupName: string, vmName: string, options: Object, callback: ServiceCallback<void>)

Parameters

resourceGroupName
string
vmName
string
options
Object
callback
ServiceCallback<void>

Returns

Promise<void>

deleteMethod(string, string, ServiceCallback<void>)

The operation to delete a virtual machine.

function deleteMethod(resourceGroupName: string, vmName: string, callback: ServiceCallback<void>)

Parameters

resourceGroupName
string
vmName
string
callback
ServiceCallback<void>

Returns

Promise<void>

deleteMethodWithHttpOperationResponse(string, string, Object)

The operation to delete a virtual machine.

function deleteMethodWithHttpOperationResponse(resourceGroupName: string, vmName: string, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

options
Object

Returns

Promise<HttpOperationResponse<void>>

generalize(string, string, Object)

Sets the state of the virtual machine to generalized.

function generalize(resourceGroupName: string, vmName: string, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

options
Object

Returns

Promise<void>

generalize(string, string, Object, ServiceCallback<void>)

Sets the state of the virtual machine to generalized.

function generalize(resourceGroupName: string, vmName: string, options: Object, callback: ServiceCallback<void>)

Parameters

resourceGroupName
string
vmName
string
options
Object
callback
ServiceCallback<void>

Returns

Promise<void>

generalize(string, string, ServiceCallback<void>)

Sets the state of the virtual machine to generalized.

function generalize(resourceGroupName: string, vmName: string, callback: ServiceCallback<void>)

Parameters

resourceGroupName
string
vmName
string
callback
ServiceCallback<void>

Returns

Promise<void>

generalizeWithHttpOperationResponse(string, string, Object)

Sets the state of the virtual machine to generalized.

function generalizeWithHttpOperationResponse(resourceGroupName: string, vmName: string, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

options
Object

Returns

Promise<HttpOperationResponse<void>>

get(string, string, Object)

Retrieves information about the model view or the instance view of a virtual machine.

function get(resourceGroupName: string, vmName: string, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

options
Object

Returns

Promise<VirtualMachine>

get(string, string, Object, ServiceCallback<VirtualMachine>)

Retrieves information about the model view or the instance view of a virtual machine.

function get(resourceGroupName: string, vmName: string, options: Object, callback: ServiceCallback<VirtualMachine>)

Parameters

resourceGroupName
string
vmName
string
options
Object
callback
ServiceCallback<VirtualMachine>

Returns

Promise<VirtualMachine>

get(string, string, ServiceCallback<VirtualMachine>)

Retrieves information about the model view or the instance view of a virtual machine.

function get(resourceGroupName: string, vmName: string, callback: ServiceCallback<VirtualMachine>)

Parameters

resourceGroupName
string
vmName
string
callback
ServiceCallback<VirtualMachine>

Returns

Promise<VirtualMachine>

getWithHttpOperationResponse(string, string, Object)

Retrieves information about the model view or the instance view of a virtual machine.

function getWithHttpOperationResponse(resourceGroupName: string, vmName: string, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

options
Object

Returns

Promise<HttpOperationResponse<VirtualMachine>>

instanceView(string, string, Object)

Retrieves information about the run-time state of a virtual machine.

function instanceView(resourceGroupName: string, vmName: string, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

options
Object

Returns

instanceView(string, string, Object, ServiceCallback<VirtualMachineInstanceView>)

Retrieves information about the run-time state of a virtual machine.

function instanceView(resourceGroupName: string, vmName: string, options: Object, callback: ServiceCallback<VirtualMachineInstanceView>)

Parameters

resourceGroupName
string
vmName
string
options
Object
callback
ServiceCallback<VirtualMachineInstanceView>

Returns

instanceView(string, string, ServiceCallback<VirtualMachineInstanceView>)

Retrieves information about the run-time state of a virtual machine.

function instanceView(resourceGroupName: string, vmName: string, callback: ServiceCallback<VirtualMachineInstanceView>)

Parameters

resourceGroupName
string
vmName
string
callback
ServiceCallback<VirtualMachineInstanceView>

Returns

instanceViewWithHttpOperationResponse(string, string, Object)

Retrieves information about the run-time state of a virtual machine.

function instanceViewWithHttpOperationResponse(resourceGroupName: string, vmName: string, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

options
Object

Returns

Promise<HttpOperationResponse<VirtualMachineInstanceView>>

list(string, Object)

Lists all of the virtual machines in the specified resource group. Use the nextLink property in the response to get the next page of virtual machines.

function list(resourceGroupName: string, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

options
Object

Returns

list(string, Object, ServiceCallback<VirtualMachineListResult>)

Lists all of the virtual machines in the specified resource group. Use the nextLink property in the response to get the next page of virtual machines.

function list(resourceGroupName: string, options: Object, callback: ServiceCallback<VirtualMachineListResult>)

Parameters

resourceGroupName
string
options
Object
callback
ServiceCallback<VirtualMachineListResult>

Returns

list(string, ServiceCallback<VirtualMachineListResult>)

Lists all of the virtual machines in the specified resource group. Use the nextLink property in the response to get the next page of virtual machines.

function list(resourceGroupName: string, callback: ServiceCallback<VirtualMachineListResult>)

Parameters

resourceGroupName
string
callback
ServiceCallback<VirtualMachineListResult>

Returns

listAll(Object)

Lists all of the virtual machines in the specified subscription. Use the nextLink property in the response to get the next page of virtual machines.

function listAll(options?: Object)

Parameters

options
Object

Returns

listAll(Object, ServiceCallback<VirtualMachineListResult>)

Lists all of the virtual machines in the specified subscription. Use the nextLink property in the response to get the next page of virtual machines.

function listAll(options: Object, callback: ServiceCallback<VirtualMachineListResult>)

Parameters

options
Object
callback
ServiceCallback<VirtualMachineListResult>

Returns

listAll(ServiceCallback<VirtualMachineListResult>)

Lists all of the virtual machines in the specified subscription. Use the nextLink property in the response to get the next page of virtual machines.

function listAll(callback: ServiceCallback<VirtualMachineListResult>)

Parameters

callback
ServiceCallback<VirtualMachineListResult>

Returns

listAllNext(string, Object)

Lists all of the virtual machines in the specified subscription. Use the nextLink property in the response to get the next page of virtual machines.

function listAllNext(nextPageLink: string, options?: Object)

Parameters

nextPageLink
string

The NextLink from the previous successful call to List operation.

options
Object

Returns

listAllNext(string, Object, ServiceCallback<VirtualMachineListResult>)

Lists all of the virtual machines in the specified subscription. Use the nextLink property in the response to get the next page of virtual machines.

function listAllNext(nextPageLink: string, options: Object, callback: ServiceCallback<VirtualMachineListResult>)

Parameters

nextPageLink
string
options
Object
callback
ServiceCallback<VirtualMachineListResult>

Returns

listAllNext(string, ServiceCallback<VirtualMachineListResult>)

Lists all of the virtual machines in the specified subscription. Use the nextLink property in the response to get the next page of virtual machines.

function listAllNext(nextPageLink: string, callback: ServiceCallback<VirtualMachineListResult>)

Parameters

nextPageLink
string
callback
ServiceCallback<VirtualMachineListResult>

Returns

listAllNextWithHttpOperationResponse(string, Object)

Lists all of the virtual machines in the specified subscription. Use the nextLink property in the response to get the next page of virtual machines.

function listAllNextWithHttpOperationResponse(nextPageLink: string, options?: Object)

Parameters

nextPageLink
string

The NextLink from the previous successful call to List operation.

options
Object

Returns

Promise<HttpOperationResponse<VirtualMachineListResult>>

listAllWithHttpOperationResponse(Object)

Lists all of the virtual machines in the specified subscription. Use the nextLink property in the response to get the next page of virtual machines.

function listAllWithHttpOperationResponse(options?: Object)

Parameters

options
Object

Returns

Promise<HttpOperationResponse<VirtualMachineListResult>>

listAvailableSizes(string, string, Object)

Lists all available virtual machine sizes to which the specified virtual machine can be resized.

function listAvailableSizes(resourceGroupName: string, vmName: string, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

options
Object

Returns

listAvailableSizes(string, string, Object, ServiceCallback<VirtualMachineSizeListResult>)

Lists all available virtual machine sizes to which the specified virtual machine can be resized.

function listAvailableSizes(resourceGroupName: string, vmName: string, options: Object, callback: ServiceCallback<VirtualMachineSizeListResult>)

Parameters

resourceGroupName
string
vmName
string
options
Object
callback
ServiceCallback<VirtualMachineSizeListResult>

Returns

listAvailableSizes(string, string, ServiceCallback<VirtualMachineSizeListResult>)

Lists all available virtual machine sizes to which the specified virtual machine can be resized.

function listAvailableSizes(resourceGroupName: string, vmName: string, callback: ServiceCallback<VirtualMachineSizeListResult>)

Parameters

resourceGroupName
string
vmName
string
callback
ServiceCallback<VirtualMachineSizeListResult>

Returns

listAvailableSizesWithHttpOperationResponse(string, string, Object)

Lists all available virtual machine sizes to which the specified virtual machine can be resized.

function listAvailableSizesWithHttpOperationResponse(resourceGroupName: string, vmName: string, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

options
Object

Returns

Promise<HttpOperationResponse<VirtualMachineSizeListResult>>

listByLocation(string, Object)

Gets all the virtual machines under the specified subscription for the specified location.

function listByLocation(location: string, options?: Object)

Parameters

location
string

The location for which virtual machines under the subscription are queried.

options
Object

Returns

listByLocation(string, Object, ServiceCallback<VirtualMachineListResult>)

Gets all the virtual machines under the specified subscription for the specified location.

function listByLocation(location: string, options: Object, callback: ServiceCallback<VirtualMachineListResult>)

Parameters

location
string
options
Object
callback
ServiceCallback<VirtualMachineListResult>

Returns

listByLocation(string, ServiceCallback<VirtualMachineListResult>)

Gets all the virtual machines under the specified subscription for the specified location.

function listByLocation(location: string, callback: ServiceCallback<VirtualMachineListResult>)

Parameters

location
string
callback
ServiceCallback<VirtualMachineListResult>

Returns

listByLocationNext(string, Object)

Gets all the virtual machines under the specified subscription for the specified location.

function listByLocationNext(nextPageLink: string, options?: Object)

Parameters

nextPageLink
string

The NextLink from the previous successful call to List operation.

options
Object

Returns

listByLocationNext(string, Object, ServiceCallback<VirtualMachineListResult>)

Gets all the virtual machines under the specified subscription for the specified location.

function listByLocationNext(nextPageLink: string, options: Object, callback: ServiceCallback<VirtualMachineListResult>)

Parameters

nextPageLink
string
options
Object
callback
ServiceCallback<VirtualMachineListResult>

Returns

listByLocationNext(string, ServiceCallback<VirtualMachineListResult>)

Gets all the virtual machines under the specified subscription for the specified location.

function listByLocationNext(nextPageLink: string, callback: ServiceCallback<VirtualMachineListResult>)

Parameters

nextPageLink
string
callback
ServiceCallback<VirtualMachineListResult>

Returns

listByLocationNextWithHttpOperationResponse(string, Object)

Gets all the virtual machines under the specified subscription for the specified location.

function listByLocationNextWithHttpOperationResponse(nextPageLink: string, options?: Object)

Parameters

nextPageLink
string

The NextLink from the previous successful call to List operation.

options
Object

Returns

Promise<HttpOperationResponse<VirtualMachineListResult>>

listByLocationWithHttpOperationResponse(string, Object)

Gets all the virtual machines under the specified subscription for the specified location.

function listByLocationWithHttpOperationResponse(location: string, options?: Object)

Parameters

location
string

The location for which virtual machines under the subscription are queried.

options
Object

Returns

Promise<HttpOperationResponse<VirtualMachineListResult>>

listNext(string, Object)

Lists all of the virtual machines in the specified resource group. Use the nextLink property in the response to get the next page of virtual machines.

function listNext(nextPageLink: string, options?: Object)

Parameters

nextPageLink
string

The NextLink from the previous successful call to List operation.

options
Object

Returns

listNext(string, Object, ServiceCallback<VirtualMachineListResult>)

Lists all of the virtual machines in the specified resource group. Use the nextLink property in the response to get the next page of virtual machines.

function listNext(nextPageLink: string, options: Object, callback: ServiceCallback<VirtualMachineListResult>)

Parameters

nextPageLink
string
options
Object
callback
ServiceCallback<VirtualMachineListResult>

Returns

listNext(string, ServiceCallback<VirtualMachineListResult>)

Lists all of the virtual machines in the specified resource group. Use the nextLink property in the response to get the next page of virtual machines.

function listNext(nextPageLink: string, callback: ServiceCallback<VirtualMachineListResult>)

Parameters

nextPageLink
string
callback
ServiceCallback<VirtualMachineListResult>

Returns

listNextWithHttpOperationResponse(string, Object)

Lists all of the virtual machines in the specified resource group. Use the nextLink property in the response to get the next page of virtual machines.

function listNextWithHttpOperationResponse(nextPageLink: string, options?: Object)

Parameters

nextPageLink
string

The NextLink from the previous successful call to List operation.

options
Object

Returns

Promise<HttpOperationResponse<VirtualMachineListResult>>

listWithHttpOperationResponse(string, Object)

Lists all of the virtual machines in the specified resource group. Use the nextLink property in the response to get the next page of virtual machines.

function listWithHttpOperationResponse(resourceGroupName: string, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

options
Object

Returns

Promise<HttpOperationResponse<VirtualMachineListResult>>

performMaintenance(string, string, Object)

The operation to perform maintenance on a virtual machine.

function performMaintenance(resourceGroupName: string, vmName: string, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

options
Object

Returns

Promise<void>

performMaintenance(string, string, Object, ServiceCallback<void>)

The operation to perform maintenance on a virtual machine.

function performMaintenance(resourceGroupName: string, vmName: string, options: Object, callback: ServiceCallback<void>)

Parameters

resourceGroupName
string
vmName
string
options
Object
callback
ServiceCallback<void>

Returns

Promise<void>

performMaintenance(string, string, ServiceCallback<void>)

The operation to perform maintenance on a virtual machine.

function performMaintenance(resourceGroupName: string, vmName: string, callback: ServiceCallback<void>)

Parameters

resourceGroupName
string
vmName
string
callback
ServiceCallback<void>

Returns

Promise<void>

performMaintenanceWithHttpOperationResponse(string, string, Object)

The operation to perform maintenance on a virtual machine.

function performMaintenanceWithHttpOperationResponse(resourceGroupName: string, vmName: string, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

options
Object

Returns

Promise<HttpOperationResponse<void>>

powerOff(string, string, Object)

The operation to power off (stop) a virtual machine. The virtual machine can be restarted with the same provisioned resources. You are still charged for this virtual machine.

function powerOff(resourceGroupName: string, vmName: string, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

options
Object

Returns

Promise<void>

powerOff(string, string, Object, ServiceCallback<void>)

The operation to power off (stop) a virtual machine. The virtual machine can be restarted with the same provisioned resources. You are still charged for this virtual machine.

function powerOff(resourceGroupName: string, vmName: string, options: Object, callback: ServiceCallback<void>)

Parameters

resourceGroupName
string
vmName
string
options
Object
callback
ServiceCallback<void>

Returns

Promise<void>

powerOff(string, string, ServiceCallback<void>)

The operation to power off (stop) a virtual machine. The virtual machine can be restarted with the same provisioned resources. You are still charged for this virtual machine.

function powerOff(resourceGroupName: string, vmName: string, callback: ServiceCallback<void>)

Parameters

resourceGroupName
string
vmName
string
callback
ServiceCallback<void>

Returns

Promise<void>

powerOffWithHttpOperationResponse(string, string, Object)

The operation to power off (stop) a virtual machine. The virtual machine can be restarted with the same provisioned resources. You are still charged for this virtual machine.

function powerOffWithHttpOperationResponse(resourceGroupName: string, vmName: string, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

options
Object

Returns

Promise<HttpOperationResponse<void>>

redeploy(string, string, Object)

The operation to redeploy a virtual machine.

function redeploy(resourceGroupName: string, vmName: string, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

options
Object

Returns

Promise<void>

redeploy(string, string, Object, ServiceCallback<void>)

The operation to redeploy a virtual machine.

function redeploy(resourceGroupName: string, vmName: string, options: Object, callback: ServiceCallback<void>)

Parameters

resourceGroupName
string
vmName
string
options
Object
callback
ServiceCallback<void>

Returns

Promise<void>

redeploy(string, string, ServiceCallback<void>)

The operation to redeploy a virtual machine.

function redeploy(resourceGroupName: string, vmName: string, callback: ServiceCallback<void>)

Parameters

resourceGroupName
string
vmName
string
callback
ServiceCallback<void>

Returns

Promise<void>

redeployWithHttpOperationResponse(string, string, Object)

The operation to redeploy a virtual machine.

function redeployWithHttpOperationResponse(resourceGroupName: string, vmName: string, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

options
Object

Returns

Promise<HttpOperationResponse<void>>

reimage(string, string, Object)

Reimages the virtual machine which has an ephemeral OS disk back to its initial state.

function reimage(resourceGroupName: string, vmName: string, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

options
Object

Returns

Promise<void>

reimage(string, string, Object, ServiceCallback<void>)

Reimages the virtual machine which has an ephemeral OS disk back to its initial state.

function reimage(resourceGroupName: string, vmName: string, options: Object, callback: ServiceCallback<void>)

Parameters

resourceGroupName
string
vmName
string
options
Object
callback
ServiceCallback<void>

Returns

Promise<void>

reimage(string, string, ServiceCallback<void>)

Reimages the virtual machine which has an ephemeral OS disk back to its initial state.

function reimage(resourceGroupName: string, vmName: string, callback: ServiceCallback<void>)

Parameters

resourceGroupName
string
vmName
string
callback
ServiceCallback<void>

Returns

Promise<void>

reimageWithHttpOperationResponse(string, string, Object)

Reimages the virtual machine which has an ephemeral OS disk back to its initial state.

function reimageWithHttpOperationResponse(resourceGroupName: string, vmName: string, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

options
Object

Returns

Promise<HttpOperationResponse<void>>

restart(string, string, Object)

The operation to restart a virtual machine.

function restart(resourceGroupName: string, vmName: string, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

options
Object

Returns

Promise<void>

restart(string, string, Object, ServiceCallback<void>)

The operation to restart a virtual machine.

function restart(resourceGroupName: string, vmName: string, options: Object, callback: ServiceCallback<void>)

Parameters

resourceGroupName
string
vmName
string
options
Object
callback
ServiceCallback<void>

Returns

Promise<void>

restart(string, string, ServiceCallback<void>)

The operation to restart a virtual machine.

function restart(resourceGroupName: string, vmName: string, callback: ServiceCallback<void>)

Parameters

resourceGroupName
string
vmName
string
callback
ServiceCallback<void>

Returns

Promise<void>

restartWithHttpOperationResponse(string, string, Object)

The operation to restart a virtual machine.

function restartWithHttpOperationResponse(resourceGroupName: string, vmName: string, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

options
Object

Returns

Promise<HttpOperationResponse<void>>

runCommand(string, string, RunCommandInput, Object)

Run command on the VM.

function runCommand(resourceGroupName: string, vmName: string, parameters: RunCommandInput, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

parameters
RunCommandInput

Parameters supplied to the Run command operation.

options
Object

Returns

Promise<RunCommandResult>

runCommand(string, string, RunCommandInput, Object, ServiceCallback<RunCommandResult>)

Run command on the VM.

function runCommand(resourceGroupName: string, vmName: string, parameters: RunCommandInput, options: Object, callback: ServiceCallback<RunCommandResult>)

Parameters

resourceGroupName
string
vmName
string
parameters
RunCommandInput
options
Object
callback
ServiceCallback<RunCommandResult>

Returns

Promise<RunCommandResult>

runCommand(string, string, RunCommandInput, ServiceCallback<RunCommandResult>)

Run command on the VM.

function runCommand(resourceGroupName: string, vmName: string, parameters: RunCommandInput, callback: ServiceCallback<RunCommandResult>)

Parameters

resourceGroupName
string
vmName
string
parameters
RunCommandInput
callback
ServiceCallback<RunCommandResult>

Returns

Promise<RunCommandResult>

runCommandWithHttpOperationResponse(string, string, RunCommandInput, Object)

Run command on the VM.

function runCommandWithHttpOperationResponse(resourceGroupName: string, vmName: string, parameters: RunCommandInput, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

parameters
RunCommandInput

Parameters supplied to the Run command operation.

options
Object

Returns

Promise<HttpOperationResponse<RunCommandResult>>

start(string, string, Object)

The operation to start a virtual machine.

function start(resourceGroupName: string, vmName: string, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

options
Object

Returns

Promise<void>

start(string, string, Object, ServiceCallback<void>)

The operation to start a virtual machine.

function start(resourceGroupName: string, vmName: string, options: Object, callback: ServiceCallback<void>)

Parameters

resourceGroupName
string
vmName
string
options
Object
callback
ServiceCallback<void>

Returns

Promise<void>

start(string, string, ServiceCallback<void>)

The operation to start a virtual machine.

function start(resourceGroupName: string, vmName: string, callback: ServiceCallback<void>)

Parameters

resourceGroupName
string
vmName
string
callback
ServiceCallback<void>

Returns

Promise<void>

startWithHttpOperationResponse(string, string, Object)

The operation to start a virtual machine.

function startWithHttpOperationResponse(resourceGroupName: string, vmName: string, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

options
Object

Returns

Promise<HttpOperationResponse<void>>

update(string, string, VirtualMachineUpdate, Object)

The operation to update a virtual machine.

function update(resourceGroupName: string, vmName: string, parameters: VirtualMachineUpdate, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

parameters
VirtualMachineUpdate

Parameters supplied to the Update Virtual Machine operation.

options
Object

Returns

Promise<VirtualMachine>

update(string, string, VirtualMachineUpdate, Object, ServiceCallback<VirtualMachine>)

The operation to update a virtual machine.

function update(resourceGroupName: string, vmName: string, parameters: VirtualMachineUpdate, options: Object, callback: ServiceCallback<VirtualMachine>)

Parameters

resourceGroupName
string
vmName
string
options
Object
callback
ServiceCallback<VirtualMachine>

Returns

Promise<VirtualMachine>

update(string, string, VirtualMachineUpdate, ServiceCallback<VirtualMachine>)

The operation to update a virtual machine.

function update(resourceGroupName: string, vmName: string, parameters: VirtualMachineUpdate, callback: ServiceCallback<VirtualMachine>)

Parameters

resourceGroupName
string
vmName
string
callback
ServiceCallback<VirtualMachine>

Returns

Promise<VirtualMachine>

updateWithHttpOperationResponse(string, string, VirtualMachineUpdate, Object)

The operation to update a virtual machine.

function updateWithHttpOperationResponse(resourceGroupName: string, vmName: string, parameters: VirtualMachineUpdate, options?: Object)

Parameters

resourceGroupName
string

The name of the resource group.

vmName
string

The name of the virtual machine.

parameters
VirtualMachineUpdate

Parameters supplied to the Update Virtual Machine operation.

options
Object

Returns

Promise<HttpOperationResponse<VirtualMachine>>