Microsoft Azure

Azure Compute

The Compute Management Client.

Developer tools#openapi

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 157

ComputeOperations

  • GETOperations_List/providers/Microsoft.Compute/operations?api-version=stringGets a list of compute operations.

AvailabilitySets

  • GETAvailabilitySets_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/availabilitySets/:availabilitySetName?api-version=stringRetrieves information about an availability set.
  • PUTAvailabilitySets_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/availabilitySets/:availabilitySetName?api-version=stringCreate or update an availability set.
  • DELETEAvailabilitySets_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/availabilitySets/:availabilitySetName?api-version=stringDelete an availability set.
  • PATCHAvailabilitySets_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/availabilitySets/:availabilitySetName?api-version=stringUpdate an availability set.
  • GETAvailabilitySets_ListBySubscription/subscriptions/:subscriptionId/providers/Microsoft.Compute/availabilitySets?api-version=string&$expand=stringLists all availability sets in a subscription.
  • GETAvailabilitySets_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/availabilitySets?api-version=stringLists all availability sets in a resource group.
  • GETAvailabilitySets_ListAvailableSizes/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/availabilitySets/:availabilitySetName/vmSizes?api-version=stringLists all available virtual machine sizes that can be used to create a new virtual machine in an existing availability set.

ProximityPlacementGroups

  • GETProximityPlacementGroups_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/proximityPlacementGroups/:proximityPlacementGroupName?includeColocationStatus=string&api-version=stringRetrieves information about a proximity placement group .
  • PUTProximityPlacementGroups_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/proximityPlacementGroups/:proximityPlacementGroupName?api-version=stringCreate or update a proximity placement group.
  • DELETEProximityPlacementGroups_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/proximityPlacementGroups/:proximityPlacementGroupName?api-version=stringDelete a proximity placement group.
  • PATCHProximityPlacementGroups_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/proximityPlacementGroups/:proximityPlacementGroupName?api-version=stringUpdate a proximity placement group.
  • GETProximityPlacementGroups_ListBySubscription/subscriptions/:subscriptionId/providers/Microsoft.Compute/proximityPlacementGroups?api-version=stringLists all proximity placement groups in a subscription.
  • GETProximityPlacementGroups_ListByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/proximityPlacementGroups?api-version=stringLists all proximity placement groups in a resource group.

DedicatedHostGroups

  • GETDedicatedHostGroups_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/hostGroups/:hostGroupName?$expand=instanceView&api-version=stringRetrieves information about a dedicated host group.
  • PUTDedicatedHostGroups_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/hostGroups/:hostGroupName?api-version=stringCreate or update a dedicated host group. For details of Dedicated Host and Dedicated Host Groups please see [Dedicated Host Documentation]…
  • DELETEDedicatedHostGroups_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/hostGroups/:hostGroupName?api-version=stringDelete a dedicated host group.
  • PATCHDedicatedHostGroups_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/hostGroups/:hostGroupName?api-version=stringUpdate an dedicated host group.
  • GETDedicatedHostGroups_ListByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/hostGroups?api-version=stringLists all of the dedicated host groups in the specified resource group. Use the nextLink property in the response to get the next page of dedicated host groups.
  • GETDedicatedHostGroups_ListBySubscription/subscriptions/:subscriptionId/providers/Microsoft.Compute/hostGroups?api-version=stringLists all of the dedicated host groups in the subscription. Use the nextLink property in the response to get the next page of dedicated host groups.

DedicatedHosts

  • GETDedicatedHosts_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/hostGroups/:hostGroupName/hosts/:hostName?$expand=instanceView&api-version=stringRetrieves information about a dedicated host.
  • PUTDedicatedHosts_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/hostGroups/:hostGroupName/hosts/:hostName?api-version=stringCreate or update a dedicated host .
  • DELETEDedicatedHosts_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/hostGroups/:hostGroupName/hosts/:hostName?api-version=stringDelete a dedicated host.
  • PATCHDedicatedHosts_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/hostGroups/:hostGroupName/hosts/:hostName?api-version=stringUpdate an dedicated host .

