VirtualMachineScaleSets interface
Interface representing a VirtualMachineScaleSets.
Methods
| begin |
Create or update a VM scale set. |
| begin |
Create or update a VM scale set. |
| begin |
Deallocates specific virtual machines in a VM scale set. Shuts down the virtual machines and releases the compute resources. You are not billed for the compute resources that this virtual machine scale set deallocates. |
| begin |
Deallocates specific virtual machines in a VM scale set. Shuts down the virtual machines and releases the compute resources. You are not billed for the compute resources that this virtual machine scale set deallocates. |
| begin |
Deletes a VM scale set. |
| begin |
Deletes a VM scale set. |
| begin |
Deletes virtual machines in a VM scale set. |
| begin |
Deletes virtual machines in a VM scale set. |
| begin |
Perform maintenance on one or more virtual machines in a VM scale set. Operation on instances which are not eligible for perform maintenance will be failed. Please refer to best practices for more details: https://docs.microsoft.com/en-us/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-maintenance-notifications |
| begin |
Perform maintenance on one or more virtual machines in a VM scale set. Operation on instances which are not eligible for perform maintenance will be failed. Please refer to best practices for more details: https://docs.microsoft.com/en-us/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-maintenance-notifications |
| begin |
Power off (stop) one or more virtual machines 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. |
| begin |
Power off (stop) one or more virtual machines 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. |
| begin |
Shuts down all the virtual machines in the virtual machine scale set, moves them to a new node, and powers them back on. |
| begin |
Shuts down all the virtual machines in the virtual machine scale set, moves them to a new node, and powers them back on. |
| begin |
Reimages (upgrade the operating system) one or more virtual machines in a VM scale set which don't have a ephemeral OS disk, for virtual machines who have a ephemeral OS disk the virtual machine is reset to initial state. |
| begin |
Reimages all the disks ( including data disks ) in the virtual machines in a VM scale set. This operation is only supported for managed disks. |
| begin |
Reimages all the disks ( including data disks ) in the virtual machines in a VM scale set. This operation is only supported for managed disks. |
| begin |
Reimages (upgrade the operating system) one or more virtual machines in a VM scale set which don't have a ephemeral OS disk, for virtual machines who have a ephemeral OS disk the virtual machine is reset to initial state. |
| begin |
Restarts one or more virtual machines in a VM scale set. |
| begin |
Restarts one or more virtual machines in a VM scale set. |
| begin |
Changes ServiceState property for a given service |
| begin |
Changes ServiceState property for a given service |
| begin |
Starts one or more virtual machines in a VM scale set. |
| begin |
Starts one or more virtual machines in a VM scale set. |
| begin |
Update a VM scale set. |
| begin |
Update a VM scale set. |
| begin |
Upgrades one or more virtual machines to the latest SKU set in the VM scale set model. |
| begin |
Upgrades one or more virtual machines to the latest SKU set in the VM scale set model. |
| convert |
Converts SinglePlacementGroup property to false for a existing virtual machine scale set. |
| force |
Manual platform update domain walk to update virtual machines in a service fabric virtual machine scale set. |
| get(string, string, Virtual |
Display information about a virtual machine scale set. |
| get |
Gets the status of a VM scale set instance. |
| list(string, Virtual |
Gets a list of all VM scale sets under a resource group. |
| list |
Gets a list of all VM Scale Sets in the subscription, regardless of the associated resource group. Use nextLink property in the response to get the next page of VM Scale Sets. Do this till nextLink is null to fetch all the VM Scale Sets. |
| list |
Gets list of OS upgrades on a VM scale set instance. |
| list |
Gets a list of SKUs available for your VM scale set, including the minimum and maximum VM instances allowed for each SKU. |
Method Details
beginCreateOrUpdate(string, string, VirtualMachineScaleSet, VirtualMachineScaleSetsCreateOrUpdateOptionalParams)
Create or update a VM scale set.
function beginCreateOrUpdate(resourceGroupName: string, vmScaleSetName: string, parameters: VirtualMachineScaleSet, options?: VirtualMachineScaleSetsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<VirtualMachineScaleSet>, VirtualMachineScaleSet>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- vmScaleSetName
-
string
The name of the VM scale set to create or update.
- parameters
- VirtualMachineScaleSet
The scale set object.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<VirtualMachineScaleSet>, VirtualMachineScaleSet>>
beginCreateOrUpdateAndWait(string, string, VirtualMachineScaleSet, VirtualMachineScaleSetsCreateOrUpdateOptionalParams)
Create or update a VM scale set.
function beginCreateOrUpdateAndWait(resourceGroupName: string, vmScaleSetName: string, parameters: VirtualMachineScaleSet, options?: VirtualMachineScaleSetsCreateOrUpdateOptionalParams): Promise<VirtualMachineScaleSet>Parameters
- resourceGroupName
-
string
The name of the resource group.
- vmScaleSetName
-
string
The name of the VM scale set to create or update.
- parameters
- VirtualMachineScaleSet
The scale set object.
The options parameters.
Returns
Promise<VirtualMachineScaleSet>
beginDeallocate(string, string, VirtualMachineScaleSetsDeallocateOptionalParams)
Deallocates specific virtual machines in a VM scale set. Shuts down the virtual machines and releases the compute resources. You are not billed for the compute resources that this virtual machine scale set deallocates.
function beginDeallocate(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsDeallocateOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- vmScaleSetName
-
string
The name of the VM scale set.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeallocateAndWait(string, string, VirtualMachineScaleSetsDeallocateOptionalParams)
Deallocates specific virtual machines in a VM scale set. Shuts down the virtual machines and releases the compute resources. You are not billed for the compute resources that this virtual machine scale set deallocates.
function beginDeallocateAndWait(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsDeallocateOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- vmScaleSetName
-
string
The name of the VM scale set.
The options parameters.
Returns
Promise<void>
beginDelete(string, string, VirtualMachineScaleSetsDeleteOptionalParams)
Deletes a VM scale set.
function beginDelete(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- vmScaleSetName
-
string
The name of the VM scale set.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeleteAndWait(string, string, VirtualMachineScaleSetsDeleteOptionalParams)
Deletes a VM scale set.
function beginDeleteAndWait(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- vmScaleSetName
-
string
The name of the VM scale set.
The options parameters.
Returns
Promise<void>
beginDeleteInstances(string, string, VirtualMachineScaleSetVMInstanceRequiredIDs, VirtualMachineScaleSetsDeleteInstancesOptionalParams)
Deletes virtual machines in a VM scale set.
function beginDeleteInstances(resourceGroupName: string, vmScaleSetName: string, vmInstanceIDs: VirtualMachineScaleSetVMInstanceRequiredIDs, options?: VirtualMachineScaleSetsDeleteInstancesOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- vmScaleSetName
-
string
The name of the VM scale set.
- vmInstanceIDs
- VirtualMachineScaleSetVMInstanceRequiredIDs
A list of virtual machine instance IDs from the VM scale set.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeleteInstancesAndWait(string, string, VirtualMachineScaleSetVMInstanceRequiredIDs, VirtualMachineScaleSetsDeleteInstancesOptionalParams)
Deletes virtual machines in a VM scale set.
function beginDeleteInstancesAndWait(resourceGroupName: string, vmScaleSetName: string, vmInstanceIDs: VirtualMachineScaleSetVMInstanceRequiredIDs, options?: VirtualMachineScaleSetsDeleteInstancesOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- vmScaleSetName
-
string
The name of the VM scale set.
- vmInstanceIDs
- VirtualMachineScaleSetVMInstanceRequiredIDs
A list of virtual machine instance IDs from the VM scale set.
The options parameters.
Returns
Promise<void>
beginPerformMaintenance(string, string, VirtualMachineScaleSetsPerformMaintenanceOptionalParams)
Perform maintenance on one or more virtual machines in a VM scale set. Operation on instances which are not eligible for perform maintenance will be failed. Please refer to best practices for more details: https://docs.microsoft.com/en-us/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-maintenance-notifications
function beginPerformMaintenance(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsPerformMaintenanceOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- vmScaleSetName
-
string
The name of the VM scale set.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginPerformMaintenanceAndWait(string, string, VirtualMachineScaleSetsPerformMaintenanceOptionalParams)
Perform maintenance on one or more virtual machines in a VM scale set. Operation on instances which are not eligible for perform maintenance will be failed. Please refer to best practices for more details: https://docs.microsoft.com/en-us/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-maintenance-notifications
function beginPerformMaintenanceAndWait(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsPerformMaintenanceOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- vmScaleSetName
-
string
The name of the VM scale set.
The options parameters.
Returns
Promise<void>
beginPowerOff(string, string, VirtualMachineScaleSetsPowerOffOptionalParams)
Power off (stop) one or more virtual machines 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, options?: VirtualMachineScaleSetsPowerOffOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- vmScaleSetName
-
string
The name of the VM scale set.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginPowerOffAndWait(string, string, VirtualMachineScaleSetsPowerOffOptionalParams)
Power off (stop) one or more virtual machines 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, options?: VirtualMachineScaleSetsPowerOffOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- vmScaleSetName
-
string
The name of the VM scale set.
The options parameters.
Returns
Promise<void>
beginRedeploy(string, string, VirtualMachineScaleSetsRedeployOptionalParams)
Shuts down all the virtual machines in the virtual machine scale set, moves them to a new node, and powers them back on.
function beginRedeploy(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsRedeployOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- vmScaleSetName
-
string
The name of the VM scale set.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginRedeployAndWait(string, string, VirtualMachineScaleSetsRedeployOptionalParams)
Shuts down all the virtual machines in the virtual machine scale set, moves them to a new node, and powers them back on.
function beginRedeployAndWait(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsRedeployOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- vmScaleSetName
-
string
The name of the VM scale set.
The options parameters.
Returns
Promise<void>
beginReimage(string, string, VirtualMachineScaleSetsReimageOptionalParams)
Reimages (upgrade the operating system) one or more virtual machines in a VM scale set which don't have a ephemeral OS disk, for virtual machines who have a ephemeral OS disk the virtual machine is reset to initial state.
function beginReimage(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsReimageOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- vmScaleSetName
-
string
The name of the VM scale set.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginReimageAll(string, string, VirtualMachineScaleSetsReimageAllOptionalParams)
Reimages all the disks ( including data disks ) in the virtual machines in a VM scale set. This operation is only supported for managed disks.
function beginReimageAll(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsReimageAllOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- vmScaleSetName
-
string
The name of the VM scale set.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginReimageAllAndWait(string, string, VirtualMachineScaleSetsReimageAllOptionalParams)
Reimages all the disks ( including data disks ) in the virtual machines in a VM scale set. This operation is only supported for managed disks.
function beginReimageAllAndWait(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsReimageAllOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- vmScaleSetName
-
string
The name of the VM scale set.
The options parameters.
Returns
Promise<void>
beginReimageAndWait(string, string, VirtualMachineScaleSetsReimageOptionalParams)
Reimages (upgrade the operating system) one or more virtual machines in a VM scale set which don't have a ephemeral OS disk, for virtual machines who have a ephemeral OS disk the virtual machine is reset to initial state.
function beginReimageAndWait(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsReimageOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- vmScaleSetName
-
string
The name of the VM scale set.
The options parameters.
Returns
Promise<void>
beginRestart(string, string, VirtualMachineScaleSetsRestartOptionalParams)
Restarts one or more virtual machines in a VM scale set.
function beginRestart(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsRestartOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- vmScaleSetName
-
string
The name of the VM scale set.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginRestartAndWait(string, string, VirtualMachineScaleSetsRestartOptionalParams)
Restarts one or more virtual machines in a VM scale set.
function beginRestartAndWait(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsRestartOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- vmScaleSetName
-
string
The name of the VM scale set.
The options parameters.
Returns
Promise<void>
beginSetOrchestrationServiceState(string, string, OrchestrationServiceStateInput, VirtualMachineScaleSetsSetOrchestrationServiceStateOptionalParams)
Changes ServiceState property for a given service
function beginSetOrchestrationServiceState(resourceGroupName: string, vmScaleSetName: string, parameters: OrchestrationServiceStateInput, options?: VirtualMachineScaleSetsSetOrchestrationServiceStateOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- vmScaleSetName
-
string
The name of the virtual machine scale set to create or update.
- parameters
- OrchestrationServiceStateInput
The input object for SetOrchestrationServiceState API.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginSetOrchestrationServiceStateAndWait(string, string, OrchestrationServiceStateInput, VirtualMachineScaleSetsSetOrchestrationServiceStateOptionalParams)
Changes ServiceState property for a given service
function beginSetOrchestrationServiceStateAndWait(resourceGroupName: string, vmScaleSetName: string, parameters: OrchestrationServiceStateInput, options?: VirtualMachineScaleSetsSetOrchestrationServiceStateOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- vmScaleSetName
-
string
The name of the virtual machine scale set to create or update.
- parameters
- OrchestrationServiceStateInput
The input object for SetOrchestrationServiceState API.
The options parameters.
Returns
Promise<void>
beginStart(string, string, VirtualMachineScaleSetsStartOptionalParams)
Starts one or more virtual machines in a VM scale set.
function beginStart(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsStartOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- vmScaleSetName
-
string
The name of the VM scale set.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginStartAndWait(string, string, VirtualMachineScaleSetsStartOptionalParams)
Starts one or more virtual machines in a VM scale set.
function beginStartAndWait(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsStartOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- vmScaleSetName
-
string
The name of the VM scale set.
The options parameters.
Returns
Promise<void>
beginUpdate(string, string, VirtualMachineScaleSetUpdate, VirtualMachineScaleSetsUpdateOptionalParams)
Update a VM scale set.
function beginUpdate(resourceGroupName: string, vmScaleSetName: string, parameters: VirtualMachineScaleSetUpdate, options?: VirtualMachineScaleSetsUpdateOptionalParams): Promise<PollerLike<PollOperationState<VirtualMachineScaleSet>, VirtualMachineScaleSet>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- vmScaleSetName
-
string
The name of the VM scale set to create or update.
- parameters
- VirtualMachineScaleSetUpdate
The scale set object.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<VirtualMachineScaleSet>, VirtualMachineScaleSet>>
beginUpdateAndWait(string, string, VirtualMachineScaleSetUpdate, VirtualMachineScaleSetsUpdateOptionalParams)
Update a VM scale set.
function beginUpdateAndWait(resourceGroupName: string, vmScaleSetName: string, parameters: VirtualMachineScaleSetUpdate, options?: VirtualMachineScaleSetsUpdateOptionalParams): Promise<VirtualMachineScaleSet>Parameters
- resourceGroupName
-
string
The name of the resource group.
- vmScaleSetName
-
string
The name of the VM scale set to create or update.
- parameters
- VirtualMachineScaleSetUpdate
The scale set object.
The options parameters.
Returns
Promise<VirtualMachineScaleSet>
beginUpdateInstances(string, string, VirtualMachineScaleSetVMInstanceRequiredIDs, VirtualMachineScaleSetsUpdateInstancesOptionalParams)
Upgrades one or more virtual machines to the latest SKU set in the VM scale set model.
function beginUpdateInstances(resourceGroupName: string, vmScaleSetName: string, vmInstanceIDs: VirtualMachineScaleSetVMInstanceRequiredIDs, options?: VirtualMachineScaleSetsUpdateInstancesOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- vmScaleSetName
-
string
The name of the VM scale set.
- vmInstanceIDs
- VirtualMachineScaleSetVMInstanceRequiredIDs
A list of virtual machine instance IDs from the VM scale set.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginUpdateInstancesAndWait(string, string, VirtualMachineScaleSetVMInstanceRequiredIDs, VirtualMachineScaleSetsUpdateInstancesOptionalParams)
Upgrades one or more virtual machines to the latest SKU set in the VM scale set model.
function beginUpdateInstancesAndWait(resourceGroupName: string, vmScaleSetName: string, vmInstanceIDs: VirtualMachineScaleSetVMInstanceRequiredIDs, options?: VirtualMachineScaleSetsUpdateInstancesOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- vmScaleSetName
-
string
The name of the VM scale set.
- vmInstanceIDs
- VirtualMachineScaleSetVMInstanceRequiredIDs
A list of virtual machine instance IDs from the VM scale set.
The options parameters.
Returns
Promise<void>
convertToSinglePlacementGroup(string, string, VMScaleSetConvertToSinglePlacementGroupInput, VirtualMachineScaleSetsConvertToSinglePlacementGroupOptionalParams)
Converts SinglePlacementGroup property to false for a existing virtual machine scale set.
function convertToSinglePlacementGroup(resourceGroupName: string, vmScaleSetName: string, parameters: VMScaleSetConvertToSinglePlacementGroupInput, options?: VirtualMachineScaleSetsConvertToSinglePlacementGroupOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- vmScaleSetName
-
string
The name of the virtual machine scale set to create or update.
- parameters
- VMScaleSetConvertToSinglePlacementGroupInput
The input object for ConvertToSinglePlacementGroup API.
The options parameters.
Returns
Promise<void>
forceRecoveryServiceFabricPlatformUpdateDomainWalk(string, string, number, VirtualMachineScaleSetsForceRecoveryServiceFabricPlatformUpdateDomainWalkOptionalParams)
Manual platform update domain walk to update virtual machines in a service fabric virtual machine scale set.
function forceRecoveryServiceFabricPlatformUpdateDomainWalk(resourceGroupName: string, vmScaleSetName: string, platformUpdateDomain: number, options?: VirtualMachineScaleSetsForceRecoveryServiceFabricPlatformUpdateDomainWalkOptionalParams): Promise<RecoveryWalkResponse>Parameters
- resourceGroupName
-
string
The name of the resource group.
- vmScaleSetName
-
string
The name of the VM scale set.
- platformUpdateDomain
-
number
The platform update domain for which a manual recovery walk is requested
The options parameters.
Returns
Promise<RecoveryWalkResponse>
get(string, string, VirtualMachineScaleSetsGetOptionalParams)
Display information about a virtual machine scale set.
function get(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsGetOptionalParams): Promise<VirtualMachineScaleSet>Parameters
- resourceGroupName
-
string
The name of the resource group.
- vmScaleSetName
-
string
The name of the VM scale set.
The options parameters.
Returns
Promise<VirtualMachineScaleSet>
getInstanceView(string, string, VirtualMachineScaleSetsGetInstanceViewOptionalParams)
Gets the status of a VM scale set instance.
function getInstanceView(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsGetInstanceViewOptionalParams): Promise<VirtualMachineScaleSetInstanceView>Parameters
- resourceGroupName
-
string
The name of the resource group.
- vmScaleSetName
-
string
The name of the VM scale set.
The options parameters.
Returns
Promise<VirtualMachineScaleSetInstanceView>
list(string, VirtualMachineScaleSetsListOptionalParams)
Gets a list of all VM scale sets under a resource group.
function list(resourceGroupName: string, options?: VirtualMachineScaleSetsListOptionalParams): PagedAsyncIterableIterator<VirtualMachineScaleSet, VirtualMachineScaleSet[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group.
The options parameters.
Returns
listAll(VirtualMachineScaleSetsListAllOptionalParams)
Gets a list of all VM Scale Sets in the subscription, regardless of the associated resource group. Use nextLink property in the response to get the next page of VM Scale Sets. Do this till nextLink is null to fetch all the VM Scale Sets.
function listAll(options?: VirtualMachineScaleSetsListAllOptionalParams): PagedAsyncIterableIterator<VirtualMachineScaleSet, VirtualMachineScaleSet[], PageSettings>Parameters
The options parameters.
Returns
listOSUpgradeHistory(string, string, VirtualMachineScaleSetsGetOSUpgradeHistoryOptionalParams)
Gets list of OS upgrades on a VM scale set instance.
function listOSUpgradeHistory(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsGetOSUpgradeHistoryOptionalParams): PagedAsyncIterableIterator<UpgradeOperationHistoricalStatusInfo, UpgradeOperationHistoricalStatusInfo[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group.
- vmScaleSetName
-
string
The name of the VM scale set.
The options parameters.
Returns
listSkus(string, string, VirtualMachineScaleSetsListSkusOptionalParams)
Gets a list of SKUs available for your VM scale set, including the minimum and maximum VM instances allowed for each SKU.
function listSkus(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsListSkusOptionalParams): PagedAsyncIterableIterator<VirtualMachineScaleSetSku, VirtualMachineScaleSetSku[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group.
- vmScaleSetName
-
string
The name of the VM scale set.
The options parameters.