Microsoft Azure

ComputeManagementClient

The Compute Management Client.

Developer tools#openapi#cloud

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 109

ComputeOperations

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

AvailabilitySets

  • 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_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_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.

DedicatedHostGroups

  • 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.
  • 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_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/hostGroups/:hostGroupName?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.

Images

  • 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…
  • GETImages_ListByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/images?api-version=stringGets the list of images under a resource group.
  • 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.

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.

VirtualMachineImages

  • 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_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_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.
  • GETVirtualMachineImages_List/subscriptions/:subscriptionId/providers/Microsoft.Compute/locations/:location/publishers/:publisherName/artifacttypes/vmimage/offers/:offer/skus/:skus/versions?$filter=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_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.

VirtualMachineExtensionImages

  • 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.
  • 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.

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.
  • GETVirtualMachines_ListAll/subscriptions/:subscriptionId/providers/Microsoft.Compute/virtualMachines?api-version=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_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines?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_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.
  • DELETEVirtualMachines_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName?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.
  • 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.
  • 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?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 state of the virtual machine to generalized.
  • 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_PerformMaintenance/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/performMaintenance?api-version=stringThe operation to perform maintenance on a virtual machine.
  • 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_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_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.
  • 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.

VirtualMachineSizes

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

ProximityPlacementGroups

  • 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.
  • GETProximityPlacementGroups_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/proximityPlacementGroups/:proximityPlacementGroupName?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.

VirtualMachineScaleSets

  • 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_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets?api-version=stringGets a list of all VM scale sets under a resource group.
  • GETVirtualMachineScaleSets_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName?api-version=stringDisplay 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?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_ConvertToSinglePlacementGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/convertToSinglePlacementGroupConverts SinglePlacementGroup property to false for a existing virtual machine 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?api-version=stringDeletes virtual machines in a VM scale set.
  • POSTVirtualMachineScaleSets_ForceRecoveryServiceFabricPlatformUpdateDomainWalk/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/forceRecoveryServiceFabricPlatformUpdateDomainWalk?api-version=string&platformUpdateDomain=0Manual platform update domain walk to update virtual machines in a service fabric virtual machine 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.
  • 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.
  • 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_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_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_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_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_Restart/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/restart?api-version=stringRestarts one or more virtual machines in a VM scale set.
  • 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.
  • 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.

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.

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 .

VirtualMachineScaleSetVMs

  • 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.
  • 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?api-version=stringDeletes a virtual machine from a VM scale set.
  • 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_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.
  • 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_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_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_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_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.

VirtualMachineScaleSetRollingUpgrades

  • 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…
  • 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_Cancel/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/rollingUpgrades/cancel?api-version=stringCancels the current virtual machine scale set rolling upgrade.
  • 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.

VirtualMachineScaleSetExtensions

  • 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.
  • 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.

VirtualMachineExtensions

  • 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.
  • 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.

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
109 operations on 81 pathsGET 46POST 35PUT 10DELETE 10PATCH 8
Main resources
VirtualMachineScaleSets 21VirtualMachines 19VirtualMachineScaleSetVMs 13AvailabilitySets 7DedicatedHostGroups 6Images 6ProximityPlacementGroups 6VirtualMachineExtensions 5VirtualMachineImages 5DedicatedHosts 4
Response formats
application/json
Description format
Swagger 2.0, API version 2019-03-01
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the ComputeManagementClient 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 ComputeManagementClient 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 ComputeManagementClient?

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

Who publishes the ComputeManagementClient?

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 ComputeManagementClient?

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

How do I authenticate with the ComputeManagementClient?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the ComputeManagementClient have?

109 operations on 81 paths (46 GET, 35 POST, 10 PUT, 10 DELETE, 8 PATCH). The largest groups are VirtualMachineScaleSets, VirtualMachines, VirtualMachineScaleSetVMs, AvailabilitySets.

Is forking the ComputeManagementClient 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.