DedicatedHost

  • GETDedicatedHosts_ListByHostGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/hostGroups/:hostGroupName/hosts?api-version=stringLists all of the dedicated hosts in the specified dedicated host group. Use the nextLink property in the response to get the next page of dedicated hosts.
  • POSTDedicatedHosts_Restart/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/hostGroups/:hostGroupName/hosts/:hostName/restart?api-version=stringRestart the dedicated host. The operation will complete successfully once the dedicated host has restarted and is running. To determine the health of VMs…

SshPublicKeys

  • GETSshPublicKeys_ListBySubscription/subscriptions/:subscriptionId/providers/Microsoft.Compute/sshPublicKeys?api-version=stringLists all of the SSH public keys in the subscription. Use the nextLink property in the response to get the next page of SSH public keys.
  • GETSshPublicKeys_ListByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/sshPublicKeys?api-version=stringLists all of the SSH public keys in the specified resource group. Use the nextLink property in the response to get the next page of SSH public keys.
  • GETSshPublicKeys_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/sshPublicKeys/:sshPublicKeyName?api-version=stringRetrieves information about an SSH public key.
  • PUTSshPublicKeys_Create/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/sshPublicKeys/:sshPublicKeyName?api-version=stringCreates a new SSH public key resource.
  • DELETESshPublicKeys_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/sshPublicKeys/:sshPublicKeyName?api-version=stringDelete an SSH public key.
  • PATCHSshPublicKeys_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/sshPublicKeys/:sshPublicKeyName?api-version=stringUpdates a new SSH public key resource.
  • POSTSshPublicKeys_GenerateKeyPair/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/sshPublicKeys/:sshPublicKeyName/generateKeyPair?api-version=stringGenerates and returns a public/private key pair and populates the SSH public key resource with the public key. The length of the key will be 3072 bits. This…

VirtualMachineExtensionImages

  • GETVirtualMachineExtensionImages_Get/subscriptions/:subscriptionId/providers/Microsoft.Compute/locations/:location/publishers/:publisherName/artifacttypes/vmextension/types/:type/versions/:version?api-version=stringGets a virtual machine extension image.
  • GETVirtualMachineExtensionImages_ListTypes/subscriptions/:subscriptionId/providers/Microsoft.Compute/locations/:location/publishers/:publisherName/artifacttypes/vmextension/types?api-version=stringGets a list of virtual machine extension image types.
  • GETVirtualMachineExtensionImages_ListVersions/subscriptions/:subscriptionId/providers/Microsoft.Compute/locations/:location/publishers/:publisherName/artifacttypes/vmextension/types/:type/versions?$filter=string&$top=0&$orderby=string&api-version=stringGets a list of virtual machine extension image versions.

VirtualMachineExtensions

  • GETVirtualMachineExtensions_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/extensions/:vmExtensionName?$expand=string&api-version=stringThe operation to get the extension.
  • PUTVirtualMachineExtensions_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/extensions/:vmExtensionName?api-version=stringThe operation to create or update the extension.
  • DELETEVirtualMachineExtensions_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/extensions/:vmExtensionName?api-version=stringThe operation to delete the extension.
  • PATCHVirtualMachineExtensions_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/extensions/:vmExtensionName?api-version=stringThe operation to update the extension.
  • GETVirtualMachineExtensions_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/extensions?$expand=string&api-version=stringThe operation to get all extensions of a Virtual Machine.

