Package version:

Interface VirtualMachineInstances

Interface representing a VirtualMachineInstances.

interface VirtualMachineInstances {
    beginCreateCheckpoint(resourceUri, body, options?): Promise<SimplePollerLike<OperationState<VirtualMachineInstancesCreateCheckpointHeaders>, VirtualMachineInstancesCreateCheckpointHeaders>>;
    beginCreateCheckpointAndWait(resourceUri, body, options?): Promise<VirtualMachineInstancesCreateCheckpointHeaders>;
    beginCreateOrUpdate(resourceUri, resource, options?): Promise<SimplePollerLike<OperationState<VirtualMachineInstance>, VirtualMachineInstance>>;
    beginCreateOrUpdateAndWait(resourceUri, resource, options?): Promise<VirtualMachineInstance>;
    beginDelete(resourceUri, options?): Promise<SimplePollerLike<OperationState<VirtualMachineInstancesDeleteHeaders>, VirtualMachineInstancesDeleteHeaders>>;
    beginDeleteAndWait(resourceUri, options?): Promise<VirtualMachineInstancesDeleteHeaders>;
    beginDeleteCheckpoint(resourceUri, body, options?): Promise<SimplePollerLike<OperationState<VirtualMachineInstancesDeleteCheckpointHeaders>, VirtualMachineInstancesDeleteCheckpointHeaders>>;
    beginDeleteCheckpointAndWait(resourceUri, body, options?): Promise<VirtualMachineInstancesDeleteCheckpointHeaders>;
    beginRestart(resourceUri, options?): Promise<SimplePollerLike<OperationState<VirtualMachineInstancesRestartHeaders>, VirtualMachineInstancesRestartHeaders>>;
    beginRestartAndWait(resourceUri, options?): Promise<VirtualMachineInstancesRestartHeaders>;
    beginRestoreCheckpoint(resourceUri, body, options?): Promise<SimplePollerLike<OperationState<VirtualMachineInstancesRestoreCheckpointHeaders>, VirtualMachineInstancesRestoreCheckpointHeaders>>;
    beginRestoreCheckpointAndWait(resourceUri, body, options?): Promise<VirtualMachineInstancesRestoreCheckpointHeaders>;
    beginStart(resourceUri, options?): Promise<SimplePollerLike<OperationState<VirtualMachineInstancesStartHeaders>, VirtualMachineInstancesStartHeaders>>;
    beginStartAndWait(resourceUri, options?): Promise<VirtualMachineInstancesStartHeaders>;
    beginStop(resourceUri, body, options?): Promise<SimplePollerLike<OperationState<VirtualMachineInstancesStopHeaders>, VirtualMachineInstancesStopHeaders>>;
    beginStopAndWait(resourceUri, body, options?): Promise<VirtualMachineInstancesStopHeaders>;
    beginUpdate(resourceUri, properties, options?): Promise<SimplePollerLike<OperationState<VirtualMachineInstance>, VirtualMachineInstance>>;
    beginUpdateAndWait(resourceUri, properties, options?): Promise<VirtualMachineInstance>;
    get(resourceUri, options?): Promise<VirtualMachineInstance>;
    list(resourceUri, options?): PagedAsyncIterableIterator<VirtualMachineInstance>;
}

Methods

beginCreateCheckpoint

beginCreateCheckpoint(resourceUri, body, options?): Promise<SimplePollerLike<OperationState<VirtualMachineInstancesCreateCheckpointHeaders>, VirtualMachineInstancesCreateCheckpointHeaders>>
Creates a checkpoint in virtual machine instance.
Parameters
- resourceUri: string
  The fully qualified Azure Resource manager identifier of the resource.
- body: VirtualMachineCreateCheckpoint
  The content of the action request
- Optional options: VirtualMachineInstancesCreateCheckpointOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<VirtualMachineInstancesCreateCheckpointHeaders>, VirtualMachineInstancesCreateCheckpointHeaders>>
- Defined in operationsInterfaces/virtualMachineInstances.ts:147

beginCreateCheckpointAndWait

beginCreateCheckpointAndWait(resourceUri, body, options?): Promise<VirtualMachineInstancesCreateCheckpointHeaders>
Creates a checkpoint in virtual machine instance.
Parameters
- resourceUri: string
  The fully qualified Azure Resource manager identifier of the resource.
- body: VirtualMachineCreateCheckpoint
  The content of the action request
- Optional options: VirtualMachineInstancesCreateCheckpointOptionalParams
  The options parameters.
