Microsoft Azure

Azure Compute: Virtual Machine

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 30

VirtualMachineExtensions

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

VirtualMachines

  • GETVirtualMachines_ListByLocation/subscriptions/:subscriptionId/providers/Microsoft.Compute/locations/:location/virtualMachinesGets all the virtual machines under the specified subscription for the specified location.
  • POSTVirtualMachines_Capture/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/captureCaptures 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=instanceViewRetrieves information about the model view or the instance view of a virtual machine.
  • PUTVirtualMachines_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmNameThe 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=trueThe operation to delete a virtual machine.
  • PATCHVirtualMachines_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmNameThe operation to update a virtual machine.
  • GETVirtualMachines_InstanceView/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/instanceViewRetrieves information about the run-time state of a virtual machine.
  • POSTVirtualMachines_ConvertToManagedDisks/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/convertToManagedDisksConverts 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=trueShuts 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/generalizeSets the OS state of the virtual machine to generalized. It is recommended to sysprep the virtual machine before performing this operation. For Windows,…
  • GETVirtualMachines_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines?$filter=string&$expand=instanceViewLists 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?statusOnly=string&$filter=string&$expand=instanceViewLists 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/vmSizesLists 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=falseThe 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/reapplyThe operation to reapply a virtual machine's state.
  • POSTVirtualMachines_Restart/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/restartThe operation to restart a virtual machine.
  • POSTVirtualMachines_Start/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/startThe operation to start a virtual machine.
  • POSTVirtualMachines_Redeploy/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/redeployShuts 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/reimageReimages (upgrade the operating system) a virtual machine which don't have a ephemeral OS disk, for virtual machines who have a ephemeral OS disk the virtual…
  • POSTVirtualMachines_RetrieveBootDiagnosticsData/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/retrieveBootDiagnosticsData?sasUriExpirationTimeInMinutes=0The operation to retrieve SAS URIs for a virtual machine's boot diagnostic logs.
  • POSTVirtualMachines_PerformMaintenance/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/performMaintenanceThe operation to perform maintenance on a virtual machine.
  • POSTVirtualMachines_SimulateEviction/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/simulateEvictionThe operation to simulate the eviction of spot virtual machine.
  • POSTVirtualMachines_AssessPatches/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/assessPatchesAssess patches on the VM.
  • POSTVirtualMachines_InstallPatches/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/installPatchesInstalls patches on the VM.
  • POSTVirtualMachines_AttachDetachDataDisks/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/attachDetachDataDisksAttach and detach data disks to/from the virtual machine.

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
30 operations on 24 pathsPOST 16GET 8PUT 2PATCH 2DELETE 2
Main resources
VirtualMachines 25VirtualMachineExtensions 5
Response formats
application/json
Description format
Swagger 2.0, API version 2024-07-01

How to test the Azure Compute: Virtual Machine 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: Virtual Machine 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 “VirtualMachineExtensions_Get” (GET /subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/extensions/:vmExtensionName?$expand=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: Virtual Machine?

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

Who publishes the Azure Compute: Virtual Machine?

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?

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?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure Compute: Virtual Machine have?

30 operations on 24 paths (16 POST, 8 GET, 2 PUT, 2 PATCH, 2 DELETE). The largest groups are VirtualMachines, VirtualMachineExtensions.

Is forking the Azure Compute: Virtual Machine 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.