VirtualMachineScaleSetVMs interface
Interface representing a VirtualMachineScaleSetVMs.
Methods
Method Details
beginApproveRollingUpgrade(string, string, string, VirtualMachineScaleSetVMsApproveRollingUpgradeOptionalParams)
Approve upgrade on deferred rolling upgrade for OS disk on a VM scale set instance.
function beginApproveRollingUpgrade(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsApproveRollingUpgradeOptionalParams): Promise<SimplePollerLike<OperationState<VirtualMachineScaleSetVMsApproveRollingUpgradeHeaders>, VirtualMachineScaleSetVMsApproveRollingUpgradeHeaders>>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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualMachineScaleSetVMsApproveRollingUpgradeHeaders>, VirtualMachineScaleSetVMsApproveRollingUpgradeHeaders>>
beginApproveRollingUpgradeAndWait(string, string, string, VirtualMachineScaleSetVMsApproveRollingUpgradeOptionalParams)
Approve upgrade on deferred rolling upgrade for OS disk on a VM scale set instance.
function beginApproveRollingUpgradeAndWait(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsApproveRollingUpgradeOptionalParams): Promise<VirtualMachineScaleSetVMsApproveRollingUpgradeHeaders>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.
The options parameters.
Returns
beginAttachDetachDataDisks(string, string, string, AttachDetachDataDisksRequest, VirtualMachineScaleSetVMsAttachDetachDataDisksOptionalParams)
Attach and detach data disks to/from a virtual machine in a VM scale set.
function beginAttachDetachDataDisks(resourceGroupName: string, vmScaleSetName: string, instanceId: string, parameters: AttachDetachDataDisksRequest, options?: VirtualMachineScaleSetVMsAttachDetachDataDisksOptionalParams): Promise<SimplePollerLike<OperationState<StorageProfile>, StorageProfile>>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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<StorageProfile>, StorageProfile>>
beginAttachDetachDataDisksAndWait(string, string, string, AttachDetachDataDisksRequest, VirtualMachineScaleSetVMsAttachDetachDataDisksOptionalParams)
Attach and detach data disks to/from a virtual machine in a VM scale set.
function beginAttachDetachDataDisksAndWait(resourceGroupName: string, vmScaleSetName: string, instanceId: string, parameters: AttachDetachDataDisksRequest, options?: VirtualMachineScaleSetVMsAttachDetachDataDisksOptionalParams): Promise<StorageProfile>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.
The options parameters.
Returns
Promise<StorageProfile>
beginDeallocate(string, string, string, VirtualMachineScaleSetVMsDeallocateOptionalParams)
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.
function beginDeallocate(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsDeallocateOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeallocateAndWait(string, string, string, VirtualMachineScaleSetVMsDeallocateOptionalParams)
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.
function beginDeallocateAndWait(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsDeallocateOptionalParams): Promise<void>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.
The options parameters.
Returns
Promise<void>
beginDelete(string, string, string, VirtualMachineScaleSetVMsDeleteOptionalParams)
Deletes a virtual machine from a VM scale set.
function beginDelete(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, VirtualMachineScaleSetVMsDeleteOptionalParams)
Deletes a virtual machine from a VM scale set.
function beginDeleteAndWait(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsDeleteOptionalParams): Promise<void>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.
The options parameters.
Returns
Promise<void>
beginPerformMaintenance(string, string, string, VirtualMachineScaleSetVMsPerformMaintenanceOptionalParams)
Performs maintenance on a virtual machine in a VM scale set.
function beginPerformMaintenance(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsPerformMaintenanceOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginPerformMaintenanceAndWait(string, string, string, VirtualMachineScaleSetVMsPerformMaintenanceOptionalParams)
Performs maintenance on a virtual machine in a VM scale set.
function beginPerformMaintenanceAndWait(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsPerformMaintenanceOptionalParams): Promise<void>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.
The options parameters.
Returns
Promise<void>
beginPowerOff(string, string, string, VirtualMachineScaleSetVMsPowerOffOptionalParams)
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.
function beginPowerOff(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsPowerOffOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginPowerOffAndWait(string, string, string, VirtualMachineScaleSetVMsPowerOffOptionalParams)
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.
function beginPowerOffAndWait(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsPowerOffOptionalParams): Promise<void>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.
The options parameters.
Returns
Promise<void>
beginRedeploy(string, string, string, VirtualMachineScaleSetVMsRedeployOptionalParams)
Shuts down the virtual machine in the virtual machine scale set, moves it to a new node, and powers it back on.
function beginRedeploy(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsRedeployOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginRedeployAndWait(string, string, string, VirtualMachineScaleSetVMsRedeployOptionalParams)
Shuts down the virtual machine in the virtual machine scale set, moves it to a new node, and powers it back on.
function beginRedeployAndWait(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsRedeployOptionalParams): Promise<void>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.
The options parameters.
Returns
Promise<void>
beginReimage(string, string, string, VirtualMachineScaleSetVMsReimageOptionalParams)
Reimages (upgrade the operating system) a specific virtual machine in a VM scale set.
function beginReimage(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsReimageOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginReimageAll(string, string, string, VirtualMachineScaleSetVMsReimageAllOptionalParams)
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.
function beginReimageAll(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsReimageAllOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginReimageAllAndWait(string, string, string, VirtualMachineScaleSetVMsReimageAllOptionalParams)
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.
function beginReimageAllAndWait(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsReimageAllOptionalParams): Promise<void>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.
The options parameters.
Returns
Promise<void>
beginReimageAndWait(string, string, string, VirtualMachineScaleSetVMsReimageOptionalParams)
Reimages (upgrade the operating system) a specific virtual machine in a VM scale set.
function beginReimageAndWait(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsReimageOptionalParams): Promise<void>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.
The options parameters.
Returns
Promise<void>
beginRestart(string, string, string, VirtualMachineScaleSetVMsRestartOptionalParams)
Restarts a virtual machine in a VM scale set.
function beginRestart(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsRestartOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginRestartAndWait(string, string, string, VirtualMachineScaleSetVMsRestartOptionalParams)
Restarts a virtual machine in a VM scale set.
function beginRestartAndWait(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsRestartOptionalParams): Promise<void>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.
The options parameters.
Returns
Promise<void>
beginRunCommand(string, string, string, RunCommandInput, VirtualMachineScaleSetVMsRunCommandOptionalParams)
Run command on a virtual machine in a VM scale set.
function beginRunCommand(resourceGroupName: string, vmScaleSetName: string, instanceId: string, parameters: RunCommandInput, options?: VirtualMachineScaleSetVMsRunCommandOptionalParams): Promise<SimplePollerLike<OperationState<RunCommandResult>, RunCommandResult>>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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<RunCommandResult>, RunCommandResult>>
beginRunCommandAndWait(string, string, string, RunCommandInput, VirtualMachineScaleSetVMsRunCommandOptionalParams)
Run command on a virtual machine in a VM scale set.
function beginRunCommandAndWait(resourceGroupName: string, vmScaleSetName: string, instanceId: string, parameters: RunCommandInput, options?: VirtualMachineScaleSetVMsRunCommandOptionalParams): Promise<RunCommandResult>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.
The options parameters.
Returns
Promise<RunCommandResult>
beginStart(string, string, string, VirtualMachineScaleSetVMsStartOptionalParams)
Starts a virtual machine in a VM scale set.
function beginStart(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsStartOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginStartAndWait(string, string, string, VirtualMachineScaleSetVMsStartOptionalParams)
Starts a virtual machine in a VM scale set.
function beginStartAndWait(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsStartOptionalParams): Promise<void>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.
The options parameters.
Returns
Promise<void>
beginUpdate(string, string, string, VirtualMachineScaleSetVM, VirtualMachineScaleSetVMsUpdateOptionalParams)
Updates a virtual machine of a VM scale set.
function beginUpdate(resourceGroupName: string, vmScaleSetName: string, instanceId: string, parameters: VirtualMachineScaleSetVM, options?: VirtualMachineScaleSetVMsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<VirtualMachineScaleSetVM>, VirtualMachineScaleSetVM>>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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualMachineScaleSetVM>, VirtualMachineScaleSetVM>>
beginUpdateAndWait(string, string, string, VirtualMachineScaleSetVM, VirtualMachineScaleSetVMsUpdateOptionalParams)
Updates a virtual machine of a VM scale set.
function beginUpdateAndWait(resourceGroupName: string, vmScaleSetName: string, instanceId: string, parameters: VirtualMachineScaleSetVM, options?: VirtualMachineScaleSetVMsUpdateOptionalParams): Promise<VirtualMachineScaleSetVM>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.
The options parameters.
Returns
Promise<VirtualMachineScaleSetVM>
get(string, string, string, VirtualMachineScaleSetVMsGetOptionalParams)
Gets a virtual machine from a VM scale set.
function get(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsGetOptionalParams): Promise<VirtualMachineScaleSetVM>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.
The options parameters.
Returns
Promise<VirtualMachineScaleSetVM>
getInstanceView(string, string, string, VirtualMachineScaleSetVMsGetInstanceViewOptionalParams)
Gets the status of a virtual machine from a VM scale set.
function getInstanceView(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsGetInstanceViewOptionalParams): Promise<VirtualMachineScaleSetVMInstanceView>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.
The options parameters.
Returns
Promise<VirtualMachineScaleSetVMInstanceView>
list(string, string, VirtualMachineScaleSetVMsListOptionalParams)
Gets a list of all virtual machines in a VM scale sets.
function list(resourceGroupName: string, virtualMachineScaleSetName: string, options?: VirtualMachineScaleSetVMsListOptionalParams): PagedAsyncIterableIterator<VirtualMachineScaleSetVM, VirtualMachineScaleSetVM[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group.
- virtualMachineScaleSetName
-
string
The name of the VM scale set.
The options parameters.
Returns
retrieveBootDiagnosticsData(string, string, string, VirtualMachineScaleSetVMsRetrieveBootDiagnosticsDataOptionalParams)
The operation to retrieve SAS URIs of boot diagnostic logs for a virtual machine in a VM scale set.
function retrieveBootDiagnosticsData(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsRetrieveBootDiagnosticsDataOptionalParams): Promise<RetrieveBootDiagnosticsDataResult>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.
The options parameters.
Returns
Promise<RetrieveBootDiagnosticsDataResult>
simulateEviction(string, string, string, VirtualMachineScaleSetVMsSimulateEvictionOptionalParams)
The operation to simulate the eviction of spot virtual machine in a VM scale set.
function simulateEviction(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsSimulateEvictionOptionalParams): Promise<void>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.
The options parameters.
Returns
Promise<void>