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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Microsoft Azure

Microsoft Azure VirtualMachines API

The VirtualMachines API from Microsoft Azure — 41 operation(s) for virtualmachines.

Documentation Provider Profile APIs.io OpenAPI GitHub

Microsoft Azure VirtualMachines API is one of 1667 APIs that Microsoft Azure 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, an API reference, pricing, a JSON-LD context, and a getting-started guide.

This API exposes 53 operations across 41 paths, and defines 131 schemas. It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.

53 operations 41 paths 131 schemas 4 DELETE12 GET4 PATCH29 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2020-08-01-preview
Resource Areas
1

Paths & Operations 53

Across 41 paths, the API surfaces 53 operations — 4 DELETE, 12 GET, 4 PATCH, 29 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

VirtualMachines 53
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedVMwarevSphere/virtualMachines/{virtualMachineName}/assessPatches
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Connectedvmwarevsphere Virtualmachines Virtualmachinename Assesspatches
microsoftAzureVirtualmachinesAssesspatches 4 params → 200202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedVMwarevSphere/virtualMachines/{virtualMachineName}/installPatches
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Connectedvmwarevsphere Virtualmachines Virtualmachinename Installpatches
microsoftAzureVirtualmachinesInstallpatches 4 params body → 200202default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedVMwarevSphere/virtualMachines/{virtualMachineName}
Microsoft Azure Implements Virtual Machine Put Method
microsoftAzureVirtualmachinesCreateorupdate 4 params body → 200201default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedVMwarevSphere/virtualMachines/{virtualMachineName}
Microsoft Azure Gets A Virtual Machine
microsoftAzureVirtualmachinesGet 4 params → 200default
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedVMwarevSphere/virtualMachines/{virtualMachineName}
Microsoft Azure Updates A Virtual Machine
microsoftAzureVirtualmachinesUpdate 4 params body → 200201202default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedVMwarevSphere/virtualMachines/{virtualMachineName}
Microsoft Azure Deletes An Virtual Machine
microsoftAzureVirtualmachinesDelete 6 params → 200202204default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedVMwarevSphere/virtualMachines/{virtualMachineName}/stop
Microsoft Azure Implements The Operation To Stop A Virtual Machine
microsoftAzureVirtualmachinesStop 4 params body → 200202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedVMwarevSphere/virtualMachines/{virtualMachineName}/start
Microsoft Azure Implements The Operation To Start A Virtual Machine
microsoftAzureVirtualmachinesStart 4 params → 200202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedVMwarevSphere/virtualMachines/{virtualMachineName}/restart
Microsoft Azure Implements The Operation To Restart A Virtual Machine
microsoftAzureVirtualmachinesRestart 4 params → 200202default
GET
/subscriptions/{subscriptionId}/providers/Microsoft.ConnectedVMwarevSphere/virtualMachines
Microsoft Azure Implements Get Virtualmachines In A Subscription
microsoftAzureVirtualmachinesListall 2 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedVMwarevSphere/virtualMachines
Microsoft Azure Implements Get Virtualmachines In A Resource Group
microsoftAzureVirtualmachinesList 3 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Virtualmachines
microsoftAzureVirtualmachinesList 8 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Virtualmachines Name
microsoftAzureVirtualmachinesGet 6 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Virtualmachines Name
microsoftAzureVirtualmachinesCreateorupdate 5 params body → 200201default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Virtualmachines Name
microsoftAzureVirtualmachinesDelete 5 params → 200202204default
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Virtualmachines Name
microsoftAzureVirtualmachinesUpdate 5 params body → 200default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/addDataDisk
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Virtualmachines Name Adddatadisk
microsoftAzureVirtualmachinesAdddatadisk 5 params body → 200202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/applyArtifacts
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Virtualmachines Name Applyartifacts
microsoftAzureVirtualmachinesApplyartifacts 5 params body → 200202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/claim
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Virtualmachines Name Claim
microsoftAzureVirtualmachinesClaim 5 params → 200202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/detachDataDisk
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Virtualmachines Name Detachdatadisk
microsoftAzureVirtualmachinesDetachdatadisk 5 params body → 200202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/getRdpFileContents
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Virtualmachines Name Getrdpfilecontents
microsoftAzureVirtualmachinesGetrdpfilecontents 5 params → 200default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/listApplicableSchedules
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Virtualmachines Name Listapplicableschedules
microsoftAzureVirtualmachinesListapplicableschedules 5 params → 200default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/redeploy
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Virtualmachines Name Redeploy
microsoftAzureVirtualmachinesRedeploy 5 params → 200202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/resize
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Virtualmachines Name Resize
microsoftAzureVirtualmachinesResize 5 params body → 200202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/restart
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Virtualmachines Name Restart
microsoftAzureVirtualmachinesRestart 5 params → 200202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/start
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Virtualmachines Name Start
microsoftAzureVirtualmachinesStart 5 params → 200202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/stop
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Virtualmachines Name Stop
microsoftAzureVirtualmachinesStop 5 params → 200202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/transferDisks
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Virtualmachines Name Transferdisks
microsoftAzureVirtualmachinesTransferdisks 5 params → 200202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/unClaim
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Virtualmachines Name Unclaim
microsoftAzureVirtualmachinesUnclaim 5 params → 200202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/listHosts
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hdinsight Clusters Clustername Listhosts
microsoftAzureVirtualmachinesListhosts 4 params → 200default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/restartHosts
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hdinsight Clusters Clustername Restarthosts
microsoftAzureVirtualmachinesRestarthosts 4 params body → 200202default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/restartHosts/azureasyncoperations/{operationId}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hdinsight Clusters Clustername Restarthosts Azureasyncoperations Operationid
microsoftAzureVirtualmachinesGetasyncoperationstatus 5 params → 200default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommand
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Virtualmachines Vmname Runcommand
microsoftAzureVirtualmachinesRuncommand 4 params body → 200202
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualMachines/{virtualMachineName}
Microsoft Azure Gets A Virtualmachine
microsoftAzureVirtualmachinesGet 4 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualMachines/{virtualMachineName}
Microsoft Azure Implements Virtualmachines Put Method
microsoftAzureVirtualmachinesCreateorupdate 4 params body → 200201default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualMachines/{virtualMachineName}
Microsoft Azure Implements Virtualmachine Delete Method
microsoftAzureVirtualmachinesDelete 7 params → 200202204default
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualMachines/{virtualMachineName}
Microsoft Azure Implements The Virtualmachines Patch Method
microsoftAzureVirtualmachinesUpdate 4 params body → 200201202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualMachines/{virtualMachineName}/stop
Microsoft Azure Implements The Operation To Stop A Virtual Machine
microsoftAzureVirtualmachinesStop 4 params body → 200202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualMachines/{virtualMachineName}/start
Microsoft Azure Implements The Operation To Start A Virtual Machine
microsoftAzureVirtualmachinesStart 4 params → 200202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualMachines/{virtualMachineName}/restart
Microsoft Azure Implements The Operation To Restart A Virtual Machine
microsoftAzureVirtualmachinesRestart 4 params → 200202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualMachines/{virtualMachineName}/createCheckpoint
Microsoft Azure Implements The Operation To Creates A Checkpoint In A Virtual Machine
microsoftAzureVirtualmachinesCreatecheckpoint 4 params body → 200202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualMachines/{virtualMachineName}/deleteCheckpoint
Microsoft Azure Implements The Operation To Delete A Checkpoint In A Virtual Machine
microsoftAzureVirtualmachinesDeletecheckpoint 4 params body → 200202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualMachines/{virtualMachineName}/restoreCheckpoint
Microsoft Azure Implements The Operation To Restores To A Checkpoint In A Virtual Machine
microsoftAzureVirtualmachinesRestorecheckpoint 4 params body → 200202default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualMachines
Microsoft Azure Implements Get Virtualmachines In A Resource Group
microsoftAzureVirtualmachinesListbyresourcegroup 3 params → 200default
GET
/subscriptions/{subscriptionId}/providers/Microsoft.ScVmm/virtualMachines
Microsoft Azure Implements Get Virtualmachines In A Subscription
microsoftAzureVirtualmachinesListbysubscription 2 params → 200default
GET
/subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/virtualMachines
Microsoft Azure Implements List Virtual Machine Within Subscription Method
microsoftAzureVirtualmachinesListbysubscription 5 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/virtualMachines
Microsoft Azure Implements List Virtual Machine Within Rg Method
microsoftAzureVirtualmachinesListbyresourcegroup 6 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/virtualMachines/{virtualMachineName}
Microsoft Azure Implements Virtual Machine Get Method
microsoftAzureVirtualmachinesGet 4 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/virtualMachines/{virtualMachineName}
Microsoft Azure Implements Virtual Machine Put Method
microsoftAzureVirtualmachinesCreateorupdate 5 params body → 200201default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/virtualMachines/{virtualMachineName}
Microsoft Azure Implements Virtual Machine Delete Method
microsoftAzureVirtualmachinesDelete 5 params → 202204default
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/virtualMachines/{virtualMachineName}
Microsoft Azure Implements Virtual Machine Patch Method
microsoftAzureVirtualmachinesUpdate 4 params body → 200default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/virtualMachines/{virtualMachineName}/start
Microsoft Azure Implements A Start Method For A Virtual Machine
microsoftAzureVirtualmachinesStart 5 params → 200202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/virtualMachines/{virtualMachineName}/stop
Microsoft Azure Implements Shutdown, Poweroff, And Suspend Method For A Virtual Machine
microsoftAzureVirtualmachinesStop 6 params body → 200202default

