Azure Compute: Virtual Machine Scale Set
The Compute Management Client.
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
The Compute Management Client.
Endpoints 56
VirtualMachineScaleSets
- GETVirtualMachineScaleSets_ListByLocation
/subscriptions/:subscriptionId/providers/Microsoft.Compute/locations/:location/virtualMachineScaleSetsGets all the VM scale sets under the specified subscription for the specified location. - GETVirtualMachineScaleSets_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName?$expand=userDataDisplay information about a virtual machine scale set. - PUTVirtualMachineScaleSets_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetNameCreate or update a VM scale set. - DELETEVirtualMachineScaleSets_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName?forceDeletion=trueDeletes a VM scale set. - PATCHVirtualMachineScaleSets_Update
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetNameUpdate a VM scale set. - POSTVirtualMachineScaleSets_Deallocate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/deallocate?hibernate=trueDeallocates specific virtual machines in a VM scale set. Shuts down the virtual machines and releases the compute resources. You are not billed for the… - POSTVirtualMachineScaleSets_DeleteInstances
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/delete?forceDeletion=trueDeletes virtual machines in a VM scale set. - GETVirtualMachineScaleSets_GetInstanceView
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/instanceViewGets the status of a VM scale set instance. - GETVirtualMachineScaleSets_List
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSetsGets a list of all VM scale sets under a resource group. - GETVirtualMachineScaleSets_ListAll
/subscriptions/:subscriptionId/providers/Microsoft.Compute/virtualMachineScaleSetsGets 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… - GETVirtualMachineScaleSets_ListSkus
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/skusGets a list of SKUs available for your VM scale set, including the minimum and maximum VM instances allowed for each SKU. - GETVirtualMachineScaleSets_GetOSUpgradeHistory
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/osUpgradeHistoryGets list of OS upgrades on a VM scale set instance. - POSTVirtualMachineScaleSets_PowerOff
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/poweroff?skipShutdown=falsePower 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.… - POSTVirtualMachineScaleSets_Restart
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/restartRestarts one or more virtual machines in a VM scale set. - POSTVirtualMachineScaleSets_Start
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/startStarts one or more virtual machines in a VM scale set. - POSTVirtualMachineScaleSets_Reapply
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/reapplyReapplies the Virtual Machine Scale Set Virtual Machine Profile to the Virtual Machine Instances - POSTVirtualMachineScaleSets_Redeploy
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/redeployShuts down all the virtual machines in the virtual machine scale set, moves them to a new node, and powers them back on. - POSTVirtualMachineScaleSets_PerformMaintenance
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/performMaintenancePerform 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.… - POSTVirtualMachineScaleSets_UpdateInstances
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/manualupgradeUpgrades one or more virtual machines to the latest SKU set in the VM scale set model. - POSTVirtualMachineScaleSets_Reimage
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/reimageReimages (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… - POSTVirtualMachineScaleSets_ReimageAll
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/reimageallReimages all the disks ( including data disks ) in the virtual machines in a VM scale set. This operation is only supported for managed disks. - POSTVirtualMachineScaleSets_ApproveRollingUpgrade
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/approveRollingUpgradeApprove upgrade on deferred rolling upgrades for OS disks in the virtual machines in a VM scale set. - POSTVirtualMachineScaleSets_ForceRecoveryServiceFabricPlatformUpdateDomainWalk
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/forceRecoveryServiceFabricPlatformUpdateDomainWalk?platformUpdateDomain=0&zone=string&placementGroupId=stringManual platform update domain walk to update virtual machines in a service fabric virtual machine scale set. - POSTVirtualMachineScaleSets_ConvertToSinglePlacementGroup
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/convertToSinglePlacementGroupConverts SinglePlacementGroup property to false for a existing virtual machine scale set. - POSTVirtualMachineScaleSets_SetOrchestrationServiceState
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/setOrchestrationServiceStateChanges ServiceState property for a given service
VirtualMachineScaleSetExtensions
- GETVirtualMachineScaleSetExtensions_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/extensions/:vmssExtensionName?$expand=stringThe operation to get the extension. - PUTVirtualMachineScaleSetExtensions_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/extensions/:vmssExtensionNameThe operation to create or update an extension. - DELETEVirtualMachineScaleSetExtensions_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/extensions/:vmssExtensionNameThe operation to delete the extension. - PATCHVirtualMachineScaleSetExtensions_Update
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/extensions/:vmssExtensionNameThe operation to update an extension. - GETVirtualMachineScaleSetExtensions_List
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/extensionsGets a list of all extensions in a VM scale set.
VirtualMachineScaleSetRollingUpgrades
- POSTVirtualMachineScaleSetRollingUpgrades_Cancel
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/rollingUpgrades/cancelCancels the current virtual machine scale set rolling upgrade. - POSTVirtualMachineScaleSetRollingUpgrades_StartOSUpgrade
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/osRollingUpgradeStarts a rolling upgrade to move all virtual machine scale set instances to the latest available Platform Image OS version. Instances which are already… - POSTVirtualMachineScaleSetRollingUpgrades_StartExtensionUpgrade
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/extensionRollingUpgradeStarts a rolling upgrade to move all extensions for all virtual machine scale set instances to the latest available extension version. Instances which are… - GETVirtualMachineScaleSetRollingUpgrades_GetLatest
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/rollingUpgrades/latestGets the status of the latest virtual machine scale set rolling upgrade.
VirtualMachineScaleSetVMExtensions
- GETVirtualMachineScaleSetVMExtensions_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/virtualMachines/:instanceId/extensions/:vmExtensionName?$expand=stringThe operation to get the VMSS VM extension. - PUTVirtualMachineScaleSetVMExtensions_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/virtualMachines/:instanceId/extensions/:vmExtensionNameThe operation to create or update the VMSS VM extension. - DELETEVirtualMachineScaleSetVMExtensions_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/virtualMachines/:instanceId/extensions/:vmExtensionNameThe operation to delete the VMSS VM extension. - PATCHVirtualMachineScaleSetVMExtensions_Update
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/virtualMachines/:instanceId/extensions/:vmExtensionNameThe operation to update the VMSS VM extension. - GETVirtualMachineScaleSetVMExtensions_List
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/virtualMachines/:instanceId/extensions?$expand=stringThe operation to get all extensions of an instance in Virtual Machine Scaleset.
VirtualMachineScaleSetVMs
- POSTVirtualMachineScaleSetVMs_Reimage
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/virtualMachines/:instanceId/reimageReimages (upgrade the operating system) a specific virtual machine in a VM scale set. - POSTVirtualMachineScaleSetVMs_ReimageAll
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/virtualMachines/:instanceId/reimageallAllows 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. - POSTVirtualMachineScaleSetVMs_ApproveRollingUpgrade
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/virtualMachines/:instanceId/approveRollingUpgradeApprove upgrade on deferred rolling upgrade for OS disk on a VM scale set instance. - POSTVirtualMachineScaleSetVMs_Deallocate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/virtualMachines/:instanceId/deallocateDeallocates 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… - GETVirtualMachineScaleSetVMs_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/virtualMachines/:instanceId?$expand=instanceViewGets a virtual machine from a VM scale set. - PUTVirtualMachineScaleSetVMs_Update
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/virtualMachines/:instanceIdUpdates a virtual machine of a VM scale set. - DELETEVirtualMachineScaleSetVMs_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/virtualMachines/:instanceId?forceDeletion=trueDeletes a virtual machine from a VM scale set. - GETVirtualMachineScaleSetVMs_GetInstanceView
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/virtualMachines/:instanceId/instanceViewGets the status of a virtual machine from a VM scale set. - GETVirtualMachineScaleSetVMs_List
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:virtualMachineScaleSetName/virtualMachines?$filter=string&$select=string&$expand=stringGets a list of all virtual machines in a VM scale sets. - POSTVirtualMachineScaleSetVMs_PowerOff
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/virtualmachines/:instanceId/poweroff?skipShutdown=falsePower 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… - POSTVirtualMachineScaleSetVMs_Restart
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/virtualmachines/:instanceId/restartRestarts a virtual machine in a VM scale set. - POSTVirtualMachineScaleSetVMs_Start
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/virtualmachines/:instanceId/startStarts a virtual machine in a VM scale set. - POSTVirtualMachineScaleSetVMs_Redeploy
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/virtualmachines/:instanceId/redeployShuts down the virtual machine in the virtual machine scale set, moves it to a new node, and powers it back on. - POSTVirtualMachineScaleSetVMs_RetrieveBootDiagnosticsData
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/virtualmachines/:instanceId/retrieveBootDiagnosticsData?sasUriExpirationTimeInMinutes=0The operation to retrieve SAS URIs of boot diagnostic logs for a virtual machine in a VM scale set. - POSTVirtualMachineScaleSetVMs_PerformMaintenance
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/virtualmachines/:instanceId/performMaintenancePerforms maintenance on a virtual machine in a VM scale set. - POSTVirtualMachineScaleSetVMs_SimulateEviction
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/virtualMachines/:instanceId/simulateEvictionThe operation to simulate the eviction of spot virtual machine in a VM scale set. - POSTVirtualMachineScaleSetVMs_AttachDetachDataDisks
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/virtualmachines/:instanceId/attachDetachDataDisksAttach and detach data disks to/from a virtual machine in a VM scale set.
API details
- Base URL
https://management.azure.com- Authentication
- OAuth 2.0 (implicit flow) with 1 scope
- Operations
- 56 operations on 45 pathsPOST 30GET 15PUT 4DELETE 4PATCH 3
- Main resources
- VirtualMachineScaleSets 25VirtualMachineScaleSetVMs 17VirtualMachineScaleSetExtensions 5VirtualMachineScaleSetVMExtensions 5VirtualMachineScaleSetRollingUpgrades 4
- Response formats
application/json- Description format
- Swagger 2.0, API version
2024-07-01 - Links
- OpenAPI document
How to test the Azure Compute: Virtual Machine Scale Set in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Compute: Virtual Machine Scale Set collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “VirtualMachineScaleSets_ListByLocation” (GET /subscriptions/:subscriptionId/providers/Microsoft.Compute/locations/:location/virtualMachineScaleSets), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Azure Compute: Virtual Machine Scale Set?
The Compute Management Client. It is listed under Developer tools and has 56 endpoints.
Who publishes the Azure Compute: Virtual Machine Scale Set?
It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Azure Compute: Virtual Machine Scale Set?
Requests go to https://management.azure.com. Endpoint paths are added to this base URL.
How do I authenticate with the Azure Compute: Virtual Machine Scale Set?
With OAuth 2.0 (implicit flow) with 1 scope.
How many endpoints does the Azure Compute: Virtual Machine Scale Set have?
56 operations on 45 paths (30 POST, 15 GET, 4 PUT, 4 DELETE, 3 PATCH). The largest groups are VirtualMachineScaleSets, VirtualMachineScaleSetVMs, VirtualMachineScaleSetExtensions, VirtualMachineScaleSetVMExtensions.
Is forking the Azure Compute: Virtual Machine Scale Set free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.