How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Azure Virtual Machines Virtual Machines API

Operations for creating, updating, deleting, and managing the lifecycle of Azure Virtual Machines including power operations, patching, and diagnostics.

Azure Virtual Machines Virtual Machines API is one of 10 APIs that Azure Virtual Machines publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Virtual Machines. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, pricing, a getting-started guide, an API reference, and authentication docs.

This API exposes 26 operations across 23 paths, and defines 37 schemas. It is described by OpenAPI 3.2.0, at version 2024-07-01.

Requests are made against a single base URL, https://management.azure.com.

26 operations 23 paths 37 schemas 1 DELETE6 GET1 PATCH17 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2024-07-01
Base URL
https://management.azure.com
Authentication
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

Azure Virtual Machines Virtual Machines API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2Auth) using the implicit flow, exposing 1 scope. By default, every request must be authenticated.

  • OAuth2Auth — Azure Active Directory OAuth2 Flow

Paths & Operations 26

Across 23 paths, the API surfaces 26 operations — 1 DELETE, 6 GET, 1 PATCH, 17 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Virtual Machines 26

Operations for creating, updating, deleting, and managing the lifecycle of Azure Virtual Machines including power operations, patching, and diagnostics.

GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines
Azure Virtual Machines List virtual machines in a resource group
VirtualMachines_List 5 params → 200default
GET
/subscriptions/{subscriptionId}/providers/Microsoft.Compute/virtualMachines
Azure Virtual Machines List all virtual machines in a subscription
VirtualMachines_ListAll 5 params → 200default
GET
/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/virtualMachines
Azure Virtual Machines List virtual machines by location
VirtualMachines_ListByLocation 3 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}
Azure Virtual Machines Create or update a virtual machine
VirtualMachines_CreateOrUpdate 4 params body → 200201default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}
Azure Virtual Machines Get a virtual machine
VirtualMachines_Get 5 params → 200default
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}
Azure Virtual Machines Update a virtual machine
VirtualMachines_Update 4 params body → 200default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}
Azure Virtual Machines Delete a virtual machine
VirtualMachines_Delete 5 params → 200202204default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/instanceView
Azure Virtual Machines Get the instance view of a virtual machine
VirtualMachines_InstanceView 4 params → 200default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/start
Azure Virtual Machines Start a virtual machine
VirtualMachines_Start 4 params → 200202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/powerOff
Azure Virtual Machines Power off a virtual machine
VirtualMachines_PowerOff 5 params → 200202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/deallocate
Azure Virtual Machines Deallocate a virtual machine
VirtualMachines_Deallocate 5 params → 200202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/restart
Azure Virtual Machines Restart a virtual machine
VirtualMachines_Restart 4 params → 200202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/redeploy
Azure Virtual Machines Redeploy a virtual machine
VirtualMachines_Redeploy 4 params → 200202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/reimage
Azure Virtual Machines Reimage a virtual machine
VirtualMachines_Reimage 4 params → 200202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/capture
Azure Virtual Machines Capture a virtual machine
VirtualMachines_Capture 4 params body → 200202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/generalize
Azure Virtual Machines Generalize a virtual machine
VirtualMachines_Generalize 4 params → 200default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/convertToManagedDisks
Azure Virtual Machines Convert to managed disks
VirtualMachines_ConvertToManagedDisks 4 params → 200202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/performMaintenance
Azure Virtual Machines Perform maintenance on a virtual machine
VirtualMachines_PerformMaintenance 4 params → 200202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/simulateEviction
Azure Virtual Machines Simulate eviction of a spot virtual machine
VirtualMachines_SimulateEviction 4 params → 204default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/reapply
Azure Virtual Machines Reapply a virtual machine state
VirtualMachines_Reapply 4 params → 200202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/retrieveBootDiagnosticsData
Azure Virtual Machines Retrieve boot diagnostics data
VirtualMachines_RetrieveBootDiagnosticsData 5 params → 200default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/assessPatches
Azure Virtual Machines Assess patches on a virtual machine
VirtualMachines_AssessPatches 4 params → 200202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/installPatches
Azure Virtual Machines Install patches on a virtual machine
VirtualMachines_InstallPatches 4 params body → 200202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/attachDetachDataDisks
Azure Virtual Machines Attach or detach data disks
VirtualMachines_AttachDetachDataDisks 4 params body → 200202default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/vmSizes
Azure Virtual Machines List available sizes for a virtual machine
VirtualMachines_ListAvailableSizes 4 params → 200default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommand
Azure Virtual Machines Run command on a virtual machine
VirtualMachines_RunCommand 4 params body → 200202default