Schemas 131

The contract defines 131 schemas that model the data the API accepts and returns. The most detailed are LabVirtualMachineProperties (35 properties), VirtualMachineProperties (23 properties), VirtualMachineProperties_3 (22 properties), VirtualMachineProperties_2 (18 properties). Each schema is shown below with its type and property counts.

FirmwareType
string
Firmware type
OsType_2
string
Defines the different types of VM guest operating systems.
NetworkProfile
object
Specifies the network interfaces of the virtual machine.
1 property
LabVirtualMachine
object
A virtual machine.
1 property 1 required
HostInfoListResult
array
Result of the request to list cluster hosts
OsProfile
object
Specifies the operating system settings for the virtual machine.
12 properties
VirtualDiskUpdate_2
object
Virtual disk model
8 properties
PowerOnBootOption
string
Defines the options for power on boot.
SecurityProfile
object
Specifies the Security profile settings for the virtual machine.
1 property
IPAddressAllocationMethod
string
IP address allocation method.
VirtualDisk
object
Virtual disk model
10 properties
NetworkProfileUpdate
object
Specifies the network interfaces of the virtual machine.
1 property
VirtualMachineUpdateProperties
object
Describes the properties of a Virtual Machine.
5 properties
ExtendedLocation
object
The extended location.
2 properties
VirtualMachinesList
object
List of VirtualMachines.
2 properties 1 required
VirtualMachineListResponse
object
List of virtual machines
2 properties
SharedPublicIpAddressConfiguration
object
Properties of a virtual machine that determine how it is connected to a load balancer.
1 property
NetworkInterfacesUpdate
object
Network Interface model
7 properties
RdpConnection
object
Represents a .rdp file
1 property
StorageProfile
object
Specifies the storage settings for the virtual machine disks.
2 properties
UefiSettings
object
Specifies the security settings like secure boot used while creating the virtual machine.
1 property
Tags
Tags model
IPV4Address
string
CloudError
object
Error from a REST request.
1 property
GalleryImageReference
object
The reference information for an Azure Marketplace image.
5 properties
HostInfo
object
The cluster host information.
3 properties
VirtualMachineProperties_3
object
Properties of virtual machine
22 properties 3 required
VirtualDiskUpdate
object
Defines the virtual disk update.
8 properties
StopVirtualMachineOptions
object
Defines the stop action properties.
1 property
NetworkInterfaceUpdate
object
Defines the network interface update.
5 properties
VirtualMachineStopMode
object
List of virtual machine stop modes
1 property
VirtualMachineProperties
object
Describes the properties of a Virtual Machine.
23 properties
OsProfileUpdate
object
Specifies the operating system settings for the virtual machine.
2 properties
Checkpoint
object
Defines the resource properties.
4 properties
VirtualMachineDeleteCheckpoint
object
Defines the delete checkpoint action properties.
1 property
LinuxParameters
object
Input for InstallPatches on a Linux VM, as directly received by the API
3 properties
GuestAgentProfile
object
Specifies the guest agent settings for the virtual machine.
7 properties
ResizeLabVirtualMachineProperties
object
Request body for resizing a virtual machine.
1 property
VirtualMachineInstallPatchesResult
object
The result summary of an installation operation.
15 properties
ResourceProvisioningState
string
The current deployment state of resource.
LabVirtualMachineList
object
The response of a list operation.
2 properties
NetworkProfileUpdate_2
object
Defines the resource properties.
1 property
AllocationMethod
string
Allocation method.
DataDiskProperties
object
Request body for adding a new or existing data disk to a virtual machine.
3 properties
PatchPayload
object
General patch payload modal
1 property
RunCommandInputParameter
object
Describes the properties of a run command parameter.
2 properties 2 required
PlacementProfile
object
Specifies the compute and storage placement settings for the virtual machine.
4 properties
Schedule
object
A schedule.
1 property 1 required
NetworkInterfaces
object
Network Interface model
11 properties
VirtualDisk_2
object
Virtual disk model
14 properties
ErrorDefinition
object
Error definition.
3 properties
VirtualMachine_3
object
Virtual machine model
6 properties 1 required
ArtifactInstallProperties
object
Properties of an artifact.
7 properties
HourDetails
object
Properties of an hourly schedule.
1 property
GuestAgentProfile_2
object
Defines the resource properties.
6 properties
VirtualMachineCreateCheckpoint
object
Defines the create checkpoint action properties.
2 properties
VirtualNetworkProperties
object
Properties of virtual network
1 property
HardwareProfile
object
Specifies the hardware settings for the virtual machine.
6 properties
ComputeVmInstanceViewStatus
object
Status information about a virtual machine.
3 properties
VirtualMachineInstallPatchesParameters
object
Input for InstallPatches as directly received by the API
4 properties 2 required
NetworkInterfaceProperties
object
Properties of a network interface.
9 properties
OsType
string
Defines the different types of VM guest operating systems.
ApplicableScheduleProperties
object
Properties of a schedules applicable to a virtual machine.
2 properties
StorageProfile_2
object
Defines the resource properties.
1 property
ArtifactDeploymentStatusProperties
object
Properties of an artifact deployment.
3 properties
ArtifactParameterProperties
object
Properties of an artifact parameter.
2 properties
ApplicableSchedule
object
Schedules applicable to a virtual machine. The schedules may have been defined on a VM or on lab level.
1 property 1 required
DiskType
string
Defines the different types of disks.
CSRPErrorBody
object
Error properties
4 properties
DayDetails
object
Properties of a daily schedule.
1 property
ResourceStatus
object
The resource status information.
6 properties
AvailablePatchCountByClassification
object
Summarization of patches available for installation on the machine by classification.
9 properties
RunCommandInput
object
Capture Virtual Machine parameters.
3 properties 1 required
ScheduleProperties
object
Properties of a schedule.
11 properties
NetworkInterface
object
Network Interface model
11 properties
RestartHostsParameters
array
The list of hosts which need to be restarted.
ScheduleCreationParameterProperties
object
Properties for schedule creation.
8 properties
StorageProfileUpdate_2
object
Defines the resource properties.
1 property
VirtualMachine_2
object
The VirtualMachines resource definition.
9 properties 3 required
VirtualMachineUpdate_2
object
Defines the virtualMachineUpdate.
3 properties
HardwareProfileUpdate
object
Defines the resource properties.
6 properties
ScheduleCreationParameter
object
Properties for creating a schedule.
4 properties
VirtualNic
object
Virtual NIC model
8 properties 2 required
StorageQoSPolicyDetails
object
The StorageQoSPolicyDetails definition.
2 properties
StorageProfileUpdate
object
Specifies the storage settings for the virtual machine disks.
1 property
ApplyArtifactsRequest
object
Request body for applying artifacts to a virtual machine.
1 property
SCSIControllerType
string
Defines the different types of SCSI controllers.
VirtualDiskController
object
Virtual disk controller model
4 properties
GuestOSNICCustomization
object
Guest OS nic customization
7 properties
LabVirtualMachineFragment
object
A virtual machine.
WindowsParameters
object
Input for InstallPatches on a Windows VM, as directly received by the API
5 properties
AttachNewDataDiskOptions
object
Properties to attach new disk to the Virtual Machine.
3 properties
NotificationSettings
object
Notification settings for a schedule.
5 properties
ResourcePoolProperties
object
Properties of resource pool
1 property
VirtualMachineUpdate
object
Defines the virtualMachineUpdate.
3 properties
Identity
object
Managed service identity.
3 properties 1 required
DiskMode
string
Defines the different types of disk modes.
DetachDataDiskProperties
object
Request body for detaching data disk from a virtual machine.
1 property
CSRPError
object
General error model
1 property
PatchSettings
object
Specifies the patch settings.
2 properties
RunCommandResult
object
1 property
VirtualMachineRestoreCheckpoint
object
Defines the restore checkpoint action properties.
1 property
ErrorResponse_2
object
Error response.
1 property
LabVirtualMachineProperties
object
Properties of a virtual machine.
35 properties
VirtualMachineAssessPatchesResult
object
Describes the properties of an AssessPatches result.
10 properties
WeekDetails
object
Properties of a weekly schedule.
2 properties
VirtualMachineListResult
object
List of VirtualMachines.
2 properties
GuestAgentProfileUpdate
object
Specifies the guest agent settings for the virtual machine.
1 property
VirtualDisk_3
object
Virtual disk model
5 properties 3 required
VirtualMachine
object
Define the virtualMachine.
10 properties 2 required
ComputeVmProperties
object
Properties of a virtual machine returned by the Microsoft.Compute API.
7 properties
NICType
string
NIC type
VirtualMachineProperties_2
object
Defines the resource properties.
18 properties
HardwareProfile_2
object
Defines the resource properties.
7 properties
Resource
object
An Azure resource.
5 properties
UpdateResource
object
Represents an update resource
1 property
VirtualMachineUpdateProperties_2
object
Defines the resource properties.
5 properties
VirtualSCSIController
object
This data object type contains the properties of a SCSI controller device attached to a virtual machine that is reported by the controller.
5 properties
InboundNatRule
object
A rule for NAT - exposing a VM's port (backendPort) on the public IP address using a load balancer.
3 properties
ResourcePool
object
Resource pool model
6 properties 1 required
NicIPSettings
object
Defines the network interface ip settings.
8 properties
GuestOSCustomization
object
Guest OS Customization properties
5 properties
CloudErrorBody
object
Body of an error from a REST request.
4 properties
ErrorResponse
object
Describes the format of Error response.
2 properties
NicIPAddressSettings
object
IP address information for a virtual network adapter reported by the fabric.
3 properties
OsProfile_2
object
Defines the resource properties.
4 properties
VirtualNetwork
object
Virtual network model
6 properties 1 required
ComputeDataDisk
object
A data disks attached to a virtual machine.
4 properties
VirtualSCSISharing
string
Defines the sharing mode for sharing the SCSI bus.
NetworkProfile_2
object
Defines the resource properties.
1 property
AvailabilitySetList
array
Availability Sets in vm.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-azure-virtualmachines-api-openapi.yml Raw ↑

Other APIs Microsoft Azure publishes across the network.

Microsoft Azure AI Search API
AE Profile APIs.io
Microsoft Azure Communication Services API
AE Profile APIs.io
Microsoft Azure Event Grid API
AE Profile APIs.io
Microsoft Azure Functions API
AE Profile APIs.io
Microsoft Azure DevOps REST API
AE Profile APIs.io
Microsoft Azure AI Foundry API
AE Profile APIs.io
Microsoft Azure Resource JSON Schema
AE Profile APIs.io
Microsoft Azure JSON-LD Context
AE Profile APIs.io
Microsoft Azure AccessConnector API
AE Profile APIs.io
Microsoft Azure AccessControlRecords API
AE Profile APIs.io
Microsoft Azure AccessPolicies API
AE Profile APIs.io
Microsoft Azure AccessReviewInstanceAcceptRecommmendations API
AE Profile APIs.io
#Virtual Machines
← Back to M APIs
API Details
ID
microsoft-azure:microsoft-azure-virtualmachines-api
Docs
https://learn.microsoft.com/en-us/rest/api/azure/
Provider
Microsoft Azure
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=microsoft-azure-virtualmachines-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/microsoft-azure-virtualmachines-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Microsoft Azure VirtualMachines 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.