VirtualMachineImages

  • GETVirtualMachineImages_Get/subscriptions/:subscriptionId/providers/Microsoft.Compute/locations/:location/publishers/:publisherName/artifacttypes/vmimage/offers/:offer/skus/:skus/versions/:version?api-version=stringGets a virtual machine image.
  • GETVirtualMachineImages_List/subscriptions/:subscriptionId/providers/Microsoft.Compute/locations/:location/publishers/:publisherName/artifacttypes/vmimage/offers/:offer/skus/:skus/versions?$expand=string&$top=0&$orderby=string&api-version=stringGets a list of all virtual machine image versions for the specified location, publisher, offer, and SKU.
  • GETVirtualMachineImages_ListOffers/subscriptions/:subscriptionId/providers/Microsoft.Compute/locations/:location/publishers/:publisherName/artifacttypes/vmimage/offers?api-version=stringGets a list of virtual machine image offers for the specified location and publisher.
  • GETVirtualMachineImages_ListPublishers/subscriptions/:subscriptionId/providers/Microsoft.Compute/locations/:location/publishers?api-version=stringGets a list of virtual machine image publishers for the specified Azure location.
  • GETVirtualMachineImages_ListSkus/subscriptions/:subscriptionId/providers/Microsoft.Compute/locations/:location/publishers/:publisherName/artifacttypes/vmimage/offers/:offer/skus?api-version=stringGets a list of virtual machine image SKUs for the specified location, publisher, and offer.
  • GETVirtualMachineImagesEdgeZone_Get/subscriptions/:subscriptionId/providers/Microsoft.Compute/locations/:location/edgeZones/:edgeZone/publishers/:publisherName/artifacttypes/vmimage/offers/:offer/skus/:skus/versions/:version?api-version=stringGets a virtual machine image in an edge zone.
  • GETVirtualMachineImagesEdgeZone_List/subscriptions/:subscriptionId/providers/Microsoft.Compute/locations/:location/edgeZones/:edgeZone/publishers/:publisherName/artifacttypes/vmimage/offers/:offer/skus/:skus/versions?$expand=string&$top=0&$orderby=string&api-version=stringGets a list of all virtual machine image versions for the specified location, edge zone, publisher, offer, and SKU.
  • GETVirtualMachineImagesEdgeZone_ListOffers/subscriptions/:subscriptionId/providers/Microsoft.Compute/locations/:location/edgeZones/:edgeZone/publishers/:publisherName/artifacttypes/vmimage/offers?api-version=stringGets a list of virtual machine image offers for the specified location, edge zone and publisher.
  • GETVirtualMachineImagesEdgeZone_ListPublishers/subscriptions/:subscriptionId/providers/Microsoft.Compute/locations/:location/edgeZones/:edgeZone/publishers?api-version=stringGets a list of virtual machine image publishers for the specified Azure location and edge zone.
  • GETVirtualMachineImagesEdgeZone_ListSkus/subscriptions/:subscriptionId/providers/Microsoft.Compute/locations/:location/edgeZones/:edgeZone/publishers/:publisherName/artifacttypes/vmimage/offers/:offer/skus?api-version=stringGets a list of virtual machine image SKUs for the specified location, edge zone, publisher, and offer.

Usage

  • GETUsage_List/subscriptions/:subscriptionId/providers/Microsoft.Compute/locations/:location/usages?api-version=stringGets, for the specified location, the current compute resource usage information as well as the limits for compute resources under the subscription.

