VirtualMachines interface

Methods

beginCapture

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

beginCapture

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

beginCapture

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

beginCaptureWithHttpOperationResponse

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

beginConvertToManagedDisks

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

beginConvertToManagedDisks

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

beginConvertToManagedDisks

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

beginConvertToManagedDisksWithHttpOperationResponse

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

beginCreateOrUpdate

The operation to create or update a virtual machine.

beginCreateOrUpdate

The operation to create or update a virtual machine.

beginCreateOrUpdate

The operation to create or update a virtual machine.

beginCreateOrUpdateWithHttpOperationResponse

The operation to create or update a virtual machine.

beginDeallocate

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

beginDeallocate

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

beginDeallocate

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

beginDeallocateWithHttpOperationResponse

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

beginDeleteMethod

The operation to delete a virtual machine.

beginDeleteMethod

The operation to delete a virtual machine.

beginDeleteMethod

The operation to delete a virtual machine.

beginDeleteMethodWithHttpOperationResponse

The operation to delete a virtual machine.

beginPerformMaintenance

The operation to perform maintenance on a virtual machine.

beginPerformMaintenance

The operation to perform maintenance on a virtual machine.

beginPerformMaintenance

The operation to perform maintenance on a virtual machine.

beginPerformMaintenanceWithHttpOperationResponse

The operation to perform maintenance on a virtual machine.

beginPowerOff

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

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

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

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

The operation to redeploy a virtual machine.

beginRedeploy

The operation to redeploy a virtual machine.

beginRedeploy

The operation to redeploy a virtual machine.

beginRedeployWithHttpOperationResponse

The operation to redeploy a virtual machine.

beginRestart

The operation to restart a virtual machine.

beginRestart

The operation to restart a virtual machine.

beginRestart

The operation to restart a virtual machine.

beginRestartWithHttpOperationResponse

The operation to restart a virtual machine.

beginRunCommand

Run command on the VM.

beginRunCommand

Run command on the VM.

beginRunCommand

Run command on the VM.

beginRunCommandWithHttpOperationResponse

Run command on the VM.

beginStart

The operation to start a virtual machine.

beginStart

The operation to start a virtual machine.

beginStart

The operation to start a virtual machine.

beginStartWithHttpOperationResponse

The operation to start a virtual machine.

beginUpdate

The operation to update a virtual machine.

beginUpdate

The operation to update a virtual machine.

beginUpdate

The operation to update a virtual machine.

beginUpdateWithHttpOperationResponse

The operation to update a virtual machine.

capture

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

capture

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

capture

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

captureWithHttpOperationResponse

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

convertToManagedDisks

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

convertToManagedDisks

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

convertToManagedDisks

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

convertToManagedDisksWithHttpOperationResponse

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

createOrUpdate

The operation to create or update a virtual machine.

createOrUpdate

The operation to create or update a virtual machine.

createOrUpdate

The operation to create or update a virtual machine.

createOrUpdateWithHttpOperationResponse

The operation to create or update a virtual machine.

deallocate

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

deallocate

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

deallocate

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

deallocateWithHttpOperationResponse

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

deleteMethod

The operation to delete a virtual machine.

deleteMethod

The operation to delete a virtual machine.

deleteMethod

The operation to delete a virtual machine.

deleteMethodWithHttpOperationResponse

The operation to delete a virtual machine.

generalize

Sets the state of the virtual machine to generalized.

generalize

Sets the state of the virtual machine to generalized.

generalize

Sets the state of the virtual machine to generalized.

generalizeWithHttpOperationResponse

Sets the state of the virtual machine to generalized.

get

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

get

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

get

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

getWithHttpOperationResponse

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

instanceView

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

instanceView

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

instanceView

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

instanceViewWithHttpOperationResponse

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

list

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

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

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

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

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

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

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

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

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

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

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

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

listAvailableSizes

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

listAvailableSizes

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

listAvailableSizesWithHttpOperationResponse

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

listByLocation

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

listByLocation

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

listByLocation

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

listByLocationNext

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

listByLocationNext

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

listByLocationNext

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

