This is an archive version of the document. To get the most up-to-date information, see the current version.Get Collection of Virtual Machines
You can get a list of all Azure VMs that can be protected by Veeam Backup for Microsoft Azure.
Request
To retrieve a representation of a collection of protected Azure VMs, send the HTTP GET request to the /virtualMachines endpoint.
HTTP Request
GET https://<hostname>/api/v2/virtualMachines |
Query Parameters
To control the amount and order of data in the response, you can use Offset, Limit, SearchPattern and the following query parameters:
Query Parameter | Value | Description |
|---|---|---|
SubscriptionId | string($uuid) | Returns only Azure VMs that belong to the specified subscription. For more information, see Filter Parameters. |
ResourceGroupId | string | Returns only Azure VMs that belong to the specified resource group. For more information, see Filter Parameters. |
TenantId | string | Returns only Azure VMs that belong to the specified tenant. For more information, see Filter Parameters. |
RegionIds | array[string] | Returns only Azure VMs that reside in the specified Azure regions. For more information, see Filter Parameters. |
ProtectionStatus |
| Returns only Azure VMs with the specified protection status. For more information, see Filter Parameters. |
BuckupDestination |
| Returns only Azure VMs with the specified backup destination. For more information, see Filter Parameters. |
Sync | boolean | Defines whether Veeam Backup for Microsoft Azure database is synchronized with the Azure resources. |
ExistsState |
| Returns only Azure VMs with the specified state. For more information, see Filter Parameters. |
VmFromProtectedRegions | boolean | Defines whether an Azure VM resides in the protected region. |
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 |
| 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 /virtualMachines collection. The VirtualMachineV2 schema is used for the collection representation.
Example
The following request returns a full list of Azure VMs that can be protected.
|