VirtualMachines | @azure/arm-scvmm

Interface representing a VirtualMachines.

Hierarchy

VirtualMachines

Implemented by

VirtualMachinesImpl

Methods

beginCreateCheckpoint

beginCreateCheckpoint(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesCreateCheckpointOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/virtualMachines.ts:217
Creates a checkpoint in virtual machine.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualMachineName: string
  
  Name of the VirtualMachine.
- Optional options: VirtualMachinesCreateCheckpointOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginCreateCheckpointAndWait

beginCreateCheckpointAndWait(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesCreateCheckpointOptionalParams): Promise<void>

- Defined in operationsInterfaces/virtualMachines.ts:228
Creates a checkpoint in virtual machine.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualMachineName: string
  
  Name of the VirtualMachine.
- Optional options: VirtualMachinesCreateCheckpointOptionalParams
  
  The options parameters.
Returns Promise<void>

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, virtualMachineName: string, body: VirtualMachine, options?: VirtualMachinesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<VirtualMachinesCreateOrUpdateResponse>, VirtualMachinesCreateOrUpdateResponse>>

- Defined in operationsInterfaces/virtualMachines.ts:68
Creates Or Updates virtual machines deployed on scvmm fabric.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualMachineName: string
  
  Name of the VirtualMachine.
- body: VirtualMachine
  
  Request payload.
- Optional options: VirtualMachinesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<VirtualMachinesCreateOrUpdateResponse>, VirtualMachinesCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, virtualMachineName: string, body: VirtualMachine, options?: VirtualMachinesCreateOrUpdateOptionalParams): Promise<VirtualMachinesCreateOrUpdateResponse>

- Defined in operationsInterfaces/virtualMachines.ts:86
Creates Or Updates virtual machines deployed on scvmm fabric.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualMachineName: string
  
  Name of the VirtualMachine.
- body: VirtualMachine
  
  Request payload.
- Optional options: VirtualMachinesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<VirtualMachinesCreateOrUpdateResponse>

beginDelete

beginDelete(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/virtualMachines.ts:98
Deletes a VirtualMachine deployed on ScVmm fabric.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualMachineName: string
  
  Name of the VirtualMachine.
- Optional options: VirtualMachinesDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesDeleteOptionalParams): Promise<void>

- Defined in operationsInterfaces/virtualMachines.ts:109
Deletes a VirtualMachine deployed on ScVmm fabric.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualMachineName: string
  
  Name of the VirtualMachine.
- Optional options: VirtualMachinesDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

beginDeleteCheckpoint

