VirtualMachineScaleSetVMs | @azure/arm-compute-profile-2019-03-01-hybrid

Class representing a VirtualMachineScaleSetVMs.

Hierarchy

VirtualMachineScaleSetVMs

Index

Constructors

constructor

Constructors

constructor

new VirtualMachineScaleSetVMs(client: ComputeManagementClientContext): VirtualMachineScaleSetVMs

- Defined in operations/virtualMachineScaleSetVMs.ts:20
Create a VirtualMachineScaleSetVMs.

Parameters
- client: ComputeManagementClientContext
  
  Reference to the service client.
Returns VirtualMachineScaleSetVMs

Methods

beginDeallocate

beginDeallocate(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/virtualMachineScaleSetVMs.ts:322
Deallocates a specific virtual machine in a VM scale set. Shuts down the virtual machine and releases the compute resources it uses. You are not billed for the compute resources of this virtual machine once it is deallocated.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmScaleSetName: string
  
  The name of the VM scale set.
- instanceId: string
  
  The instance ID of the virtual machine.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginDeleteMethod

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

- Defined in operations/virtualMachineScaleSetVMs.ts:365
Deletes a virtual machine from a VM scale set.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmScaleSetName: string
  
  The name of the VM scale set.
- instanceId: string
  
  The instance ID of the virtual machine.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginPerformMaintenance

beginPerformMaintenance(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/virtualMachineScaleSetVMs.ts:467
Performs maintenance on a virtual machine in a VM scale set.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmScaleSetName: string
  
  The name of the VM scale set.
- instanceId: string
  
  The instance ID of the virtual machine.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginPowerOff

beginPowerOff(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/virtualMachineScaleSetVMs.ts:387
Power off (stop) a virtual machine in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmScaleSetName: string
  
  The name of the VM scale set.
- instanceId: string
  
  The instance ID of the virtual machine.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginRedeploy

beginRedeploy(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/virtualMachineScaleSetVMs.ts:447
Redeploys a virtual machine in a VM scale set.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmScaleSetName: string
  
  The name of the VM scale set.
- instanceId: string
  
  The instance ID of the virtual machine.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginReimage

beginReimage(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/virtualMachineScaleSetVMs.ts:279
Reimages (upgrade the operating system) a specific virtual machine in a VM scale set.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmScaleSetName: string
  
  The name of the VM scale set.
- instanceId: string
  
  The instance ID of the virtual machine.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginReimageAll

beginReimageAll(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/virtualMachineScaleSetVMs.ts:300
Allows you to re-image all the disks ( including data disks ) in the a VM scale set instance. This operation is only supported for managed disks.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmScaleSetName: string
  
  The name of the VM scale set.
- instanceId: string
  
  The instance ID of the virtual machine.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginRestart

beginRestart(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/virtualMachineScaleSetVMs.ts:407
Restarts a virtual machine in a VM scale set.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmScaleSetName: string
  
  The name of the VM scale set.
- instanceId: string
  
  The instance ID of the virtual machine.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginStart

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

- Defined in operations/virtualMachineScaleSetVMs.ts:427
Starts a virtual machine in a VM scale set.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmScaleSetName: string
  
  The name of the VM scale set.
- instanceId: string
  
  The instance ID of the virtual machine.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginUpdate

beginUpdate(resourceGroupName: string, vmScaleSetName: string, instanceId: string, parameters: VirtualMachineScaleSetVM, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/virtualMachineScaleSetVMs.ts:344
Updates a virtual machine of a VM scale set.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmScaleSetName: string
  
  The name of the VM scale set where the extension should be create or updated.
- instanceId: string
  
  The instance ID of the virtual machine.
- parameters: VirtualMachineScaleSetVM
  
  Parameters supplied to the Update Virtual Machine Scale Sets VM operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

deallocate

deallocate(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: msRest.RequestOptionsBase): Promise<Models.VirtualMachineScaleSetVMsDeallocateResponse>

- Defined in operations/virtualMachineScaleSetVMs.ts:67
Deallocates a specific virtual machine in a VM scale set. Shuts down the virtual machine and releases the compute resources it uses. You are not billed for the compute resources of this virtual machine once it is deallocated.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmScaleSetName: string
  
  The name of the VM scale set.
- instanceId: string
  
  The instance ID of the virtual machine.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VirtualMachineScaleSetVMsDeallocateResponse>

Promise<Models.VirtualMachineScaleSetVMsDeallocateResponse>

deleteMethod

deleteMethod(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: msRest.RequestOptionsBase): Promise<Models.VirtualMachineScaleSetVMsDeleteMethodResponse>

- Defined in operations/virtualMachineScaleSetVMs.ts:95
Deletes a virtual machine from a VM scale set.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmScaleSetName: string
  
  The name of the VM scale set.
- instanceId: string
  
  The instance ID of the virtual machine.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VirtualMachineScaleSetVMsDeleteMethodResponse>

Promise<Models.VirtualMachineScaleSetVMsDeleteMethodResponse>

get

get(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: msRest.RequestOptionsBase): Promise<Models.VirtualMachineScaleSetVMsGetResponse>
get(resourceGroupName: string, vmScaleSetName: string, instanceId: string, callback: msRest.ServiceCallback<VirtualMachineScaleSetVM>): void
get(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<VirtualMachineScaleSetVM>): void

- Defined in operations/virtualMachineScaleSetVMs.ts:108
Gets a virtual machine from a VM scale set.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmScaleSetName: string
  
  The name of the VM scale set.
- instanceId: string
  
  The instance ID of the virtual machine.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VirtualMachineScaleSetVMsGetResponse>

Promise<Models.VirtualMachineScaleSetVMsGetResponse>
- Defined in operations/virtualMachineScaleSetVMs.ts:115
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmScaleSetName: string
  
  The name of the VM scale set.
- instanceId: string
  
  The instance ID of the virtual machine.
- callback: msRest.ServiceCallback<VirtualMachineScaleSetVM>
  
  The callback
Returns void
- Defined in operations/virtualMachineScaleSetVMs.ts:123
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmScaleSetName: string
  
  The name of the VM scale set.
- instanceId: string
  
  The instance ID of the virtual machine.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<VirtualMachineScaleSetVM>
  
  The callback
Returns void

getInstanceView

getInstanceView(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: msRest.RequestOptionsBase): Promise<Models.VirtualMachineScaleSetVMsGetInstanceViewResponse>
getInstanceView(resourceGroupName: string, vmScaleSetName: string, instanceId: string, callback: msRest.ServiceCallback<VirtualMachineScaleSetVMInstanceView>): void
getInstanceView(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<VirtualMachineScaleSetVMInstanceView>): void

- Defined in operations/virtualMachineScaleSetVMs.ts:144
Gets the status of a virtual machine from a VM scale set.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmScaleSetName: string
  
  The name of the VM scale set.
- instanceId: string
  
  The instance ID of the virtual machine.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VirtualMachineScaleSetVMsGetInstanceViewResponse>

Promise<Models.VirtualMachineScaleSetVMsGetInstanceViewResponse>
- Defined in operations/virtualMachineScaleSetVMs.ts:151
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmScaleSetName: string
  
  The name of the VM scale set.
- instanceId: string
  
  The instance ID of the virtual machine.
- callback: msRest.ServiceCallback<VirtualMachineScaleSetVMInstanceView>
  
  The callback
Returns void
- Defined in operations/virtualMachineScaleSetVMs.ts:159
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmScaleSetName: string
  
  The name of the VM scale set.
- instanceId: string
  
  The instance ID of the virtual machine.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<VirtualMachineScaleSetVMInstanceView>
  
  The callback
Returns void

list

list(resourceGroupName: string, virtualMachineScaleSetName: string, options?: Models.VirtualMachineScaleSetVMsListOptionalParams): Promise<Models.VirtualMachineScaleSetVMsListResponse>
list(resourceGroupName: string, virtualMachineScaleSetName: string, callback: msRest.ServiceCallback<VirtualMachineScaleSetVMListResult>): void
list(resourceGroupName: string, virtualMachineScaleSetName: string, options: VirtualMachineScaleSetVMsListOptionalParams, callback: msRest.ServiceCallback<VirtualMachineScaleSetVMListResult>): void

- Defined in operations/virtualMachineScaleSetVMs.ts:179
Gets a list of all virtual machines in a VM scale sets.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualMachineScaleSetName: string
  
  The name of the VM scale set.
- Optional options: Models.VirtualMachineScaleSetVMsListOptionalParams
Returns Promise<Models.VirtualMachineScaleSetVMsListResponse>

Promise<Models.VirtualMachineScaleSetVMsListResponse>
- Defined in operations/virtualMachineScaleSetVMs.ts:185
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualMachineScaleSetName: string
  
  The name of the VM scale set.
- callback: msRest.ServiceCallback<VirtualMachineScaleSetVMListResult>
  
  The callback
Returns void
- Defined in operations/virtualMachineScaleSetVMs.ts:192
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualMachineScaleSetName: string
  
  The name of the VM scale set.
- options: VirtualMachineScaleSetVMsListOptionalParams
  
  The optional parameters
- callback: msRest.ServiceCallback<VirtualMachineScaleSetVMListResult>
  
  The callback
Returns void

listNext

listNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.VirtualMachineScaleSetVMsListNextResponse>
listNext(nextPageLink: string, callback: msRest.ServiceCallback<VirtualMachineScaleSetVMListResult>): void
listNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<VirtualMachineScaleSetVMListResult>): void

- Defined in operations/virtualMachineScaleSetVMs.ts:485
Gets a list of all virtual machines in a VM scale sets.

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

Promise<Models.VirtualMachineScaleSetVMsListNextResponse>
- Defined in operations/virtualMachineScaleSetVMs.ts:490
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- callback: msRest.ServiceCallback<VirtualMachineScaleSetVMListResult>
  
  The callback
Returns void
- Defined in operations/virtualMachineScaleSetVMs.ts:496
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<VirtualMachineScaleSetVMListResult>
  
  The callback
Returns void

performMaintenance

performMaintenance(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: msRest.RequestOptionsBase): Promise<Models.VirtualMachineScaleSetVMsPerformMaintenanceResponse>

- Defined in operations/virtualMachineScaleSetVMs.ts:266
Performs maintenance on a virtual machine in a VM scale set.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmScaleSetName: string
  
  The name of the VM scale set.
- instanceId: string
  
  The instance ID of the virtual machine.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VirtualMachineScaleSetVMsPerformMaintenanceResponse>

Promise<Models.VirtualMachineScaleSetVMsPerformMaintenanceResponse>

powerOff

powerOff(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: msRest.RequestOptionsBase): Promise<Models.VirtualMachineScaleSetVMsPowerOffResponse>

- Defined in operations/virtualMachineScaleSetVMs.ts:214
Power off (stop) a virtual machine in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmScaleSetName: string
  
  The name of the VM scale set.
- instanceId: string
  
  The instance ID of the virtual machine.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VirtualMachineScaleSetVMsPowerOffResponse>

Promise<Models.VirtualMachineScaleSetVMsPowerOffResponse>

redeploy

redeploy(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: msRest.RequestOptionsBase): Promise<Models.VirtualMachineScaleSetVMsRedeployResponse>

- Defined in operations/virtualMachineScaleSetVMs.ts:253
Redeploys a virtual machine in a VM scale set.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmScaleSetName: string
  
  The name of the VM scale set.
- instanceId: string
  
  The instance ID of the virtual machine.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VirtualMachineScaleSetVMsRedeployResponse>

Promise<Models.VirtualMachineScaleSetVMsRedeployResponse>

reimage

reimage(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: msRest.RequestOptionsBase): Promise<Models.VirtualMachineScaleSetVMsReimageResponse>

- Defined in operations/virtualMachineScaleSetVMs.ts:38
Reimages (upgrade the operating system) a specific virtual machine in a VM scale set.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmScaleSetName: string
  
  The name of the VM scale set.
- instanceId: string
  
  The instance ID of the virtual machine.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VirtualMachineScaleSetVMsReimageResponse>

Promise<Models.VirtualMachineScaleSetVMsReimageResponse>

reimageAll

reimageAll(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: msRest.RequestOptionsBase): Promise<Models.VirtualMachineScaleSetVMsReimageAllResponse>

- Defined in operations/virtualMachineScaleSetVMs.ts:52
Allows you to re-image all the disks ( including data disks ) in the a VM scale set instance. This operation is only supported for managed disks.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmScaleSetName: string
  
  The name of the VM scale set.
- instanceId: string
  
  The instance ID of the virtual machine.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VirtualMachineScaleSetVMsReimageAllResponse>

Promise<Models.VirtualMachineScaleSetVMsReimageAllResponse>

restart

restart(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: msRest.RequestOptionsBase): Promise<Models.VirtualMachineScaleSetVMsRestartResponse>

- Defined in operations/virtualMachineScaleSetVMs.ts:227
Restarts a virtual machine in a VM scale set.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmScaleSetName: string
  
  The name of the VM scale set.
- instanceId: string
  
  The instance ID of the virtual machine.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VirtualMachineScaleSetVMsRestartResponse>

Promise<Models.VirtualMachineScaleSetVMsRestartResponse>

start

start(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: msRest.RequestOptionsBase): Promise<Models.VirtualMachineScaleSetVMsStartResponse>

- Defined in operations/virtualMachineScaleSetVMs.ts:240
Starts a virtual machine in a VM scale set.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmScaleSetName: string
  
  The name of the VM scale set.
- instanceId: string
  
  The instance ID of the virtual machine.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VirtualMachineScaleSetVMsStartResponse>

Promise<Models.VirtualMachineScaleSetVMsStartResponse>

update

update(resourceGroupName: string, vmScaleSetName: string, instanceId: string, parameters: VirtualMachineScaleSetVM, options?: msRest.RequestOptionsBase): Promise<Models.VirtualMachineScaleSetVMsUpdateResponse>

- Defined in operations/virtualMachineScaleSetVMs.ts:82
Updates a virtual machine of a VM scale set.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmScaleSetName: string
  
  The name of the VM scale set where the extension should be create or updated.
- instanceId: string
  
  The instance ID of the virtual machine.
- parameters: VirtualMachineScaleSetVM
  
  Parameters supplied to the Update Virtual Machine Scale Sets VM operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VirtualMachineScaleSetVMsUpdateResponse>

Promise<Models.VirtualMachineScaleSetVMsUpdateResponse>

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: ComputeManagementClientContext

Returns VirtualMachineScaleSetVMs

Methods

beginDeallocate

Parameters

resourceGroupName: string

vmScaleSetName: string

instanceId: string

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

beginDeleteMethod

Parameters

resourceGroupName: string

vmScaleSetName: string

instanceId: string

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

beginPerformMaintenance

Parameters

resourceGroupName: string

vmScaleSetName: string

instanceId: string

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

beginPowerOff

Parameters

resourceGroupName: string

vmScaleSetName: string

instanceId: string

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

beginRedeploy

Parameters

resourceGroupName: string

vmScaleSetName: string

instanceId: string

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

beginReimage

Parameters

resourceGroupName: string

vmScaleSetName: string

instanceId: string

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

beginReimageAll

Parameters

resourceGroupName: string

vmScaleSetName: string

instanceId: string

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

beginRestart

Parameters

resourceGroupName: string

vmScaleSetName: string

instanceId: string

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

beginStart

Parameters

resourceGroupName: string

vmScaleSetName: string

instanceId: string

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

beginUpdate

Parameters

resourceGroupName: string

vmScaleSetName: string

instanceId: string

parameters: VirtualMachineScaleSetVM

Optional options: msRest.RequestOptionsBase