Get Collection of Protected Azure VMs

In this article

    You can get a list of all protected Azure VMs.

    Request

    To retrieve a representation of a collection of protected Azure VMs, send the HTTP GET request to the /protectedItem/vm endpoint.

    HTTP Request

    GET https://<hostname>/api/v3/protectedItem/vm

    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

    Sync

    boolean

    Defines whether Veeam Backup for Microsoft Azure database is synchronized with Azure resources.

    FlrSession

    boolean

    Returns only Azure VMs added to the File-level recovery

    DataRetrievalStatuses

    array

    Returns only Azure VMs with a specific retrieval status: None, Retrieving, Retrieved.

    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 /protectedItem/vm collection. The ProtectedVirtualMachinev3 schema is used for the collection representation.

    Get Collection of Protected ItemsExample

    The following request returns a full list of protected items.

    Request:

    GET https://51.11.247.127/api/v3/protectedItem/vm

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response:

    200

     

    Response Body:

    {

     "offset": 0,

     "limit": 200,

     "totalCount": 5,

     "results": [

       {

         "id": "4w376jgoh5yd8xrxbmzjpq9f7f75gs89r4t4u1bo7of1f9imt5my",

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

         "name": "cpm-vm",

         "azureEnvironment": "Global",

         "osType": "Linux",

         "regionName": "Central US",

         "totalSizeInGB": 30,

         "vmSize": "Standard_D2s_v3",

         "hasEphemeralOsDisk": false,

         "isController": true,

         "lastBackup": "2020-11-24T08:00:19.646754Z",

         "subscription": {

           "id": "3a9a4930-7bbc-4b83-9c68-15d674fbc803",

           "environment": "Global",

           "tenantId": "3e924ba9-93bc-40d5-8a47-33f07b239a52",

           "name": "Visual Studio Premium MSDN",

           "status": "Active"

         },

         "region": {

           "id": "centralus",

           "name": "Central US"

         },

         "resourceGroup": {

           "id": "e4znpesnkxs8gzmbw76gkm8crze3dx1anjqc5g8a6t5joikkjfbo",

           "resourceId": "/subscriptions/3a9a4930-7bbc-4b83-9c68-15d674fbc803/resourcegroups/cpm-backup-martin",

           "name": "cpm-backup-martin",

           "azureEnvironment": "Global",

           "subscriptionId": "3a9a4930-7bbc-4b83-9c68-15d674fbc803",

           "regionId": "northeurope"

         },

         "_links": {

           "restorepoint": {

             "href": "https://51.11.247.127/api/v3/restorePoints/1d38dc9d-e3ec-4828-95c0-75f90c8b84b3"

           },

           "subscription": {

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

           },

           "resourcegroup": {

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

           }

         }

       },

       {

         "id": "oqedma7doo56krcqzp15xbdffenfpgcjzxpekgqnmw6dx65rnyxo",

         "azureId": "/subscriptions/3a9a4930-7bbc-4b83-9c68-15d674fbc803/resourcegroups/res_gr/providers/microsoft.compute/virtualmachines/bogatov",

         "name": "Tech.cpm",

         "azureEnvironment": "Global",

         "osType": "Linux",

         "regionName": "UK West",

         "totalSizeInGB": 30,

         "vmSize": "Standard_B2s",

         "hasEphemeralOsDisk": false,

         "isController": false,

         "lastBackup": "2020-11-24T20:00:18.486055Z",

         "subscription": {

           "id": "3a9a4930-7bbc-4b83-9c68-15d674fbc803",

           "environment": "Global",

           "tenantId": "3e924ba9-93bc-40d5-8a47-33f07b239a52",

           "name": "Visual Studio Premium MSDN",

           "status": "Active"

         },

         "region": {

           "id": "ukwest",

           "name": "UK West"

         },

         "resourceGroup": {

           "id": "1yb941zuh6ze8bmfsnqcwot7i8wi8p5ufy34nc7mxiaq5z6mmc6y",

           "resourceId": "/subscriptions/3a9a4930-7bbc-4b83-9c68-15d674fbc803/resourcegroups/bogatov",

           "name": "bogatov",

           "azureEnvironment": "Global",

           "subscriptionId": "3a9a4930-7bbc-4b83-9c68-15d674fbc803",

           "regionId": "ukwest"

         },

         "_links": {

           "restorepoint": {

             "href": "https://51.11.247.127/api/v3/restorePoints/376c31de-e2ee-4316-b3f7-324c1181e3a4"

           },

           "subscription": {

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

           },

           "resourcegroup": {

             "href": "https://51.11.247.127/api/v3/cloudInfrastructure/resourceGroups/1yb941zuh6ze8bmfsnqcwot7i8wi8p5ufy34nc7mxiaq5z6mmc6y"

           }

         }

       },

       {

         "id": "t9n4b5ky6gnhpurroj3srckqywxj34rmrby6zthnypg9an76shty",

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

         "name": "backup-test",

         "azureEnvironment": "Global",

         "osType": "Linux",

         "regionName": "UK West",

         "totalSizeInGB": 30,

         "vmSize": "Standard_B1ls",

         "hasEphemeralOsDisk": false,

         "isController": false,

         "lastBackup": "2020-11-24T20:00:17.876683Z",

         "subscription": {

           "id": "3a9a4930-7bbc-4b83-9c68-15d674fbc803",

           "environment": "Global",

           "tenantId": "3e924ba9-93bc-40d5-8a47-33f07b239a52",

           "name": "Visual Studio Premium MSDN",

           "status": "Active"

         },

         "region": {

           "id": "ukwest",

           "name": "UK West"

         },

         "resourceGroup": {

           "id": "58hhkkkfnit3738k76agx7b76nu6de18nssz9gxnr71za7hphr1o",

           "resourceId": "/subscriptions/3a9a4930-7bbc-4b83-9c68-15d674fbc803/resourcegroups/cpm-backup-luaan",

           "name": "cpm-backup-luaan",

           "azureEnvironment": "Global",

           "subscriptionId": "3a9a4930-7bbc-4b83-9c68-15d674fbc803",

           "regionId": "northeurope"

         },

         "_links": {

           "restorepoint": {

             "href": "https://51.11.247.127/api/v3/restorePoints/4123c22a-7b28-46b4-9e1c-98cb0f83b7cd"

           },

           "subscription": {

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

           },

           "resourcegroup": {

             "href": "https://51.11.247.127/api/v3/cloudInfrastructure/resourceGroups/58hhkkkfnit3738k76agx7b76nu6de18nssz9gxnr71za7hphr1o"

           }

         }

       },

       {

         "id": "fdydnccas19nbuehqbiaxo6j5bku33i58xahpwcye6xc7g9n8nyy",

         "azureId": "/subscriptions/3a9a4930-7bbc-4b83-9c68-15d674fbc803/resourcegroups/bogatovflr/providers/microsoft.compute/virtualmachines/test",

         "name": "test",

         "azureEnvironment": "Global",

         "osType": "Linux",

         "regionName": "UK West",

         "totalSizeInGB": 30,

         "vmSize": "Standard_A1_v3",

         "hasEphemeralOsDisk": false,

         "isController": false,

         "lastBackup": "2020-11-24T20:00:17.907995Z",

         "subscription": {

           "id": "3a9a4930-7bbc-4b83-9c68-15d674fbc803",

           "environment": "Global",

           "tenantId": "3e924ba9-93bc-40d5-8a47-33f07b239a52",

           "name": "Visual Studio Premium MSDN",

           "status": "Active"

         },

         "region": {

           "id": "ukwest",

           "name": "UK West"

         },

         "resourceGroup": {

           "id": "hmdhjx4zmiooog5qg3iy9x7fhjoh3ima7js4y135u7yrcnhak1qo",

           "resourceId": "/subscriptions/3a9a4930-7bbc-4b83-9c68-15d674fbc803/resourcegroups/bogatovflr",

           "name": "flr",

           "azureEnvironment": "Global",

           "subscriptionId": "3a9a4930-7bbc-4b83-9c68-15d674fbc803",

           "regionId": "ukwest"

         },

         "_links": {

           "restorepoint": {

             "href": "https://51.11.247.127/api/v3/restorePoints/5c0f18da-8ba5-4062-ab45-3bd16b56b259"

           },

           "subscription": {

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

           },

           "resourcegroup": {

             "href": "https://51.11.247.127/api/v3/cloudInfrastructure/resourceGroups/hmdhjx4zmiooog5qg3iy9x7fhjoh3ima7js4y135u7yrcnhak1qo"

           }

         }

       },

       {

         "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": "UK West",

         "totalSizeInGB": 30,

         "vmSize": "Standard_B1ls",

         "hasEphemeralOsDisk": false,

         "isController": false,

         "lastBackup": "2020-11-24T20:00:16.798536Z",

         "subscription": {

           "id": "3a9a4930-7bbc-4b83-9c68-15d674fbc803",

           "environment": "Global",

           "tenantId": "3e924ba9-93bc-40d5-8a47-33f07b239a52",

           "name": "Visual Studio Premium MSDN",

           "status": "Active"

         },

         "region": {

           "id": "ukwest",

           "name": "UK West"

         },

         "resourceGroup": {

           "id": "e4znpesnkxs8gzmbw76gkm8crze3dx1anjqc5g8a6t5joikkjfbo",

           "resourceId": "/subscriptions/3a9a4930-7bbc-4b83-9c68-15d674fbc803/resourcegroups/cpm-backup-martin",

           "name": "cpm-backup-martin",

           "azureEnvironment": "Global",

           "subscriptionId": "3a9a4930-7bbc-4b83-9c68-15d674fbc803",

           "regionId": "northeurope"

         },

         "_links": {

           "restorepoint": {

             "href": "https://51.11.247.127/api/v3/restorePoints/c4bffb71-24a3-43bb-8593-c7435efaba89"

           },

           "subscription": {

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

           },

           "resourcegroup": {

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

           }

         }

       }

     ],

     "_links": {

       "self": {

         "href": "https://51.11.247.127/api/v3/protectedItem?offset=0&limit=200"

       }

     }

    }