Get Virtual Machine Data

You can get data on an Azure VM with the specified ID.

Request

To retrieve information on a Azure VM, send the HTTP GET request to the /virtualMachines/{id} endpoint. {id} is a system ID assigned to the Azure VM in the Veeam Backup for Microsoft Azure REST API.

HTTP Request

GET https://<hostname>/api/v2/virtualMachines/{id}

Request Headers

The request contains the following headers.

Header

Required

Value

Description

Authorization

Required

Bearer <Access-Token>

Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format.

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns a response code 200 (OK).

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTP headers.

Header

Value

Description

Content-length

integer

Identifies the length of the response body message, in bytes.

Content-type

  • application/json
  • application/problem+json

Identifies the media type of the response body message.

Response Body

In the response body, Veeam Backup for Microsoft Azure returns a representation of the Azure VM with the specified ID. The VirtualMachineV2 schema is used for the resource representation.

Get Virtual Machine DataExample

The following request returns information on an Azure VM with the ID b45yr8nr5zj684pdjoejkmadcrezdjp8esz63tc6iqd9eq6rfcby.

Request:

GET https://51.11.247.127/api/v2/virtualMachines/b45yr8nr5zj684pdjoejkmadcrezdjp8esz63tc6iqd9eq6rfcby

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200

 

Response Body:

{

 "id": "b45yr8nr5zj684pdjoejkmadcrezdjp8esz63tc6iqd9eq6rfcby",

 "azureId": "/subscriptions/3a9a4930-7bbc-4b83-9c68-15d674fbc803/resourcegroups/cpm-backup-martin/providers/microsoft.compute/virtualmachines/000000000000000y",

 "name": "000000000000000y",

 "azureEnvironment": "Global",

 "osType": "Linux",

 "regionName": "ukwest",

 "totalSizeInGB": 30,

 "vmSize": "Standard_B1ls",

 "virtualNetwork": "cpmbackupmartinvnet218",

 "subnet": "default",

 "privateIP": "10.2.20.4",

 "hasEphemeralOsDisk": false,

 "isController": false,

 "isDeleted": false,

 "_links": {

   "subscription": {

     "href": "https://51.11.247.127/api/v2/cloudInfrastructure/subscriptions/3a9a4930-7bbc-4b83-9c68-15d674fbc803"

   },

   "resourcegroup": {

     "href": "https://51.11.247.127/api/v2/cloudInfrastructure/resourceGroups/e4znpesnkxs8gzmbw76gkm8crze3dx1anjqc5g8a6t5joikkjfbo"

   },

   "policies": {

     "href": "https://51.11.247.127/api/v2/policies?virtualMachineId=b45yr8nr5zj684pdjoejkmadcrezdjp8esz63tc6iqd9eq6rfcby"

   },

   "restorepoints": {

     "href": "https://51.11.247.127/api/v2/restorePoints?virtualMachineId=b45yr8nr5zj684pdjoejkmadcrezdjp8esz63tc6iqd9eq6rfcby&onlyLatest=False"

   },

   "self": {

     "href": "https://51.11.247.127/api/v2/virtualMachines/b45yr8nr5zj684pdjoejkmadcrezdjp8esz63tc6iqd9eq6rfcby"

   }

 }

}

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.