beginDeleteCheckpoint(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesDeleteCheckpointOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/virtualMachines.ts:239
Deletes a checkpoint in virtual machine.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualMachineName: string
  
  Name of the VirtualMachine.
- Optional options: VirtualMachinesDeleteCheckpointOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteCheckpointAndWait

beginDeleteCheckpointAndWait(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesDeleteCheckpointOptionalParams): Promise<void>

- Defined in operationsInterfaces/virtualMachines.ts:250
Deletes a checkpoint in virtual machine.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualMachineName: string
  
  Name of the VirtualMachine.
- Optional options: VirtualMachinesDeleteCheckpointOptionalParams
  
  The options parameters.
Returns Promise<void>

beginRestart

beginRestart(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesRestartOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/virtualMachines.ts:195
Restart virtual machine.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualMachineName: string
  
  Name of the VirtualMachine.
- Optional options: VirtualMachinesRestartOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginRestartAndWait

beginRestartAndWait(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesRestartOptionalParams): Promise<void>

- Defined in operationsInterfaces/virtualMachines.ts:206
Restart virtual machine.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualMachineName: string
  
  Name of the VirtualMachine.
- Optional options: VirtualMachinesRestartOptionalParams
  
  The options parameters.
Returns Promise<void>

beginRestoreCheckpoint

beginRestoreCheckpoint(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesRestoreCheckpointOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/virtualMachines.ts:261
Restores to a checkpoint in virtual machine.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualMachineName: string
  
  Name of the VirtualMachine.
- Optional options: VirtualMachinesRestoreCheckpointOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginRestoreCheckpointAndWait

beginRestoreCheckpointAndWait(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesRestoreCheckpointOptionalParams): Promise<void>

- Defined in operationsInterfaces/virtualMachines.ts:272
Restores to a checkpoint in virtual machine.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualMachineName: string
  
  Name of the VirtualMachine.
- Optional options: VirtualMachinesRestoreCheckpointOptionalParams
  
  The options parameters.
Returns Promise<void>

beginStart

beginStart(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesStartOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/virtualMachines.ts:173
Start virtual machine.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualMachineName: string
  
  Name of the VirtualMachine.
- Optional options: VirtualMachinesStartOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginStartAndWait

beginStartAndWait(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesStartOptionalParams): Promise<void>

- Defined in operationsInterfaces/virtualMachines.ts:184
Start virtual machine.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualMachineName: string
  
  Name of the VirtualMachine.
- Optional options: VirtualMachinesStartOptionalParams
  
  The options parameters.
Returns Promise<void>

beginStop

beginStop(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesStopOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/virtualMachines.ts:151
Stop virtual machine.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualMachineName: string
  
  Name of the VirtualMachine.
- Optional options: VirtualMachinesStopOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginStopAndWait

beginStopAndWait(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesStopOptionalParams): Promise<void>

- Defined in operationsInterfaces/virtualMachines.ts:162
Stop virtual machine.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualMachineName: string
  
  Name of the VirtualMachine.
- Optional options: VirtualMachinesStopOptionalParams
  
  The options parameters.
Returns Promise<void>

beginUpdate

beginUpdate(resourceGroupName: string, virtualMachineName: string, body: VirtualMachineUpdate, options?: VirtualMachinesUpdateOptionalParams): Promise<PollerLike<PollOperationState<VirtualMachinesUpdateResponse>, VirtualMachinesUpdateResponse>>

- Defined in operationsInterfaces/virtualMachines.ts:121
Updates the VirtualMachines resource.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualMachineName: string
  
  Name of the VirtualMachine.
- body: VirtualMachineUpdate
  
  VirtualMachines patch payload.
- Optional options: VirtualMachinesUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<VirtualMachinesUpdateResponse>, VirtualMachinesUpdateResponse>>

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, virtualMachineName: string, body: VirtualMachineUpdate, options?: VirtualMachinesUpdateOptionalParams): Promise<VirtualMachinesUpdateResponse>

- Defined in operationsInterfaces/virtualMachines.ts:139
Updates the VirtualMachines resource.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualMachineName: string
  
  Name of the VirtualMachine.
- body: VirtualMachineUpdate
  
  VirtualMachines patch payload.
- Optional options: VirtualMachinesUpdateOptionalParams
  
  The options parameters.
Returns Promise<VirtualMachinesUpdateResponse>

get

get(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesGetOptionalParams): Promise<VirtualMachinesGetResponse>

- Defined in operationsInterfaces/virtualMachines.ts:56
Implements VirtualMachine GET method.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualMachineName: string
  
  Name of the VirtualMachine.
- Optional options: VirtualMachinesGetOptionalParams
  
  The options parameters.
Returns Promise<VirtualMachinesGetResponse>

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: VirtualMachinesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<VirtualMachine>

- Defined in operationsInterfaces/virtualMachines.ts:39
List of VirtualMachines in a resource group.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- Optional options: VirtualMachinesListByResourceGroupOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<VirtualMachine>

listBySubscription

listBySubscription(options?: VirtualMachinesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<VirtualMachine>

- Defined in operationsInterfaces/virtualMachines.ts:47
List of VirtualMachines in a subscription.

Parameters
- Optional options: VirtualMachinesListBySubscriptionOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<VirtualMachine>

Hierarchy

Implemented by

Index

Methods

Methods

beginCreateCheckpoint

Parameters

resourceGroupName: string

virtualMachineName: string

Optional options: VirtualMachinesCreateCheckpointOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginCreateCheckpointAndWait

Parameters

resourceGroupName: string

virtualMachineName: string

Optional options: VirtualMachinesCreateCheckpointOptionalParams

Returns Promise<void>

beginCreateOrUpdate

Parameters

resourceGroupName: string

virtualMachineName: string

body: VirtualMachine

Optional options: VirtualMachinesCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<VirtualMachinesCreateOrUpdateResponse>, VirtualMachinesCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

virtualMachineName: string

body: VirtualMachine

Optional options: VirtualMachinesCreateOrUpdateOptionalParams

Returns Promise<VirtualMachinesCreateOrUpdateResponse>

beginDelete

Parameters

resourceGroupName: string

virtualMachineName: string

Optional options: VirtualMachinesDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

virtualMachineName: string

Optional options: VirtualMachinesDeleteOptionalParams

Returns Promise<void>

beginDeleteCheckpoint

Parameters

resourceGroupName: string

virtualMachineName: string

Optional options: VirtualMachinesDeleteCheckpointOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteCheckpointAndWait

Parameters

resourceGroupName: string

virtualMachineName: string

Optional options: VirtualMachinesDeleteCheckpointOptionalParams

Returns Promise<void>

beginRestart

Parameters

resourceGroupName: string

virtualMachineName: string

Optional options: VirtualMachinesRestartOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginRestartAndWait

Parameters

resourceGroupName: string

virtualMachineName: string

Optional options: VirtualMachinesRestartOptionalParams

Returns Promise<void>

beginRestoreCheckpoint

Parameters

resourceGroupName: string

virtualMachineName: string

Optional options: VirtualMachinesRestoreCheckpointOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginRestoreCheckpointAndWait

Parameters

resourceGroupName: string

virtualMachineName: string

Optional options: VirtualMachinesRestoreCheckpointOptionalParams

Returns Promise<void>

beginStart