Package version:

Interface VirtualMachineScaleSetVMs

Interface representing a VirtualMachineScaleSetVMs.

interface VirtualMachineScaleSetVMs {
    beginApproveRollingUpgrade(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsApproveRollingUpgradeOptionalParams): Promise<SimplePollerLike<OperationState<VirtualMachineScaleSetVMsApproveRollingUpgradeHeaders>, VirtualMachineScaleSetVMsApproveRollingUpgradeHeaders>>;
    beginApproveRollingUpgradeAndWait(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsApproveRollingUpgradeOptionalParams): Promise<VirtualMachineScaleSetVMsApproveRollingUpgradeHeaders>;
    beginAttachDetachDataDisks(resourceGroupName: string, vmScaleSetName: string, instanceId: string, parameters: AttachDetachDataDisksRequest, options?: VirtualMachineScaleSetVMsAttachDetachDataDisksOptionalParams): Promise<SimplePollerLike<OperationState<StorageProfile>, StorageProfile>>;
    beginAttachDetachDataDisksAndWait(resourceGroupName: string, vmScaleSetName: string, instanceId: string, parameters: AttachDetachDataDisksRequest, options?: VirtualMachineScaleSetVMsAttachDetachDataDisksOptionalParams): Promise<StorageProfile>;
    beginDeallocate(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsDeallocateOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginDeallocateAndWait(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsDeallocateOptionalParams): Promise<void>;
    beginDelete(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginDeleteAndWait(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsDeleteOptionalParams): Promise<void>;
    beginPerformMaintenance(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsPerformMaintenanceOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginPerformMaintenanceAndWait(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsPerformMaintenanceOptionalParams): Promise<void>;
    beginPowerOff(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsPowerOffOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginPowerOffAndWait(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsPowerOffOptionalParams): Promise<void>;
    beginRedeploy(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsRedeployOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginRedeployAndWait(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsRedeployOptionalParams): Promise<void>;
    beginReimage(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsReimageOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginReimageAll(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsReimageAllOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginReimageAllAndWait(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsReimageAllOptionalParams): Promise<void>;
    beginReimageAndWait(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsReimageOptionalParams): Promise<void>;
    beginRestart(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsRestartOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginRestartAndWait(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsRestartOptionalParams): Promise<void>;
    beginRunCommand(resourceGroupName: string, vmScaleSetName: string, instanceId: string, parameters: RunCommandInput, options?: VirtualMachineScaleSetVMsRunCommandOptionalParams): Promise<SimplePollerLike<OperationState<RunCommandResult>, RunCommandResult>>;
    beginRunCommandAndWait(resourceGroupName: string, vmScaleSetName: string, instanceId: string, parameters: RunCommandInput, options?: VirtualMachineScaleSetVMsRunCommandOptionalParams): Promise<RunCommandResult>;
    beginStart(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsStartOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginStartAndWait(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsStartOptionalParams): Promise<void>;
    beginUpdate(resourceGroupName: string, vmScaleSetName: string, instanceId: string, parameters: VirtualMachineScaleSetVM, options?: VirtualMachineScaleSetVMsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<VirtualMachineScaleSetVM>, VirtualMachineScaleSetVM>>;
    beginUpdateAndWait(resourceGroupName: string, vmScaleSetName: string, instanceId: string, parameters: VirtualMachineScaleSetVM, options?: VirtualMachineScaleSetVMsUpdateOptionalParams): Promise<VirtualMachineScaleSetVM>;
    get(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsGetOptionalParams): Promise<VirtualMachineScaleSetVM>;
    getInstanceView(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsGetInstanceViewOptionalParams): Promise<VirtualMachineScaleSetVMInstanceView>;
    list(resourceGroupName: string, virtualMachineScaleSetName: string, options?: VirtualMachineScaleSetVMsListOptionalParams): PagedAsyncIterableIterator<VirtualMachineScaleSetVM>;
    retrieveBootDiagnosticsData(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsRetrieveBootDiagnosticsDataOptionalParams): Promise<RetrieveBootDiagnosticsDataResult>;
    simulateEviction(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsSimulateEvictionOptionalParams): Promise<void>;
}

Methods

beginApproveRollingUpgrade

beginApproveRollingUpgrade(resourceGroupName, vmScaleSetName, instanceId, options?): Promise<SimplePollerLike<OperationState<VirtualMachineScaleSetVMsApproveRollingUpgradeHeaders>, VirtualMachineScaleSetVMsApproveRollingUpgradeHeaders>>
Approve upgrade on deferred rolling upgrade for OS disk on a VM scale set instance.
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.
- Optionaloptions: VirtualMachineScaleSetVMsApproveRollingUpgradeOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<VirtualMachineScaleSetVMsApproveRollingUpgradeHeaders>, VirtualMachineScaleSetVMsApproveRollingUpgradeHeaders>>
- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:117

beginApproveRollingUpgradeAndWait

beginApproveRollingUpgradeAndWait(resourceGroupName, vmScaleSetName, instanceId, options?): Promise<VirtualMachineScaleSetVMsApproveRollingUpgradeHeaders>
Approve upgrade on deferred rolling upgrade for OS disk on a VM scale set instance.
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.
- Optionaloptions: VirtualMachineScaleSetVMsApproveRollingUpgradeOptionalParams
  The options parameters.
Returns Promise<VirtualMachineScaleSetVMsApproveRollingUpgradeHeaders>
- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:135

beginAttachDetachDataDisks

beginAttachDetachDataDisks(resourceGroupName, vmScaleSetName, instanceId, parameters, options?): Promise<SimplePollerLike<OperationState<StorageProfile>, StorageProfile>>
Attach and detach data disks to/from 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.
- parameters: AttachDetachDataDisksRequest
  Parameters supplied to the attach and detach data disks operation on a Virtual Machine Scale Sets VM.
- Optionaloptions: VirtualMachineScaleSetVMsAttachDetachDataDisksOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<StorageProfile>, StorageProfile>>
- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:431

beginAttachDetachDataDisksAndWait

beginAttachDetachDataDisksAndWait(resourceGroupName, vmScaleSetName, instanceId, parameters, options?): Promise<StorageProfile>
Attach and detach data disks to/from 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.
- parameters: AttachDetachDataDisksRequest
  Parameters supplied to the attach and detach data disks operation on a Virtual Machine Scale Sets VM.
- Optionaloptions: VirtualMachineScaleSetVMsAttachDetachDataDisksOptionalParams
  The options parameters.
Returns Promise<StorageProfile>
- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:452

beginDeallocate

beginDeallocate(resourceGroupName, vmScaleSetName, instanceId, options?): Promise<SimplePollerLike<OperationState<void>, void>>
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.
- Optionaloptions: VirtualMachineScaleSetVMsDeallocateOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:150

beginDeallocateAndWait

beginDeallocateAndWait(resourceGroupName, vmScaleSetName, instanceId, options?): Promise<void>
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.
- Optionaloptions: VirtualMachineScaleSetVMsDeallocateOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:165

beginDelete

beginDelete(resourceGroupName, vmScaleSetName, instanceId, options?): Promise<SimplePollerLike<OperationState<void>, void>>
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.
- Optionaloptions: VirtualMachineScaleSetVMsDeleteOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:213

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName, vmScaleSetName, instanceId, options?): Promise<void>
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.
- Optionaloptions: VirtualMachineScaleSetVMsDeleteOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:226

beginPerformMaintenance

beginPerformMaintenance(resourceGroupName, vmScaleSetName, instanceId, options?): Promise<SimplePollerLike<OperationState<void>, void>>
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.
- Optionaloptions: VirtualMachineScaleSetVMsPerformMaintenanceOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:390

beginPerformMaintenanceAndWait

beginPerformMaintenanceAndWait(resourceGroupName, vmScaleSetName, instanceId, options?): Promise<void>
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.
- Optionaloptions: VirtualMachineScaleSetVMsPerformMaintenanceOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:403

beginPowerOff

beginPowerOff(resourceGroupName, vmScaleSetName, instanceId, options?): Promise<SimplePollerLike<OperationState<void>, void>>
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. Additionally, this operation is not allowed on a virtual machine that is being deallocated or already has been 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.
- Optionaloptions: VirtualMachineScaleSetVMsPowerOffOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:268

beginPowerOffAndWait

beginPowerOffAndWait(resourceGroupName, vmScaleSetName, instanceId, options?): Promise<void>
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. Additionally, this operation is not allowed on a virtual machine that is being deallocated or already has been 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.
- Optionaloptions: VirtualMachineScaleSetVMsPowerOffOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:284

beginRedeploy

beginRedeploy(resourceGroupName, vmScaleSetName, instanceId, options?): Promise<SimplePollerLike<OperationState<void>, void>>
Shuts down the virtual machine in the virtual machine scale set, moves it to a new node, and powers it back on.
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.
- Optionaloptions: VirtualMachineScaleSetVMsRedeployOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:350

beginRedeployAndWait

beginRedeployAndWait(resourceGroupName, vmScaleSetName, instanceId, options?): Promise<void>
Shuts down the virtual machine in the virtual machine scale set, moves it to a new node, and powers it back on.
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.
- Optionaloptions: VirtualMachineScaleSetVMsRedeployOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:364

beginReimage

beginReimage(resourceGroupName, vmScaleSetName, instanceId, options?): Promise<SimplePollerLike<OperationState<void>, void>>
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.
- Optionaloptions: VirtualMachineScaleSetVMsReimageOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:63

beginReimageAll

beginReimageAll(resourceGroupName, vmScaleSetName, instanceId, options?): Promise<SimplePollerLike<OperationState<void>, void>>
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.
- Optionaloptions: VirtualMachineScaleSetVMsReimageAllOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:90

beginReimageAllAndWait

beginReimageAllAndWait(resourceGroupName, vmScaleSetName, instanceId, options?): Promise<void>
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.
- Optionaloptions: VirtualMachineScaleSetVMsReimageAllOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:104

beginReimageAndWait

beginReimageAndWait(resourceGroupName, vmScaleSetName, instanceId, options?): Promise<void>
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.
- Optionaloptions: VirtualMachineScaleSetVMsReimageOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:76

beginRestart

beginRestart(resourceGroupName, vmScaleSetName, instanceId, options?): Promise<SimplePollerLike<OperationState<void>, void>>
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.
- Optionaloptions: VirtualMachineScaleSetVMsRestartOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:297

beginRestartAndWait

beginRestartAndWait(resourceGroupName, vmScaleSetName, instanceId, options?): Promise<void>
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.
- Optionaloptions: VirtualMachineScaleSetVMsRestartOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:310

beginRunCommand

beginRunCommand(resourceGroupName, vmScaleSetName, instanceId, parameters, options?): Promise<SimplePollerLike<OperationState<RunCommandResult>, RunCommandResult>>
Run command 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.
- parameters: RunCommandInput
  Parameters supplied to the Run command operation.
- Optionaloptions: VirtualMachineScaleSetVMsRunCommandOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<RunCommandResult>, RunCommandResult>>
- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:467

beginRunCommandAndWait

beginRunCommandAndWait(resourceGroupName, vmScaleSetName, instanceId, parameters, options?): Promise<RunCommandResult>
Run command 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.
- parameters: RunCommandInput
  Parameters supplied to the Run command operation.
- Optionaloptions: VirtualMachineScaleSetVMsRunCommandOptionalParams
  The options parameters.
Returns Promise<RunCommandResult>
- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:487

beginStart

beginStart(resourceGroupName, vmScaleSetName, instanceId, options?): Promise<SimplePollerLike<OperationState<void>, void>>
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.
- Optionaloptions: VirtualMachineScaleSetVMsStartOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:323

beginStartAndWait

beginStartAndWait(resourceGroupName, vmScaleSetName, instanceId, options?): Promise<void>
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.
- Optionaloptions: VirtualMachineScaleSetVMsStartOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:336

beginUpdate

beginUpdate(resourceGroupName, vmScaleSetName, instanceId, parameters, options?): Promise<SimplePollerLike<OperationState<VirtualMachineScaleSetVM>, VirtualMachineScaleSetVM>>
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.
- Optionaloptions: VirtualMachineScaleSetVMsUpdateOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<VirtualMachineScaleSetVM>, VirtualMachineScaleSetVM>>
- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:179

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName, vmScaleSetName, instanceId, parameters, options?): Promise<VirtualMachineScaleSetVM>
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.
- Optionaloptions: VirtualMachineScaleSetVMsUpdateOptionalParams
  The options parameters.
Returns Promise<VirtualMachineScaleSetVM>
- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:199

get

get(resourceGroupName, vmScaleSetName, instanceId, options?): Promise<VirtualMachineScaleSetVM>
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.
- Optionaloptions: VirtualMachineScaleSetVMsGetOptionalParams
  The options parameters.
Returns Promise<VirtualMachineScaleSetVM>
- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:239

getInstanceView

getInstanceView(resourceGroupName, vmScaleSetName, instanceId, options?): Promise<VirtualMachineScaleSetVMInstanceView>
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.
- Optionaloptions: VirtualMachineScaleSetVMsGetInstanceViewOptionalParams
  The options parameters.
Returns Promise<VirtualMachineScaleSetVMInstanceView>
- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:252

list

list(resourceGroupName, virtualMachineScaleSetName, options?): PagedAsyncIterableIterator<VirtualMachineScaleSetVM>
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.
- Optionaloptions: VirtualMachineScaleSetVMsListOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<VirtualMachineScaleSetVM>
- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:51

retrieveBootDiagnosticsData

retrieveBootDiagnosticsData(resourceGroupName, vmScaleSetName, instanceId, options?): Promise<RetrieveBootDiagnosticsDataResult>
The operation to retrieve SAS URIs of boot diagnostic logs for 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.
- Optionaloptions: VirtualMachineScaleSetVMsRetrieveBootDiagnosticsDataOptionalParams
  The options parameters.
Returns Promise<RetrieveBootDiagnosticsDataResult>
- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:377

simulateEviction

simulateEviction(resourceGroupName, vmScaleSetName, instanceId, options?): Promise<void>
The operation to simulate the eviction of spot 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.
- Optionaloptions: VirtualMachineScaleSetVMsSimulateEvictionOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:416

Interface VirtualMachineScaleSetVMs

Index

Methods

Methods

beginApproveRollingUpgrade

Parameters

Returns Promise<SimplePollerLike<OperationState<VirtualMachineScaleSetVMsApproveRollingUpgradeHeaders>, VirtualMachineScaleSetVMsApproveRollingUpgradeHeaders>>

beginApproveRollingUpgradeAndWait

Parameters

Returns Promise<VirtualMachineScaleSetVMsApproveRollingUpgradeHeaders>

beginAttachDetachDataDisks

Parameters

Returns Promise<SimplePollerLike<OperationState<StorageProfile>, StorageProfile>>

beginAttachDetachDataDisksAndWait

Parameters

Returns Promise<StorageProfile>

beginDeallocate

Parameters

Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginDeallocateAndWait

Parameters

Returns Promise<void>

beginDelete

Parameters

Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Parameters

Returns Promise<void>

beginPerformMaintenance

Parameters

Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginPerformMaintenanceAndWait

Parameters

Returns Promise<void>

beginPowerOff

Parameters

Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginPowerOffAndWait

Parameters

Returns Promise<void>

beginRedeploy

Parameters

Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginRedeployAndWait

Parameters

Returns Promise<void>

beginReimage

Parameters

Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginReimageAll

Parameters

Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginReimageAllAndWait

Parameters

Returns Promise<void>

beginReimageAndWait

Parameters

Returns Promise<void>

beginRestart

Parameters

Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginRestartAndWait

Parameters

Returns Promise<void>

beginRunCommand

Parameters

Returns Promise<SimplePollerLike<OperationState<RunCommandResult>, RunCommandResult>>

beginRunCommandAndWait

Parameters

Returns Promise<RunCommandResult>

beginStart

Parameters

Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginStartAndWait

Parameters

Returns Promise<void>

beginUpdate

Parameters

Returns Promise<SimplePollerLike<OperationState<VirtualMachineScaleSetVM>, VirtualMachineScaleSetVM>>

beginUpdateAndWait