Returns Promise<VirtualMachineInstancesCreateCheckpointHeaders>
- Defined in operationsInterfaces/virtualMachineInstances.ts:163

beginCreateOrUpdate

beginCreateOrUpdate(resourceUri, resource, options?): Promise<SimplePollerLike<OperationState<VirtualMachineInstance>, VirtualMachineInstance>>
The operation to create or update a virtual machine instance. Please note some properties can be set only during virtual machine instance creation.
Parameters
- resourceUri: string
  The fully qualified Azure Resource manager identifier of the resource.
- resource: VirtualMachineInstance
  Resource create parameters.
- Optional options: VirtualMachineInstancesCreateOrUpdateOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<VirtualMachineInstance>, VirtualMachineInstance>>
- Defined in operationsInterfaces/virtualMachineInstances.ts:69

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceUri, resource, options?): Promise<VirtualMachineInstance>
The operation to create or update a virtual machine instance. Please note some properties can be set only during virtual machine instance creation.
Parameters
- resourceUri: string
  The fully qualified Azure Resource manager identifier of the resource.
- resource: VirtualMachineInstance
  Resource create parameters.
- Optional options: VirtualMachineInstancesCreateOrUpdateOptionalParams
  The options parameters.
Returns Promise<VirtualMachineInstance>
- Defined in operationsInterfaces/virtualMachineInstances.ts:86

beginDelete

beginDelete(resourceUri, options?): Promise<SimplePollerLike<OperationState<VirtualMachineInstancesDeleteHeaders>, VirtualMachineInstancesDeleteHeaders>>
The operation to delete a virtual machine instance.
Parameters
- resourceUri: string
  The fully qualified Azure Resource manager identifier of the resource.
- Optional options: VirtualMachineInstancesDeleteOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<VirtualMachineInstancesDeleteHeaders>, VirtualMachineInstancesDeleteHeaders>>
- Defined in operationsInterfaces/virtualMachineInstances.ts:123

beginDeleteAndWait

beginDeleteAndWait(resourceUri, options?): Promise<VirtualMachineInstancesDeleteHeaders>
The operation to delete a virtual machine instance.
Parameters
- resourceUri: string
  The fully qualified Azure Resource manager identifier of the resource.
- Optional options: VirtualMachineInstancesDeleteOptionalParams
  The options parameters.
Returns Promise<VirtualMachineInstancesDeleteHeaders>
- Defined in operationsInterfaces/virtualMachineInstances.ts:137

beginDeleteCheckpoint

beginDeleteCheckpoint(resourceUri, body, options?): Promise<SimplePollerLike<OperationState<VirtualMachineInstancesDeleteCheckpointHeaders>, VirtualMachineInstancesDeleteCheckpointHeaders>>
Deletes a checkpoint in virtual machine instance.
Parameters
- resourceUri: string
  The fully qualified Azure Resource manager identifier of the resource.
- body: VirtualMachineDeleteCheckpoint
  The content of the action request
- Optional options: VirtualMachineInstancesDeleteCheckpointOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<VirtualMachineInstancesDeleteCheckpointHeaders>, VirtualMachineInstancesDeleteCheckpointHeaders>>
- Defined in operationsInterfaces/virtualMachineInstances.ts:174

beginDeleteCheckpointAndWait

beginDeleteCheckpointAndWait(resourceUri, body, options?): Promise<VirtualMachineInstancesDeleteCheckpointHeaders>
Deletes a checkpoint in virtual machine instance.
Parameters
- resourceUri: string
  The fully qualified Azure Resource manager identifier of the resource.
- body: VirtualMachineDeleteCheckpoint
  The content of the action request
- Optional options: VirtualMachineInstancesDeleteCheckpointOptionalParams
  The options parameters.
Returns Promise<VirtualMachineInstancesDeleteCheckpointHeaders>
- Defined in operationsInterfaces/virtualMachineInstances.ts:190

beginRestart

beginRestart(resourceUri, options?): Promise<SimplePollerLike<OperationState<VirtualMachineInstancesRestartHeaders>, VirtualMachineInstancesRestartHeaders>>
The operation to restart a virtual machine instance.
Parameters
- resourceUri: string
  The fully qualified Azure Resource manager identifier of the resource.
- Optional options: VirtualMachineInstancesRestartOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<VirtualMachineInstancesRestartHeaders>, VirtualMachineInstancesRestartHeaders>>
- Defined in operationsInterfaces/virtualMachineInstances.ts:200

beginRestartAndWait