listByLocationNextWithHttpOperationResponse

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

listByLocationWithHttpOperationResponse

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

listNext

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

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

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

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

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

The operation to perform maintenance on a virtual machine.

performMaintenance

The operation to perform maintenance on a virtual machine.

performMaintenance

The operation to perform maintenance on a virtual machine.

performMaintenanceWithHttpOperationResponse

The operation to perform maintenance on a virtual machine.

powerOff

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

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

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

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

The operation to redeploy a virtual machine.

redeploy

The operation to redeploy a virtual machine.

redeploy

The operation to redeploy a virtual machine.

redeployWithHttpOperationResponse

The operation to redeploy a virtual machine.

restart

The operation to restart a virtual machine.

restart

The operation to restart a virtual machine.

restart

The operation to restart a virtual machine.

restartWithHttpOperationResponse

The operation to restart a virtual machine.

runCommand

Run command on the VM.

runCommand

Run command on the VM.

runCommand

Run command on the VM.

runCommandWithHttpOperationResponse

Run command on the VM.

start

The operation to start a virtual machine.

start

The operation to start a virtual machine.

start

The operation to start a virtual machine.

startWithHttpOperationResponse

The operation to start a virtual machine.

update

The operation to update a virtual machine.

update

The operation to update a virtual machine.

update

The operation to update a virtual machine.

updateWithHttpOperationResponse

The operation to update a virtual machine.

Method Details

beginCapture

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

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

beginCapture

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

beginCaptureWithHttpOperationResponse

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

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

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>

beginConvertToManagedDisks

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>

beginConvertToManagedDisksWithHttpOperationResponse

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

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>

beginCreateOrUpdate

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

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>

beginCreateOrUpdateWithHttpOperationResponse

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

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

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>

beginDeallocate

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>

beginDeallocateWithHttpOperationResponse

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

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>

beginDeleteMethod

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

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>

beginDeleteMethodWithHttpOperationResponse

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

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

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

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

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

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>

beginPowerOff

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

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>

beginPowerOffWithHttpOperationResponse

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

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>

beginRedeploy

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

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>

beginRedeployWithHttpOperationResponse

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>>

beginRestart

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

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>

beginRestart

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>

beginRestartWithHttpOperationResponse

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

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>

beginRunCommand

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

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>

beginRunCommandWithHttpOperationResponse

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

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

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>

beginStart

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>

beginStartWithHttpOperationResponse

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

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>

beginUpdate

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

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>

beginUpdateWithHttpOperationResponse

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

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

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

capture

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

captureWithHttpOperationResponse

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

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>

convertToManagedDisks

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

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>

convertToManagedDisksWithHttpOperationResponse

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

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>

createOrUpdate

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

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>

createOrUpdateWithHttpOperationResponse

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

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>

deallocate

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

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>

deallocateWithHttpOperationResponse

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

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

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>

deleteMethod

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>

deleteMethodWithHttpOperationResponse

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

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

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>

generalize

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>

generalizeWithHttpOperationResponse

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

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

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

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

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

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

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

instanceView

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

instanceViewWithHttpOperationResponse

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

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

list

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

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

listAll

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

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

listAll

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

listAllNext

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

listAllNext

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

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

listAllNextWithHttpOperationResponse

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

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

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

listAvailableSizes

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

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

listAvailableSizesWithHttpOperationResponse

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

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

listByLocation

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

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

listByLocationNext

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

listByLocationNext

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

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

listByLocationNextWithHttpOperationResponse

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

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

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

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

listNext

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

listNextWithHttpOperationResponse

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

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

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>

performMaintenance

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

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>

performMaintenanceWithHttpOperationResponse

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

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>

powerOff

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

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>

powerOffWithHttpOperationResponse

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

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

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>

redeploy

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>

redeployWithHttpOperationResponse

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>>

restart

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

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>

restart

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>

restartWithHttpOperationResponse

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

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>

runCommand

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

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>

runCommandWithHttpOperationResponse

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

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

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>

start

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>

startWithHttpOperationResponse

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

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

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>

update

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>

updateWithHttpOperationResponse

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>>