VirtualMachines | @azure/arm-vmwarecloudsimple

Class representing a VirtualMachines.

Hierarchy

VirtualMachines

Index

Constructors

constructor

Methods

Constructors

constructor

new VirtualMachines(client: VMwareCloudSimpleClientContext): VirtualMachines

- Defined in operations/virtualMachines.ts:20
Create a VirtualMachines.

Parameters
- client: VMwareCloudSimpleClientContext
  
  Reference to the service client.
Returns VirtualMachines

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, virtualMachineName: string, virtualMachineRequest: VirtualMachine, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/virtualMachines.ts:192
Create Or Update Virtual Machine

summary

Implements virtual machine PUT method

Parameters
- resourceGroupName: string
  
  The name of the resource group
- virtualMachineName: string
  
  virtual machine name
- virtualMachineRequest: VirtualMachine
  
  Create or Update Virtual Machine request
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginDeleteMethod

beginDeleteMethod(resourceGroupName: string, virtualMachineName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/virtualMachines.ts:212
Delete virtual machine

summary

Implements virtual machine DELETE method

Parameters
- resourceGroupName: string
  
  The name of the resource group
- virtualMachineName: string
  
  virtual machine name
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginStart

beginStart(resourceGroupName: string, virtualMachineName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/virtualMachines.ts:250
Power on virtual machine

summary

Implements a start method for a virtual machine

Parameters
- resourceGroupName: string
  
  The name of the resource group
- virtualMachineName: string
  
  virtual machine name
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginStop

beginStop(resourceGroupName: string, virtualMachineName: string, options?: Models.VirtualMachinesBeginStopOptionalParams): Promise<msRestAzure.LROPoller>

- Defined in operations/virtualMachines.ts:269
Power off virtual machine, options: shutdown, poweroff, and suspend

summary

Implements shutdown, poweroff, and suspend method for a virtual machine

Parameters
- resourceGroupName: string
  
  The name of the resource group
- virtualMachineName: string
  
  virtual machine name
- Optional options: Models.VirtualMachinesBeginStopOptionalParams
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginUpdate

beginUpdate(resourceGroupName: string, virtualMachineName: string, options?: Models.VirtualMachinesBeginUpdateOptionalParams): Promise<msRestAzure.LROPoller>

- Defined in operations/virtualMachines.ts:231
Patch virtual machine properties

summary

Implements virtual machine PATCH method

Parameters
- resourceGroupName: string
  
  The name of the resource group
- virtualMachineName: string
  
  virtual machine name
- Optional options: Models.VirtualMachinesBeginUpdateOptionalParams
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

createOrUpdate

createOrUpdate(resourceGroupName: string, virtualMachineName: string, virtualMachineRequest: VirtualMachine, options?: msRest.RequestOptionsBase): Promise<Models.VirtualMachinesCreateOrUpdateResponse>

- Defined in operations/virtualMachines.ts:126
Create Or Update Virtual Machine

summary

Implements virtual machine PUT method

Parameters
- resourceGroupName: string
  
  The name of the resource group
- virtualMachineName: string
  
  virtual machine name
- virtualMachineRequest: VirtualMachine
  
  Create or Update Virtual Machine request
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VirtualMachinesCreateOrUpdateResponse>

Promise<Models.VirtualMachinesCreateOrUpdateResponse>

deleteMethod

deleteMethod(resourceGroupName: string, virtualMachineName: string, options?: msRest.RequestOptionsBase): Promise<Models.VirtualMachinesDeleteResponse>

- Defined in operations/virtualMachines.ts:139
Delete virtual machine

summary

Implements virtual machine DELETE method

Parameters
- resourceGroupName: string
  
  The name of the resource group
- virtualMachineName: string
  
  virtual machine name
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VirtualMachinesDeleteResponse>

Promise<Models.VirtualMachinesDeleteResponse>

get

get(resourceGroupName: string, virtualMachineName: string, options?: msRest.RequestOptionsBase): Promise<Models.VirtualMachinesGetResponse>
get(resourceGroupName: string, virtualMachineName: string, callback: msRest.ServiceCallback<VirtualMachine>): void
get(resourceGroupName: string, virtualMachineName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<VirtualMachine>): void

- Defined in operations/virtualMachines.ts:92
Get virtual machine

summary

Implements virtual machine GET method

Parameters
- resourceGroupName: string
  
  The name of the resource group
- virtualMachineName: string
  
  virtual machine name
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VirtualMachinesGetResponse>

Promise<Models.VirtualMachinesGetResponse>
- Defined in operations/virtualMachines.ts:98
Parameters
- resourceGroupName: string
  
  The name of the resource group
- virtualMachineName: string
  
  virtual machine name
- callback: msRest.ServiceCallback<VirtualMachine>
  
  The callback
Returns void
- Defined in operations/virtualMachines.ts:105
Parameters
- resourceGroupName: string
  
  The name of the resource group
- virtualMachineName: string
  
  virtual machine name
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<VirtualMachine>
  
  The callback
Returns void

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: Models.VirtualMachinesListByResourceGroupOptionalParams): Promise<Models.VirtualMachinesListByResourceGroupResponse>
listByResourceGroup(resourceGroupName: string, callback: msRest.ServiceCallback<VirtualMachineListResponse>): void
listByResourceGroup(resourceGroupName: string, options: VirtualMachinesListByResourceGroupOptionalParams, callback: msRest.ServiceCallback<VirtualMachineListResponse>): void

- Defined in operations/virtualMachines.ts:62
Returns list of virtual machine within resource group

summary

Implements list virtual machine within RG method

Parameters
- resourceGroupName: string
  
  The name of the resource group
- Optional options: Models.VirtualMachinesListByResourceGroupOptionalParams
Returns Promise<Models.VirtualMachinesListByResourceGroupResponse>

Promise<Models.VirtualMachinesListByResourceGroupResponse>
- Defined in operations/virtualMachines.ts:67
Parameters
- resourceGroupName: string
  
  The name of the resource group
- callback: msRest.ServiceCallback<VirtualMachineListResponse>
  
  The callback
Returns void
- Defined in operations/virtualMachines.ts:73
Parameters
- resourceGroupName: string
  
  The name of the resource group
- options: VirtualMachinesListByResourceGroupOptionalParams
  
  The optional parameters
- callback: msRest.ServiceCallback<VirtualMachineListResponse>
  
  The callback
Returns void

listByResourceGroupNext

listByResourceGroupNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.VirtualMachinesListByResourceGroupNextResponse>
listByResourceGroupNext(nextPageLink: string, callback: msRest.ServiceCallback<VirtualMachineListResponse>): void
listByResourceGroupNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<VirtualMachineListResponse>): void

