{ "opencollection": "1.0.0", "info": { "name": "Azure REST Virtual Machines API", "version": "2024-07-01" }, "request": { "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "credentials": { "clientId": "{{clientId}}" } } }, "items": [ { "info": { "name": "Virtual Machines", "type": "folder" }, "items": [ { "info": { "name": "Azure Virtual Machines List virtual machines in a resource group", "type": "http" }, "http": { "method": "GET", "url": "https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The name of the resource group." }, { "name": "api-version", "value": "", "type": "query", "description": "Client API version." }, { "name": "$filter", "value": "", "type": "query", "description": "The system query option to filter VMs returned in the response. Allowed value is 'virtualMachineScaleSet/id' eq /subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmssName}'." }, { "name": "$expand", "value": "", "type": "query", "description": "The expand expression to apply on the operation. 'instanceView' retrieves a snapshot of the runtime properties of the virtual machine that is managed by the platform and can change outside of control plane operations." } ] }, "docs": "Lists 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." }, { "info": { "name": "Azure Virtual Machines List all virtual machines in a subscription", "type": "http" }, "http": { "method": "GET", "url": "https://management.azure.com/subscriptions/:subscriptionId/providers/Microsoft.Compute/virtualMachines", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, { "name": "api-version", "value": "", "type": "query", "description": "Client API version." }, { "name": "statusOnly", "value": "", "type": "query", "description": "statusOnly=true enables fetching run time status of all Virtual Machines in the subscription." }, { "name": "$filter", "value": "", "type": "query", "description": "The system query option to filter VMs returned in the response." }, { "name": "$expand", "value": "", "type": "query", "description": "The expand expression to apply on the operation." } ] }, "docs": "Lists all of the virtual machines in the specified subscription. Use the nextLink property in the response to get the next page of virtual machines." }, { "info": { "name": "Azure Virtual Machines List virtual machines by location", "type": "http" }, "http": { "method": "GET", "url": "https://management.azure.com/subscriptions/:subscriptionId/providers/Microsoft.Compute/locations/:location/virtualMachines", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, { "name": "location", "value": "", "type": "path", "description": "The location for which virtual machines are listed." }, { "name": "api-version", "value": "", "type": "query", "description": "Client API version." } ] }, "docs": "Gets all the virtual machines under the specified subscription for the specified location." }, { "info": { "name": "Azure Virtual Machines Get a virtual machine", "type": "http" }, "http": { "method": "GET", "url": "https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The name of the resource group." }, { "name": "vmName", "value": "", "type": "path", "description": "The name of the virtual machine." }, { "name": "api-version", "value": "", "type": "query", "description": "Client API version." }, { "name": "$expand", "value": "", "type": "query", "description": "The expand expression to apply on the operation. 'instanceView' retrieves a snapshot of the runtime properties of the virtual machine." } ] }, "docs": "Retrieves information about the model view or the instance view of a virtual machine." }, { "info": { "name": "Azure Virtual Machines Create or update a virtual machine", "type": "http" }, "http": { "method": "PUT", "url": "https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The name of the resource group." }, { "name": "vmName", "value": "", "type": "path", "description": "The name of the virtual machine." }, { "name": "api-version", "value": "", "type": "query", "description": "Client API version." } ], "body": { "type": "json", "data": "{}" } }, "docs": "The operation to create or update a virtual machine. Please note some properties can be set only during virtual machine creation." }, { "info": { "name": "Azure Virtual Machines Update a virtual machine", "type": "http" }, "http": { "method": "PATCH", "url": "https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The name of the resource group." }, { "name": "vmName", "value": "", "type": "path", "description": "The name of the virtual machine." }, { "name": "api-version", "value": "", "type": "query", "description": "Client API version." } ], "body": { "type": "json", "data": "{}" } }, "docs": "The operation to update a virtual machine." }, { "info": { "name": "Azure Virtual Machines Delete a virtual machine", "type": "http" }, "http": { "method": "DELETE", "url": "https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The name of the resource group." }, { "name": "vmName", "value": "", "type": "path", "description": "The name of the virtual machine." }, { "name": "api-version", "value": "", "type": "query", "description": "Client API version." }, { "name": "forceDeletion", "value": "", "type": "query", "description": "Optional parameter to force delete virtual machines." } ] }, "docs": "The operation to delete a virtual machine." }, { "info": { "name": "Azure Virtual Machines Get the instance view of a virtual machine", "type": "http" }, "http": { "method": "GET", "url": "https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/instanceView", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The name of the resource group." }, { "name": "vmName", "value": "", "type": "path", "description": "The name of the virtual machine." }, { "name": "api-version", "value": "", "type": "query", "description": "Client API version." } ] }, "docs": "Retrieves information about the run-time state of a virtual machine." }, { "info": { "name": "Azure Virtual Machines Start a virtual machine", "type": "http" }, "http": { "method": "POST", "url": "https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/start", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The name of the resource group." }, { "name": "vmName", "value": "", "type": "path", "description": "The name of the virtual machine." }, { "name": "api-version", "value": "", "type": "query", "description": "Client API version." } ] }, "docs": "The operation to start a virtual machine." }, { "info": { "name": "Azure Virtual Machines Power off a virtual machine", "type": "http" }, "http": { "method": "POST", "url": "https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/powerOff", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The name of the resource group." }, { "name": "vmName", "value": "", "type": "path", "description": "The name of the virtual machine." }, { "name": "api-version", "value": "", "type": "query", "description": "Client API version." }, { "name": "skipShutdown", "value": "", "type": "query", "description": "The parameter to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise." } ] }, "docs": "The 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 virtual machine." }, { "info": { "name": "Azure Virtual Machines Deallocate a virtual machine", "type": "http" }, "http": { "method": "POST", "url": "https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/deallocate", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The name of the resource group." }, { "name": "vmName", "value": "", "type": "path", "description": "The name of the virtual machine." }, { "name": "api-version", "value": "", "type": "query", "description": "Client API version." }, { "name": "hibernate", "value": "", "type": "query", "description": "Optional parameter to hibernate a virtual machine." } ] }, "docs": "Shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses." }, { "info": { "name": "Azure Virtual Machines Restart a virtual machine", "type": "http" }, "http": { "method": "POST", "url": "https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/restart", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The name of the resource group." }, { "name": "vmName", "value": "", "type": "path", "description": "The name of the virtual machine." }, { "name": "api-version", "value": "", "type": "query", "description": "Client API version." } ] }, "docs": "The operation to restart a virtual machine." }, { "info": { "name": "Azure Virtual Machines Redeploy a virtual machine", "type": "http" }, "http": { "method": "POST", "url": "https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/redeploy", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The name of the resource group." }, { "name": "vmName", "value": "", "type": "path", "description": "The name of the virtual machine." }, { "name": "api-version", "value": "", "type": "query", "description": "Client API version." } ] }, "docs": "Shuts down the virtual machine, moves it to a new node, and powers it back on." }, { "info": { "name": "Azure Virtual Machines Reimage a virtual machine", "type": "http" }, "http": { "method": "POST", "url": "https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/reimage", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The name of the resource group." }, { "name": "vmName", "value": "", "type": "path", "description": "The name of the virtual machine." }, { "name": "api-version", "value": "", "type": "query", "description": "Client API version." } ] }, "docs": "Reimages (upgrades the operating system) a virtual machine which does not have an ephemeral OS disk. For virtual machines that have an ephemeral OS disk, the virtual machine is reset to initial state." }, { "info": { "name": "Azure Virtual Machines Capture a virtual machine", "type": "http" }, "http": { "method": "POST", "url": "https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/capture", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The name of the resource group." }, { "name": "vmName", "value": "", "type": "path", "description": "The name of the virtual machine." }, { "name": "api-version", "value": "", "type": "query", "description": "Client API version." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Captures the VM by copying virtual hard disks of the VM and outputs a template that can be used to create similar VMs." }, { "info": { "name": "Azure Virtual Machines Generalize a virtual machine", "type": "http" }, "http": { "method": "POST", "url": "https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/generalize", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The name of the resource group." }, { "name": "vmName", "value": "", "type": "path", "description": "The name of the virtual machine." }, { "name": "api-version", "value": "", "type": "query", "description": "Client API version." } ] }, "docs": "Sets the OS state of the virtual machine to generalized. It is recommended to sysprep the virtual machine before performing this operation." }, { "info": { "name": "Azure Virtual Machines Convert to managed disks", "type": "http" }, "http": { "method": "POST", "url": "https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/convertToManagedDisks", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The name of the resource group." }, { "name": "vmName", "value": "", "type": "path", "description": "The name of the virtual machine." }, { "name": "api-version", "value": "", "type": "query", "description": "Client API version." } ] }, "docs": "Converts virtual machine disks from blob-based to managed disks. Virtual machine must be stop-deallocated before invoking this operation." }, { "info": { "name": "Azure Virtual Machines Perform maintenance on a virtual machine", "type": "http" }, "http": { "method": "POST", "url": "https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/performMaintenance", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The name of the resource group." }, { "name": "vmName", "value": "", "type": "path", "description": "The name of the virtual machine." }, { "name": "api-version", "value": "", "type": "query", "description": "Client API version." } ] }, "docs": "The operation to perform maintenance on a virtual machine." }, { "info": { "name": "Azure Virtual Machines Simulate eviction of a spot virtual machine", "type": "http" }, "http": { "method": "POST", "url": "https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/simulateEviction", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The name of the resource group." }, { "name": "vmName", "value": "", "type": "path", "description": "The name of the virtual machine." }, { "name": "api-version", "value": "", "type": "query", "description": "Client API version." } ] }, "docs": "The operation to simulate the eviction of a spot virtual machine." }, { "info": { "name": "Azure Virtual Machines Reapply a virtual machine state", "type": "http" }, "http": { "method": "POST", "url": "https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/reapply", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The name of the resource group." }, { "name": "vmName", "value": "", "type": "path", "description": "The name of the virtual machine." }, { "name": "api-version", "value": "", "type": "query", "description": "Client API version." } ] }, "docs": "The operation to reapply a virtual machine's state." }, { "info": { "name": "Azure Virtual Machines Retrieve boot diagnostics data", "type": "http" }, "http": { "method": "POST", "url": "https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/retrieveBootDiagnosticsData", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The name of the resource group." }, { "name": "vmName", "value": "", "type": "path", "description": "The name of the virtual machine." }, { "name": "api-version", "value": "", "type": "query", "description": "Client API version." }, { "name": "sasUriExpirationTimeInMinutes", "value": "", "type": "query", "description": "Expiration duration in minutes for the SAS URIs with a value between 1 to 1440 minutes." } ] }, "docs": "The operation to retrieve SAS URIs for a virtual machine's boot diagnostic logs." }, { "info": { "name": "Azure Virtual Machines Assess patches on a virtual machine", "type": "http" }, "http": { "method": "POST", "url": "https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/assessPatches", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The name of the resource group." }, { "name": "vmName", "value": "", "type": "path", "description": "The name of the virtual machine." }, { "name": "api-version", "value": "", "type": "query", "description": "Client API version." } ] }, "docs": "Assess patches on the VM." }, { "info": { "name": "Azure Virtual Machines Install patches on a virtual machine", "type": "http" }, "http": { "method": "POST", "url": "https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/installPatches", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The name of the resource group." }, { "name": "vmName", "value": "", "type": "path", "description": "The name of the virtual machine." }, { "name": "api-version", "value": "", "type": "query", "description": "Client API version." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Installs patches on the VM." }, { "info": { "name": "Azure Virtual Machines Attach or detach data disks", "type": "http" }, "http": { "method": "POST", "url": "https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/attachDetachDataDisks", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The name of the resource group." }, { "name": "vmName", "value": "", "type": "path", "description": "The name of the virtual machine." }, { "name": "api-version", "value": "", "type": "query", "description": "Client API version." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Attach and detach data disks to/from the virtual machine." }, { "info": { "name": "Azure Virtual Machines List available sizes for a virtual machine", "type": "http" }, "http": { "method": "GET", "url": "https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/vmSizes", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The name of the resource group." }, { "name": "vmName", "value": "", "type": "path", "description": "The name of the virtual machine." }, { "name": "api-version", "value": "", "type": "query", "description": "Client API version." } ] }, "docs": "Lists all available virtual machine sizes to which the specified virtual machine can be resized." }, { "info": { "name": "Azure Virtual Machines Run command on a virtual machine", "type": "http" }, "http": { "method": "POST", "url": "https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/runCommand", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The name of the resource group." }, { "name": "vmName", "value": "", "type": "path", "description": "The name of the virtual machine." }, { "name": "api-version", "value": "", "type": "query", "description": "Client API version." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Run command on the VM." } ] } ], "bundled": true }