Schemas 37

The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are VirtualMachineProperties (17 properties), VirtualMachine (9 properties), VirtualMachineInstallPatchesResult (8 properties), OSDisk (7 properties). Each schema is shown below with its type and property counts.

LinuxPatchSettings
object
Specifies settings related to VM Guest Patching on Linux.
2 properties
ManagedDiskParameters
object
The parameters of a managed disk.
2 properties
InstanceViewStatus
object
Instance view status.
5 properties
VirtualMachineIdentity
object
Identity for the virtual machine.
3 properties
VirtualMachineInstallPatchesParameters
object
Input for InstallPatches as directly received by the API.
2 properties 1 required
LinuxConfiguration
object
Specifies the Linux operating system settings on the virtual machine.
4 properties
VirtualMachineListResult
object
The List Virtual Machine operation response.
2 properties
ApiError
object
Api error.
5 properties
HardwareProfile
object
Specifies the hardware settings for the virtual machine.
1 property
Plan
object
Specifies information about the marketplace image used to create the virtual machine.
4 properties
StorageProfile
object
Specifies the storage settings for the virtual machine disks.
3 properties
RunCommandResult
object
Run command operation response.
1 property
VirtualMachineCaptureResult
object
Output of virtual machine capture operation.
5 properties
WindowsConfiguration
object
Specifies Windows operating system settings on the virtual machine.
4 properties
WindowsPatchSettings
object
Specifies settings related to VM Guest Patching on Windows.
3 properties
VirtualMachineSize
object
Describes the properties of a VM size.
6 properties
VirtualMachineInstanceView
object
The instance view of a virtual machine.
6 properties
CloudError
object
An error response from the Compute service.
1 property
NetworkInterfaceReference
object
Describes a network interface reference.
2 properties
VirtualMachineInstallPatchesResult
object
The result summary of an installation operation.
8 properties
AttachDetachDataDisksRequest
object
Specifies the input for attaching and detaching data disks.
2 properties
VirtualMachine
object
Describes a Virtual Machine.
9 properties 1 required
ImageReference
object
Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images.
6 properties
DataDisk
object
Describes a data disk.
7 properties 2 required
VirtualMachineUpdate
object
Describes a Virtual Machine Update.
4 properties
RunCommandInput
object
Capture virtual machine parameters.
3 properties 1 required
ApiErrorBase
object
Api error base.
3 properties
SubResource
object
Reference to a sub-resource.
1 property
VirtualMachineCaptureParameters
object
Capture virtual machine parameters.
3 properties 3 required
DiagnosticsProfile
object
Specifies the boot diagnostic settings state.
1 property
OSProfile
object
Specifies the operating system settings for the virtual machine.
5 properties
OSDisk
object
Specifies information about the operating system disk used by the virtual machine.
7 properties 1 required
RetrieveBootDiagnosticsDataResult
object
The SAS URIs of the console screenshot and serial log blobs.
2 properties
VirtualMachineProperties
object
Describes the properties of a Virtual Machine.
17 properties
VirtualMachineAssessPatchesResult
object
Describes the properties of an AssessPatches result.
6 properties
NetworkProfile
object
Specifies the network interfaces or the networking configuration of the virtual machine.
1 property
VirtualMachineSizeListResult
object
The List Virtual Machine operation response.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-azure-virtual-machines-virtual-machines-api-openapi.yml Raw ↑

Other APIs Azure Virtual Machines publishes across the network.

Azure Virtual Machine Scale Sets REST API
Azure Virtual Machine Extensions REST API
Azure Virtual Machine Images REST API
Azure Virtual Machine Sizes REST API
Azure Virtual Machine Run Commands REST API
Azure Availability Sets REST API
Azure Proximity Placement Groups REST API
Azure Dedicated Hosts REST API
Azure Capacity Reservations REST API
Where this information came from

This is an independent, third-party profile of Azure Virtual Machines Virtual Machines API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.