VirtualMachineInstances interface

Package:

@azure/arm-scvmm

Interface representing a VirtualMachineInstances.

Methods

beginCreateCheckpoint(string, VirtualMachineCreateCheckpoint, VirtualMachineInstancesCreateCheckpointOptionalParams)	Creates a checkpoint in virtual machine instance.
beginCreateCheckpointAndWait(string, VirtualMachineCreateCheckpoint, VirtualMachineInstancesCreateCheckpointOptionalParams)	Creates a checkpoint in virtual machine instance.
beginCreateOrUpdate(string, VirtualMachineInstance, VirtualMachineInstancesCreateOrUpdateOptionalParams)	The operation to create or update a virtual machine instance. Please note some properties can be set only during virtual machine instance creation.
beginCreateOrUpdateAndWait(string, VirtualMachineInstance, VirtualMachineInstancesCreateOrUpdateOptionalParams)	The operation to create or update a virtual machine instance. Please note some properties can be set only during virtual machine instance creation.
beginDelete(string, VirtualMachineInstancesDeleteOptionalParams)	The operation to delete a virtual machine instance.
beginDeleteAndWait(string, VirtualMachineInstancesDeleteOptionalParams)	The operation to delete a virtual machine instance.
beginDeleteCheckpoint(string, VirtualMachineDeleteCheckpoint, VirtualMachineInstancesDeleteCheckpointOptionalParams)	Deletes a checkpoint in virtual machine instance.
beginDeleteCheckpointAndWait(string, VirtualMachineDeleteCheckpoint, VirtualMachineInstancesDeleteCheckpointOptionalParams)	Deletes a checkpoint in virtual machine instance.
beginRestart(string, VirtualMachineInstancesRestartOptionalParams)	The operation to restart a virtual machine instance.
beginRestartAndWait(string, VirtualMachineInstancesRestartOptionalParams)	The operation to restart a virtual machine instance.
beginRestoreCheckpoint(string, VirtualMachineRestoreCheckpoint, VirtualMachineInstancesRestoreCheckpointOptionalParams)	Restores to a checkpoint in virtual machine instance.
beginRestoreCheckpointAndWait(string, VirtualMachineRestoreCheckpoint, VirtualMachineInstancesRestoreCheckpointOptionalParams)	Restores to a checkpoint in virtual machine instance.
beginStart(string, VirtualMachineInstancesStartOptionalParams)	The operation to start a virtual machine instance.
beginStartAndWait(string, VirtualMachineInstancesStartOptionalParams)	The operation to start a virtual machine instance.
beginStop(string, StopVirtualMachineOptions, VirtualMachineInstancesStopOptionalParams)	The operation to power off (stop) a virtual machine instance.
beginStopAndWait(string, StopVirtualMachineOptions, VirtualMachineInstancesStopOptionalParams)	The operation to power off (stop) a virtual machine instance.
beginUpdate(string, VirtualMachineInstanceUpdate, VirtualMachineInstancesUpdateOptionalParams)	The operation to update a virtual machine instance.
beginUpdateAndWait(string, VirtualMachineInstanceUpdate, VirtualMachineInstancesUpdateOptionalParams)	The operation to update a virtual machine instance.
get(string, VirtualMachineInstancesGetOptionalParams)	Retrieves information about a virtual machine instance.
list(string, VirtualMachineInstancesListOptionalParams)	Lists all of the virtual machine instances within the specified parent resource.

Method Details

beginCreateCheckpoint(string, VirtualMachineCreateCheckpoint, VirtualMachineInstancesCreateCheckpointOptionalParams)

Creates a checkpoint in virtual machine instance.

function beginCreateCheckpoint(resourceUri: string, body: VirtualMachineCreateCheckpoint, options?: VirtualMachineInstancesCreateCheckpointOptionalParams): Promise<SimplePollerLike<OperationState<VirtualMachineInstancesCreateCheckpointHeaders>, VirtualMachineInstancesCreateCheckpointHeaders>>

Parameters

resourceUri

string

The fully qualified Azure Resource manager identifier of the resource.

body

VirtualMachineCreateCheckpoint

The content of the action request

options

VirtualMachineInstancesCreateCheckpointOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualMachineInstancesCreateCheckpointHeaders>, VirtualMachineInstancesCreateCheckpointHeaders>>

beginCreateCheckpointAndWait(string, VirtualMachineCreateCheckpoint, VirtualMachineInstancesCreateCheckpointOptionalParams)

Creates a checkpoint in virtual machine instance.

function beginCreateCheckpointAndWait(resourceUri: string, body: VirtualMachineCreateCheckpoint, options?: VirtualMachineInstancesCreateCheckpointOptionalParams): Promise<VirtualMachineInstancesCreateCheckpointHeaders>

Parameters

resourceUri

string

The fully qualified Azure Resource manager identifier of the resource.

body

VirtualMachineCreateCheckpoint

The content of the action request

options

VirtualMachineInstancesCreateCheckpointOptionalParams

The options parameters.

Returns

Promise<VirtualMachineInstancesCreateCheckpointHeaders>

beginCreateOrUpdate(string, VirtualMachineInstance, VirtualMachineInstancesCreateOrUpdateOptionalParams)

The operation to create or update a virtual machine instance. Please note some properties can be set only during virtual machine instance creation.

function beginCreateOrUpdate(resourceUri: string, resource: VirtualMachineInstance, options?: VirtualMachineInstancesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<VirtualMachineInstance>, VirtualMachineInstance>>

Parameters

resourceUri

string

The fully qualified Azure Resource manager identifier of the resource.

resource

VirtualMachineInstance

Resource create parameters.

options

VirtualMachineInstancesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualMachineInstance>, VirtualMachineInstance>>

beginCreateOrUpdateAndWait(string, VirtualMachineInstance, VirtualMachineInstancesCreateOrUpdateOptionalParams)

The operation to create or update a virtual machine instance. Please note some properties can be set only during virtual machine instance creation.

function beginCreateOrUpdateAndWait(resourceUri: string, resource: VirtualMachineInstance, options?: VirtualMachineInstancesCreateOrUpdateOptionalParams): Promise<VirtualMachineInstance>

Parameters

resourceUri

string

The fully qualified Azure Resource manager identifier of the resource.

resource

VirtualMachineInstance

Resource create parameters.

options

VirtualMachineInstancesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<VirtualMachineInstance>

beginDelete(string, VirtualMachineInstancesDeleteOptionalParams)

The operation to delete a virtual machine instance.

function beginDelete(resourceUri: string, options?: VirtualMachineInstancesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<VirtualMachineInstancesDeleteHeaders>, VirtualMachineInstancesDeleteHeaders>>

Parameters

resourceUri

string

The fully qualified Azure Resource manager identifier of the resource.

options

VirtualMachineInstancesDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualMachineInstancesDeleteHeaders>, VirtualMachineInstancesDeleteHeaders>>

beginDeleteAndWait(string, VirtualMachineInstancesDeleteOptionalParams)

The operation to delete a virtual machine instance.

function beginDeleteAndWait(resourceUri: string, options?: VirtualMachineInstancesDeleteOptionalParams): Promise<VirtualMachineInstancesDeleteHeaders>

Parameters

resourceUri

string

The fully qualified Azure Resource manager identifier of the resource.

options

VirtualMachineInstancesDeleteOptionalParams

The options parameters.

Returns

Promise<VirtualMachineInstancesDeleteHeaders>

beginDeleteCheckpoint(string, VirtualMachineDeleteCheckpoint, VirtualMachineInstancesDeleteCheckpointOptionalParams)

Deletes a checkpoint in virtual machine instance.

function beginDeleteCheckpoint(resourceUri: string, body: VirtualMachineDeleteCheckpoint, options?: VirtualMachineInstancesDeleteCheckpointOptionalParams): Promise<SimplePollerLike<OperationState<VirtualMachineInstancesDeleteCheckpointHeaders>, VirtualMachineInstancesDeleteCheckpointHeaders>>

Parameters

resourceUri

string

The fully qualified Azure Resource manager identifier of the resource.

body

VirtualMachineDeleteCheckpoint

The content of the action request

options

VirtualMachineInstancesDeleteCheckpointOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualMachineInstancesDeleteCheckpointHeaders>, VirtualMachineInstancesDeleteCheckpointHeaders>>

beginDeleteCheckpointAndWait(string, VirtualMachineDeleteCheckpoint, VirtualMachineInstancesDeleteCheckpointOptionalParams)

Deletes a checkpoint in virtual machine instance.

function beginDeleteCheckpointAndWait(resourceUri: string, body: VirtualMachineDeleteCheckpoint, options?: VirtualMachineInstancesDeleteCheckpointOptionalParams): Promise<VirtualMachineInstancesDeleteCheckpointHeaders>

Parameters

resourceUri

string

The fully qualified Azure Resource manager identifier of the resource.

body

VirtualMachineDeleteCheckpoint

The content of the action request

options

VirtualMachineInstancesDeleteCheckpointOptionalParams

The options parameters.

Returns

Promise<VirtualMachineInstancesDeleteCheckpointHeaders>

beginRestart(string, VirtualMachineInstancesRestartOptionalParams)

The operation to restart a virtual machine instance.

function beginRestart(resourceUri: string, options?: VirtualMachineInstancesRestartOptionalParams): Promise<SimplePollerLike<OperationState<VirtualMachineInstancesRestartHeaders>, VirtualMachineInstancesRestartHeaders>>

Parameters

resourceUri

string

The fully qualified Azure Resource manager identifier of the resource.

options

VirtualMachineInstancesRestartOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualMachineInstancesRestartHeaders>, VirtualMachineInstancesRestartHeaders>>

beginRestartAndWait(string, VirtualMachineInstancesRestartOptionalParams)

The operation to restart a virtual machine instance.

function beginRestartAndWait(resourceUri: string, options?: VirtualMachineInstancesRestartOptionalParams): Promise<VirtualMachineInstancesRestartHeaders>

Parameters

resourceUri

string

The fully qualified Azure Resource manager identifier of the resource.

options

VirtualMachineInstancesRestartOptionalParams

The options parameters.

Returns

Promise<VirtualMachineInstancesRestartHeaders>

beginRestoreCheckpoint(string, VirtualMachineRestoreCheckpoint, VirtualMachineInstancesRestoreCheckpointOptionalParams)

Restores to a checkpoint in virtual machine instance.

function beginRestoreCheckpoint(resourceUri: string, body: VirtualMachineRestoreCheckpoint, options?: VirtualMachineInstancesRestoreCheckpointOptionalParams): Promise<SimplePollerLike<OperationState<VirtualMachineInstancesRestoreCheckpointHeaders>, VirtualMachineInstancesRestoreCheckpointHeaders>>

Parameters

resourceUri

string

The fully qualified Azure Resource manager identifier of the resource.

body

VirtualMachineRestoreCheckpoint

The content of the action request

options

VirtualMachineInstancesRestoreCheckpointOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualMachineInstancesRestoreCheckpointHeaders>, VirtualMachineInstancesRestoreCheckpointHeaders>>

beginRestoreCheckpointAndWait(string, VirtualMachineRestoreCheckpoint, VirtualMachineInstancesRestoreCheckpointOptionalParams)

Restores to a checkpoint in virtual machine instance.

function beginRestoreCheckpointAndWait(resourceUri: string, body: VirtualMachineRestoreCheckpoint, options?: VirtualMachineInstancesRestoreCheckpointOptionalParams): Promise<VirtualMachineInstancesRestoreCheckpointHeaders>

Parameters

resourceUri

string

The fully qualified Azure Resource manager identifier of the resource.

body

VirtualMachineRestoreCheckpoint

The content of the action request

options

VirtualMachineInstancesRestoreCheckpointOptionalParams

The options parameters.

Returns

Promise<VirtualMachineInstancesRestoreCheckpointHeaders>

beginStart(string, VirtualMachineInstancesStartOptionalParams)

The operation to start a virtual machine instance.

function beginStart(resourceUri: string, options?: VirtualMachineInstancesStartOptionalParams): Promise<SimplePollerLike<OperationState<VirtualMachineInstancesStartHeaders>, VirtualMachineInstancesStartHeaders>>

Parameters

resourceUri

string

The fully qualified Azure Resource manager identifier of the resource.

options

VirtualMachineInstancesStartOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualMachineInstancesStartHeaders>, VirtualMachineInstancesStartHeaders>>

beginStartAndWait(string, VirtualMachineInstancesStartOptionalParams)

The operation to start a virtual machine instance.

function beginStartAndWait(resourceUri: string, options?: VirtualMachineInstancesStartOptionalParams): Promise<VirtualMachineInstancesStartHeaders>

Parameters

resourceUri

string

The fully qualified Azure Resource manager identifier of the resource.

options

VirtualMachineInstancesStartOptionalParams

The options parameters.

Returns

Promise<VirtualMachineInstancesStartHeaders>

beginStop(string, StopVirtualMachineOptions, VirtualMachineInstancesStopOptionalParams)

The operation to power off (stop) a virtual machine instance.

function beginStop(resourceUri: string, body: StopVirtualMachineOptions, options?: VirtualMachineInstancesStopOptionalParams): Promise<SimplePollerLike<OperationState<VirtualMachineInstancesStopHeaders>, VirtualMachineInstancesStopHeaders>>

Parameters

resourceUri

string

The fully qualified Azure Resource manager identifier of the resource.

body

StopVirtualMachineOptions

The content of the action request

options

VirtualMachineInstancesStopOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualMachineInstancesStopHeaders>, VirtualMachineInstancesStopHeaders>>

beginStopAndWait(string, StopVirtualMachineOptions, VirtualMachineInstancesStopOptionalParams)

The operation to power off (stop) a virtual machine instance.

function beginStopAndWait(resourceUri: string, body: StopVirtualMachineOptions, options?: VirtualMachineInstancesStopOptionalParams): Promise<VirtualMachineInstancesStopHeaders>

Parameters

resourceUri

string

The fully qualified Azure Resource manager identifier of the resource.

body

StopVirtualMachineOptions

The content of the action request

options

VirtualMachineInstancesStopOptionalParams

The options parameters.

Returns

Promise<VirtualMachineInstancesStopHeaders>

beginUpdate(string, VirtualMachineInstanceUpdate, VirtualMachineInstancesUpdateOptionalParams)

The operation to update a virtual machine instance.

function beginUpdate(resourceUri: string, properties: VirtualMachineInstanceUpdate, options?: VirtualMachineInstancesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<VirtualMachineInstance>, VirtualMachineInstance>>

Parameters

resourceUri

string

The fully qualified Azure Resource manager identifier of the resource.

properties

VirtualMachineInstanceUpdate

The resource properties to be updated.

options

VirtualMachineInstancesUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualMachineInstance>, VirtualMachineInstance>>

beginUpdateAndWait(string, VirtualMachineInstanceUpdate, VirtualMachineInstancesUpdateOptionalParams)

The operation to update a virtual machine instance.

function beginUpdateAndWait(resourceUri: string, properties: VirtualMachineInstanceUpdate, options?: VirtualMachineInstancesUpdateOptionalParams): Promise<VirtualMachineInstance>

Parameters

resourceUri

string

The fully qualified Azure Resource manager identifier of the resource.

properties

VirtualMachineInstanceUpdate

The resource properties to be updated.

options

VirtualMachineInstancesUpdateOptionalParams

The options parameters.

Returns

Promise<VirtualMachineInstance>

get(string, VirtualMachineInstancesGetOptionalParams)

Retrieves information about a virtual machine instance.

function get(resourceUri: string, options?: VirtualMachineInstancesGetOptionalParams): Promise<VirtualMachineInstance>

Parameters

resourceUri

string

The fully qualified Azure Resource manager identifier of the resource.

options

VirtualMachineInstancesGetOptionalParams

The options parameters.

Returns

Promise<VirtualMachineInstance>

list(string, VirtualMachineInstancesListOptionalParams)

Lists all of the virtual machine instances within the specified parent resource.

function list(resourceUri: string, options?: VirtualMachineInstancesListOptionalParams): PagedAsyncIterableIterator<VirtualMachineInstance, VirtualMachineInstance[], PageSettings>

Parameters

resourceUri

string

The fully qualified Azure Resource manager identifier of the resource.

options

VirtualMachineInstancesListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<VirtualMachineInstance, VirtualMachineInstance[], PageSettings>