VirtualMachines

  • GETVirtualMachines_ListByLocation/subscriptions/:subscriptionId/providers/Microsoft.Compute/locations/:location/virtualMachines?api-version=stringGets all the virtual machines under the specified subscription for the specified location.
  • POSTVirtualMachines_Capture/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/capture?api-version=stringCaptures the VM by copying virtual hard disks of the VM and outputs a template that can be used to create similar VMs.
  • GETVirtualMachines_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName?$expand=instanceView&api-version=stringRetrieves information about the model view or the instance view of a virtual machine.
  • PUTVirtualMachines_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName?api-version=stringThe operation to create or update a virtual machine. Please note some properties can be set only during virtual machine creation.
  • DELETEVirtualMachines_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName?forceDeletion=true&api-version=stringThe operation to delete a virtual machine.
  • PATCHVirtualMachines_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName?api-version=stringThe operation to update a virtual machine.
  • GETVirtualMachines_InstanceView/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/instanceView?api-version=stringRetrieves information about the run-time state of a virtual machine.
  • POSTVirtualMachines_ConvertToManagedDisks/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/convertToManagedDisks?api-version=stringConverts virtual machine disks from blob-based to managed disks. Virtual machine must be stop-deallocated before invoking this operation.
  • POSTVirtualMachines_Deallocate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/deallocate?hibernate=true&api-version=stringShuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses.
  • POSTVirtualMachines_Generalize/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/generalize?api-version=stringSets the OS state of the virtual machine to generalized. It is recommended to sysprep the virtual machine before performing this operation. <br>For Windows,…
  • GETVirtualMachines_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines?$filter=string&api-version=stringLists all of the virtual machines in the specified resource group. Use the nextLink property in the response to get the next page of virtual machines.
  • GETVirtualMachines_ListAll/subscriptions/:subscriptionId/providers/Microsoft.Compute/virtualMachines?api-version=string&statusOnly=string&$filter=stringLists all of the virtual machines in the specified subscription. Use the nextLink property in the response to get the next page of virtual machines.
  • GETVirtualMachines_ListAvailableSizes/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/vmSizes?api-version=stringLists all available virtual machine sizes to which the specified virtual machine can be resized.
  • POSTVirtualMachines_PowerOff/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/powerOff?skipShutdown=false&api-version=stringThe operation to power off (stop) a virtual machine. The virtual machine can be restarted with the same provisioned resources. You are still charged for this…
  • POSTVirtualMachines_Reapply/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/reapply?api-version=stringThe operation to reapply a virtual machine's state.
  • POSTVirtualMachines_Restart/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/restart?api-version=stringThe operation to restart a virtual machine.
  • POSTVirtualMachines_Start/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/start?api-version=stringThe operation to start a virtual machine.
  • POSTVirtualMachines_Redeploy/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/redeploy?api-version=stringShuts down the virtual machine, moves it to a new node, and powers it back on.
  • POSTVirtualMachines_Reimage/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/reimage?api-version=stringReimages the virtual machine which has an ephemeral OS disk back to its initial state.
  • POSTVirtualMachines_RetrieveBootDiagnosticsData/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/retrieveBootDiagnosticsData?sasUriExpirationTimeInMinutes=0&api-version=stringThe operation to retrieve SAS URIs for a virtual machine's boot diagnostic logs.
  • POSTVirtualMachines_PerformMaintenance/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/performMaintenance?api-version=stringThe operation to perform maintenance on a virtual machine.
  • POSTVirtualMachines_SimulateEviction/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/simulateEviction?api-version=stringThe operation to simulate the eviction of spot virtual machine.
  • POSTVirtualMachines_AssessPatches/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/assessPatches?api-version=stringAssess patches on the VM.
  • POSTVirtualMachines_InstallPatches/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/installPatches?api-version=stringInstalls patches on the VM.