beginRestartAndWait(resourceUri, options?): Promise<VirtualMachineInstancesRestartHeaders>
The operation to restart a virtual machine instance.
Parameters
- resourceUri: string
  The fully qualified Azure Resource manager identifier of the resource.
- Optional options: VirtualMachineInstancesRestartOptionalParams
  The options parameters.
Returns Promise<VirtualMachineInstancesRestartHeaders>
- Defined in operationsInterfaces/virtualMachineInstances.ts:214

beginRestoreCheckpoint

beginRestoreCheckpoint(resourceUri, body, options?): Promise<SimplePollerLike<OperationState<VirtualMachineInstancesRestoreCheckpointHeaders>, VirtualMachineInstancesRestoreCheckpointHeaders>>
Restores to a checkpoint in virtual machine instance.
Parameters
- resourceUri: string
  The fully qualified Azure Resource manager identifier of the resource.
- body: VirtualMachineRestoreCheckpoint
  The content of the action request
- Optional options: VirtualMachineInstancesRestoreCheckpointOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<VirtualMachineInstancesRestoreCheckpointHeaders>, VirtualMachineInstancesRestoreCheckpointHeaders>>
- Defined in operationsInterfaces/virtualMachineInstances.ts:224

beginRestoreCheckpointAndWait

beginRestoreCheckpointAndWait(resourceUri, body, options?): Promise<VirtualMachineInstancesRestoreCheckpointHeaders>
Restores to a checkpoint in virtual machine instance.
Parameters
- resourceUri: string
  The fully qualified Azure Resource manager identifier of the resource.
- body: VirtualMachineRestoreCheckpoint
  The content of the action request
- Optional options: VirtualMachineInstancesRestoreCheckpointOptionalParams
  The options parameters.
Returns Promise<VirtualMachineInstancesRestoreCheckpointHeaders>
- Defined in operationsInterfaces/virtualMachineInstances.ts:240

beginStart

beginStart(resourceUri, options?): Promise<SimplePollerLike<OperationState<VirtualMachineInstancesStartHeaders>, VirtualMachineInstancesStartHeaders>>
The operation to start a virtual machine instance.
Parameters
- resourceUri: string
  The fully qualified Azure Resource manager identifier of the resource.
- Optional options: VirtualMachineInstancesStartOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<VirtualMachineInstancesStartHeaders>, VirtualMachineInstancesStartHeaders>>
- Defined in operationsInterfaces/virtualMachineInstances.ts:250

beginStartAndWait

beginStartAndWait(resourceUri, options?): Promise<VirtualMachineInstancesStartHeaders>
The operation to start a virtual machine instance.
Parameters
- resourceUri: string
  The fully qualified Azure Resource manager identifier of the resource.
- Optional options: VirtualMachineInstancesStartOptionalParams
  The options parameters.
Returns Promise<VirtualMachineInstancesStartHeaders>
- Defined in operationsInterfaces/virtualMachineInstances.ts:264

beginStop

beginStop(resourceUri, body, options?): Promise<SimplePollerLike<OperationState<VirtualMachineInstancesStopHeaders>, VirtualMachineInstancesStopHeaders>>
The operation to power off (stop) a virtual machine instance.
Parameters
- resourceUri: string
  The fully qualified Azure Resource manager identifier of the resource.
- body: StopVirtualMachineOptions
  The content of the action request
- Optional options: VirtualMachineInstancesStopOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<VirtualMachineInstancesStopHeaders>, VirtualMachineInstancesStopHeaders>>
- Defined in operationsInterfaces/virtualMachineInstances.ts:274

beginStopAndWait

beginStopAndWait(resourceUri, body, options?): Promise<VirtualMachineInstancesStopHeaders>
The operation to power off (stop) a virtual machine instance.
Parameters
- resourceUri: string
  The fully qualified Azure Resource manager identifier of the resource.
- body: StopVirtualMachineOptions
  The content of the action request
- Optional options: VirtualMachineInstancesStopOptionalParams
  The options parameters.
Returns Promise<VirtualMachineInstancesStopHeaders>
- Defined in operationsInterfaces/virtualMachineInstances.ts:290

beginUpdate

beginUpdate(resourceUri, properties, options?): Promise<SimplePollerLike<OperationState<VirtualMachineInstance>, VirtualMachineInstance>>
The operation to update a virtual machine instance.
Parameters
- resourceUri: string
  The fully qualified Azure Resource manager identifier of the resource.
- properties: VirtualMachineInstanceUpdate
  The resource properties to be updated.
- Optional options: VirtualMachineInstancesUpdateOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<VirtualMachineInstance>, VirtualMachineInstance>>
- Defined in operationsInterfaces/virtualMachineInstances.ts:97

beginUpdateAndWait

beginUpdateAndWait(resourceUri, properties, options?): Promise<VirtualMachineInstance>
The operation to update a virtual machine instance.
Parameters
- resourceUri: string
  The fully qualified Azure Resource manager identifier of the resource.
- properties: VirtualMachineInstanceUpdate
  The resource properties to be updated.
- Optional options: VirtualMachineInstancesUpdateOptionalParams
  The options parameters.
Returns Promise<VirtualMachineInstance>
- Defined in operationsInterfaces/virtualMachineInstances.ts:113

get

get(resourceUri, options?): Promise<VirtualMachineInstance>
Retrieves information about a virtual machine instance.
Parameters
- resourceUri: string
  The fully qualified Azure Resource manager identifier of the resource.
- Optional options: VirtualMachineInstancesGetOptionalParams
  The options parameters.
Returns Promise<VirtualMachineInstance>
- Defined in operationsInterfaces/virtualMachineInstances.ts:58

list

list(resourceUri, options?): PagedAsyncIterableIterator<VirtualMachineInstance>
Lists all of the virtual machine instances within the specified parent resource.
Parameters
- resourceUri: string
  The fully qualified Azure Resource manager identifier of the resource.
- Optional options: VirtualMachineInstancesListOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<VirtualMachineInstance>
- Defined in operationsInterfaces/virtualMachineInstances.ts:49

Interface VirtualMachineInstances

Index

Methods

Methods

beginCreateCheckpoint

Parameters

Returns Promise<SimplePollerLike<OperationState<VirtualMachineInstancesCreateCheckpointHeaders>, VirtualMachineInstancesCreateCheckpointHeaders>>

beginCreateCheckpointAndWait

Parameters

Returns Promise<VirtualMachineInstancesCreateCheckpointHeaders>

beginCreateOrUpdate

Parameters

Returns Promise<SimplePollerLike<OperationState<VirtualMachineInstance>, VirtualMachineInstance>>

beginCreateOrUpdateAndWait

Parameters

Returns Promise<VirtualMachineInstance>

beginDelete

Parameters

Returns Promise<SimplePollerLike<OperationState<VirtualMachineInstancesDeleteHeaders>, VirtualMachineInstancesDeleteHeaders>>

beginDeleteAndWait

Parameters

Returns Promise<VirtualMachineInstancesDeleteHeaders>

beginDeleteCheckpoint

Parameters

Returns Promise<SimplePollerLike<OperationState<VirtualMachineInstancesDeleteCheckpointHeaders>, VirtualMachineInstancesDeleteCheckpointHeaders>>

beginDeleteCheckpointAndWait

Parameters

Returns Promise<VirtualMachineInstancesDeleteCheckpointHeaders>

beginRestart

Parameters

Returns Promise<SimplePollerLike<OperationState<VirtualMachineInstancesRestartHeaders>, VirtualMachineInstancesRestartHeaders>>

beginRestartAndWait

Parameters

Returns Promise<VirtualMachineInstancesRestartHeaders>

beginRestoreCheckpoint

Parameters

Returns Promise<SimplePollerLike<OperationState<VirtualMachineInstancesRestoreCheckpointHeaders>, VirtualMachineInstancesRestoreCheckpointHeaders>>

beginRestoreCheckpointAndWait

Parameters

Returns Promise<VirtualMachineInstancesRestoreCheckpointHeaders>

beginStart

Parameters

Returns Promise<SimplePollerLike<OperationState<VirtualMachineInstancesStartHeaders>, VirtualMachineInstancesStartHeaders>>

beginStartAndWait

Parameters

Returns Promise<VirtualMachineInstancesStartHeaders>

beginStop

Parameters

Returns Promise<SimplePollerLike<OperationState<VirtualMachineInstancesStopHeaders>, VirtualMachineInstancesStopHeaders>>

beginStopAndWait

Parameters

Returns Promise<VirtualMachineInstancesStopHeaders>

beginUpdate

Parameters

Returns Promise<SimplePollerLike<OperationState<VirtualMachineInstance>, VirtualMachineInstance>>

beginUpdateAndWait

Parameters

Returns Promise<VirtualMachineInstance>

get

Parameters

Returns Promise<VirtualMachineInstance>

list

Parameters

Returns PagedAsyncIterableIterator<VirtualMachineInstance>

Settings

Member Visibility

Theme