- Defined in operations/virtualMachines.ts:316
Returns list of virtual machine within resource group

summary

Implements list virtual machine within RG method

Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VirtualMachinesListByResourceGroupNextResponse>

Promise<Models.VirtualMachinesListByResourceGroupNextResponse>
- Defined in operations/virtualMachines.ts:321
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- callback: msRest.ServiceCallback<VirtualMachineListResponse>
  
  The callback
Returns void
- Defined in operations/virtualMachines.ts:327
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<VirtualMachineListResponse>
  
  The callback
Returns void

listBySubscription

listBySubscription(options?: Models.VirtualMachinesListBySubscriptionOptionalParams): Promise<Models.VirtualMachinesListBySubscriptionResponse>
listBySubscription(callback: msRest.ServiceCallback<VirtualMachineListResponse>): void
listBySubscription(options: VirtualMachinesListBySubscriptionOptionalParams, callback: msRest.ServiceCallback<VirtualMachineListResponse>): void

- Defined in operations/virtualMachines.ts:36
Returns list virtual machine within subscription

summary

Implements list virtual machine within subscription method

Parameters
- Optional options: Models.VirtualMachinesListBySubscriptionOptionalParams
Returns Promise<Models.VirtualMachinesListBySubscriptionResponse>

Promise<Models.VirtualMachinesListBySubscriptionResponse>
- Defined in operations/virtualMachines.ts:40
Parameters
- callback: msRest.ServiceCallback<VirtualMachineListResponse>
  
  The callback
Returns void
- Defined in operations/virtualMachines.ts:45
Parameters
- options: VirtualMachinesListBySubscriptionOptionalParams
  
  The optional parameters
- callback: msRest.ServiceCallback<VirtualMachineListResponse>
  
  The callback
Returns void

listBySubscriptionNext

listBySubscriptionNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.VirtualMachinesListBySubscriptionNextResponse>
listBySubscriptionNext(nextPageLink: string, callback: msRest.ServiceCallback<VirtualMachineListResponse>): void
listBySubscriptionNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<VirtualMachineListResponse>): void

- Defined in operations/virtualMachines.ts:287
Returns list virtual machine within subscription

summary

Implements list virtual machine within subscription method

Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VirtualMachinesListBySubscriptionNextResponse>

Promise<Models.VirtualMachinesListBySubscriptionNextResponse>
- Defined in operations/virtualMachines.ts:292
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- callback: msRest.ServiceCallback<VirtualMachineListResponse>
  
  The callback
Returns void
- Defined in operations/virtualMachines.ts:298
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<VirtualMachineListResponse>
  
  The callback
Returns void

start

start(resourceGroupName: string, virtualMachineName: string, options?: msRest.RequestOptionsBase): Promise<Models.VirtualMachinesStartResponse>

- Defined in operations/virtualMachines.ts:165
Power on virtual machine

summary

Implements a start method for a virtual machine

Parameters
- resourceGroupName: string
  
  The name of the resource group
- virtualMachineName: string
  
  virtual machine name
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VirtualMachinesStartResponse>

Promise<Models.VirtualMachinesStartResponse>

stop

stop(resourceGroupName: string, virtualMachineName: string, options?: Models.VirtualMachinesStopOptionalParams): Promise<Models.VirtualMachinesStopResponse>

- Defined in operations/virtualMachines.ts:178
Power off virtual machine, options: shutdown, poweroff, and suspend

summary

Implements shutdown, poweroff, and suspend method for a virtual machine

Parameters
- resourceGroupName: string
  
  The name of the resource group
- virtualMachineName: string
  
  virtual machine name
- Optional options: Models.VirtualMachinesStopOptionalParams
Returns Promise<Models.VirtualMachinesStopResponse>

Promise<Models.VirtualMachinesStopResponse>

update

update(resourceGroupName: string, virtualMachineName: string, options?: Models.VirtualMachinesUpdateOptionalParams): Promise<Models.VirtualMachinesUpdateResponse>

- Defined in operations/virtualMachines.ts:152
Patch virtual machine properties

summary

Implements virtual machine PATCH method

Parameters
- resourceGroupName: string
  
  The name of the resource group
- virtualMachineName: string
  
  virtual machine name
- Optional options: Models.VirtualMachinesUpdateOptionalParams
Returns Promise<Models.VirtualMachinesUpdateResponse>

Promise<Models.VirtualMachinesUpdateResponse>

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: VMwareCloudSimpleClientContext

Returns VirtualMachines

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

virtualMachineName: string

virtualMachineRequest: VirtualMachine

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

beginDeleteMethod

Parameters

resourceGroupName: string

virtualMachineName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

beginStart

Parameters

resourceGroupName: string

virtualMachineName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

beginStop

Parameters

resourceGroupName: string

virtualMachineName: string

Optional options: Models.VirtualMachinesBeginStopOptionalParams

Returns Promise<msRestAzure.LROPoller>

beginUpdate

Parameters

resourceGroupName: string

virtualMachineName: string

Optional options: Models.VirtualMachinesBeginUpdateOptionalParams

Returns Promise<msRestAzure.LROPoller>

createOrUpdate

Parameters

resourceGroupName: string

virtualMachineName: string

virtualMachineRequest: VirtualMachine

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.VirtualMachinesCreateOrUpdateResponse>

deleteMethod

Parameters

resourceGroupName: string

virtualMachineName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.VirtualMachinesDeleteResponse>

get

Parameters

resourceGroupName: string

virtualMachineName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.VirtualMachinesGetResponse>

Parameters

resourceGroupName: string

virtualMachineName: string

callback: msRest.ServiceCallback<VirtualMachine>

Returns void

Parameters

resourceGroupName: string

virtualMachineName: string

options: msRest.RequestOptionsBase

callback: msRest.ServiceCallback<VirtualMachine>

Returns void

listByResourceGroup

Parameters

resourceGroupName: string

Optional options: Models.VirtualMachinesListByResourceGroupOptionalParams

Returns Promise<Models.VirtualMachinesListByResourceGroupResponse>

Parameters

resourceGroupName: string

callback: msRest.ServiceCallback<VirtualMachineListResponse>

Returns void