VirtualMachineScaleSets

  • GETVirtualMachineScaleSets_ListByLocation/subscriptions/:subscriptionId/providers/Microsoft.Compute/locations/:location/virtualMachineScaleSets?api-version=stringGets all the VM scale sets under the specified subscription for the specified location.
  • GETVirtualMachineScaleSets_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName?api-version=string&$expand=userDataDisplay information about a virtual machine scale set.
  • PUTVirtualMachineScaleSets_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName?api-version=stringCreate or update a VM scale set.
  • DELETEVirtualMachineScaleSets_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName?forceDeletion=true&api-version=stringDeletes a VM scale set.
  • PATCHVirtualMachineScaleSets_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName?api-version=stringUpdate a VM scale set.
  • POSTVirtualMachineScaleSets_Deallocate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/deallocate?api-version=stringDeallocates 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=true&api-version=stringDeletes virtual machines in a VM scale set.
  • GETVirtualMachineScaleSets_GetInstanceView/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/instanceView?api-version=stringGets the status of a VM scale set instance.
  • GETVirtualMachineScaleSets_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets?api-version=stringGets a list of all VM scale sets under a resource group.
  • GETVirtualMachineScaleSets_ListAll/subscriptions/:subscriptionId/providers/Microsoft.Compute/virtualMachineScaleSets?api-version=stringGets 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/skus?api-version=stringGets 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/osUpgradeHistory?api-version=stringGets list of OS upgrades on a VM scale set instance.
  • POSTVirtualMachineScaleSets_PowerOff/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/poweroff?skipShutdown=false&api-version=stringPower 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/restart?api-version=stringRestarts one or more virtual machines in a VM scale set.
  • POSTVirtualMachineScaleSets_Start/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/start?api-version=stringStarts one or more virtual machines in a VM scale set.
  • POSTVirtualMachineScaleSets_Redeploy/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/redeploy?api-version=stringShuts 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/performMaintenance?api-version=stringPerform 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/manualupgrade?api-version=stringUpgrades 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/reimage?api-version=stringReimages (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/reimageall?api-version=stringReimages all the disks ( including data disks ) in the virtual machines in a VM scale set. This operation is only supported for managed disks.
  • POSTVirtualMachineScaleSets_ForceRecoveryServiceFabricPlatformUpdateDomainWalk/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/forceRecoveryServiceFabricPlatformUpdateDomainWalk?api-version=string&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/convertToSinglePlacementGroup?api-version=stringConverts SinglePlacementGroup property to false for a existing virtual machine scale set.
  • POSTVirtualMachineScaleSets_SetOrchestrationServiceState/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/setOrchestrationServiceState?api-version=stringChanges ServiceState property for a given service

VirtualMachineSizes

  • GETVirtualMachineSizes_List/subscriptions/:subscriptionId/providers/Microsoft.Compute/locations/:location/vmSizes?api-version=stringThis API is deprecated. Use Resources Skus

Images

  • GETImages_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/images/:imageName?$expand=string&api-version=stringGets an image.
  • PUTImages_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/images/:imageName?api-version=stringCreate or update an image.
  • DELETEImages_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/images/:imageName?api-version=stringDeletes an Image.
  • PATCHImages_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/images/:imageName?api-version=stringUpdate an image.
  • GETImages_ListByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/images?api-version=stringGets the list of images under a resource group.
  • GETImages_List/subscriptions/:subscriptionId/providers/Microsoft.Compute/images?api-version=stringGets the list of Images in the subscription. Use nextLink property in the response to get the next page of Images. Do this till nextLink is null to fetch all…

RestorePointCollections

  • GETRestorePointCollections_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/restorePointCollections/:restorePointCollectionName?$expand=restorePoints&api-version=stringThe operation to get the restore point collection.
  • PUTRestorePointCollections_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/restorePointCollections/:restorePointCollectionName?api-version=stringThe operation to create or update the restore point collection. Please refer to https://aka.ms/RestorePoints for more details. When updating a restore point…
  • DELETERestorePointCollections_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/restorePointCollections/:restorePointCollectionName?api-version=stringThe operation to delete the restore point collection. This operation will also delete all the contained restore points.
  • PATCHRestorePointCollections_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/restorePointCollections/:restorePointCollectionName?api-version=stringThe operation to update the restore point collection.
  • GETRestorePointCollections_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/restorePointCollections?api-version=stringGets the list of restore point collections in a resource group.
  • GETRestorePointCollections_ListAll/subscriptions/:subscriptionId/providers/Microsoft.Compute/restorePointCollections?api-version=stringGets the list of restore point collections in the subscription. Use nextLink property in the response to get the next page of restore point collections. Do…

CapacityReservationGroups

  • GETCapacityReservationGroups_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/capacityReservationGroups/:capacityReservationGroupName?$expand=instanceView&api-version=stringThe operation that retrieves information about a capacity reservation group.
  • PUTCapacityReservationGroups_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/capacityReservationGroups/:capacityReservationGroupName?api-version=stringThe operation to create or update a capacity reservation group. When updating a capacity reservation group, only tags may be modified. Please refer to…
  • DELETECapacityReservationGroups_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/capacityReservationGroups/:capacityReservationGroupName?api-version=stringThe operation to delete a capacity reservation group. This operation is allowed only if all the associated resources are disassociated from the reservation…
  • PATCHCapacityReservationGroups_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/capacityReservationGroups/:capacityReservationGroupName?api-version=stringThe operation to update a capacity reservation group. When updating a capacity reservation group, only tags may be modified.
  • GETCapacityReservationGroups_ListByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/capacityReservationGroups?api-version=string&$expand=virtualMachineScaleSetVMs/$refLists all of the capacity reservation groups in the specified resource group. Use the nextLink property in the response to get the next page of capacity…
  • GETCapacityReservationGroups_ListBySubscription/subscriptions/:subscriptionId/providers/Microsoft.Compute/capacityReservationGroups?api-version=string&$expand=virtualMachineScaleSetVMs/$refLists all of the capacity reservation groups in the subscription. Use the nextLink property in the response to get the next page of capacity reservation groups.

CapacityReservations

  • GETCapacityReservations_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/capacityReservationGroups/:capacityReservationGroupName/capacityReservations/:capacityReservationName?$expand=instanceView&api-version=stringThe operation that retrieves information about the capacity reservation.
  • PUTCapacityReservations_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/capacityReservationGroups/:capacityReservationGroupName/capacityReservations/:capacityReservationName?api-version=stringThe operation to create or update a capacity reservation. Please note some properties can be set only during capacity reservation creation. Please refer to…
  • DELETECapacityReservations_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/capacityReservationGroups/:capacityReservationGroupName/capacityReservations/:capacityReservationName?api-version=stringThe operation to delete a capacity reservation. This operation is allowed only when all the associated resources are disassociated from the capacity…
  • PATCHCapacityReservations_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/capacityReservationGroups/:capacityReservationGroupName/capacityReservations/:capacityReservationName?api-version=stringThe operation to update a capacity reservation.

CapacityReservation

  • GETCapacityReservations_ListByCapacityReservationGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/capacityReservationGroups/:capacityReservationGroupName/capacityReservations?api-version=stringLists all of the capacity reservations in the specified capacity reservation group. Use the nextLink property in the response to get the next page of capacity…

VirtualMachineScaleSetExtensions

  • GETVirtualMachineScaleSetExtensions_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/extensions/:vmssExtensionName?$expand=string&api-version=stringThe operation to get the extension.
  • PUTVirtualMachineScaleSetExtensions_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/extensions/:vmssExtensionName?api-version=stringThe operation to create or update an extension.
  • DELETEVirtualMachineScaleSetExtensions_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/extensions/:vmssExtensionName?api-version=stringThe operation to delete the extension.
  • PATCHVirtualMachineScaleSetExtensions_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/extensions/:vmssExtensionName?api-version=stringThe operation to update an extension.
  • GETVirtualMachineScaleSetExtensions_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/extensions?api-version=stringGets a list of all extensions in a VM scale set.

VirtualMachineScaleSetRollingUpgrades

  • POSTVirtualMachineScaleSetRollingUpgrades_Cancel/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/rollingUpgrades/cancel?api-version=stringCancels the current virtual machine scale set rolling upgrade.
  • POSTVirtualMachineScaleSetRollingUpgrades_StartOSUpgrade/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/osRollingUpgrade?api-version=stringStarts 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/extensionRollingUpgrade?api-version=stringStarts 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/latest?api-version=stringGets 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=string&api-version=stringThe operation to get the VMSS VM extension.
  • PUTVirtualMachineScaleSetVMExtensions_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/virtualMachines/:instanceId/extensions/:vmExtensionName?api-version=stringThe operation to create or update the VMSS VM extension.
  • DELETEVirtualMachineScaleSetVMExtensions_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/virtualMachines/:instanceId/extensions/:vmExtensionName?api-version=stringThe operation to delete the VMSS VM extension.
  • PATCHVirtualMachineScaleSetVMExtensions_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/virtualMachines/:instanceId/extensions/:vmExtensionName?api-version=stringThe operation to update the VMSS VM extension.
  • GETVirtualMachineScaleSetVMExtensions_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/virtualMachines/:instanceId/extensions?$expand=string&api-version=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/reimage?api-version=stringReimages (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/reimageall?api-version=stringAllows 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_Deallocate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/virtualMachines/:instanceId/deallocate?api-version=stringDeallocates 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=instanceView&api-version=stringGets a virtual machine from a VM scale set.
  • PUTVirtualMachineScaleSetVMs_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/virtualMachines/:instanceId?api-version=stringUpdates a virtual machine of a VM scale set.
  • DELETEVirtualMachineScaleSetVMs_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/virtualMachines/:instanceId?forceDeletion=true&api-version=stringDeletes a virtual machine from a VM scale set.
  • GETVirtualMachineScaleSetVMs_GetInstanceView/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/virtualMachines/:instanceId/instanceView?api-version=stringGets 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=string&api-version=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=false&api-version=stringPower 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/restart?api-version=stringRestarts a virtual machine in a VM scale set.
  • POSTVirtualMachineScaleSetVMs_Start/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/virtualmachines/:instanceId/start?api-version=stringStarts a virtual machine in a VM scale set.
  • POSTVirtualMachineScaleSetVMs_Redeploy/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/virtualmachines/:instanceId/redeploy?api-version=stringShuts 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=0&api-version=stringThe 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/performMaintenance?api-version=stringPerforms maintenance on a virtual machine in a VM scale set.
  • POSTVirtualMachineScaleSetVMs_SimulateEviction/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/virtualMachines/:instanceId/simulateEviction?api-version=stringThe operation to simulate the eviction of spot virtual machine in a VM scale set.

LogAnalytics

  • POSTLogAnalytics_ExportRequestRateByInterval/subscriptions/:subscriptionId/providers/Microsoft.Compute/locations/:location/logAnalytics/apiAccess/getRequestRateByInterval?api-version=stringExport logs that show Api requests made by this subscription in the given time window to show throttling activities.
  • POSTLogAnalytics_ExportThrottledRequests/subscriptions/:subscriptionId/providers/Microsoft.Compute/locations/:location/logAnalytics/apiAccess/getThrottledRequests?api-version=stringExport logs that show total throttled Api requests for this subscription in the given time window.
  • GETRestorePoints_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/restorePointCollections/:restorePointCollectionName/restorePoints/:restorePointName?$expand=instanceView&api-version=stringThe operation to get the restore point.
  • PUTRestorePoints_Create/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/restorePointCollections/:restorePointCollectionName/restorePoints/:restorePointName?api-version=stringThe operation to create the restore point. Updating properties of an existing restore point is not allowed
  • DELETERestorePoints_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/restorePointCollections/:restorePointCollectionName/restorePoints/:restorePointName?api-version=stringThe operation to delete the restore point.

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
157 operations on 111 pathsGET 66POST 45PUT 16DELETE 16PATCH 14
Main resources
VirtualMachines 24VirtualMachineScaleSets 23VirtualMachineScaleSetVMs 15VirtualMachineImages 10AvailabilitySets 7SshPublicKeys 7CapacityReservationGroups 6DedicatedHostGroups 6Images 6ProximityPlacementGroups 6
Response formats
application/json
Description format
Swagger 2.0, API version 2021-11-01

How to test the Azure Compute in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Compute collection, without the publisher's secrets.
  3. 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.
  4. Send a requestPick an endpoint, for example “Operations_List” (GET /providers/Microsoft.Compute/operations?api-version=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure Compute?

The Compute Management Client. It is listed under Developer tools and has 157 endpoints.

Who publishes the Azure Compute?

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?

Requests go to https://management.azure.com. Endpoint paths are added to this base URL.

How do I authenticate with the Azure Compute?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure Compute have?

157 operations on 111 paths (66 GET, 45 POST, 16 PUT, 16 DELETE, 14 PATCH). The largest groups are VirtualMachines, VirtualMachineScaleSets, VirtualMachineScaleSetVMs, VirtualMachineImages.

Is forking the Azure Compute free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.