Get Collection of Azure Tags

You can get a list of all Azure tags assigned to Azure resources to which Veeam Backup for Microsoft Azure has permissions.

Request

To retrieve a representation of a collection of Azure tags, send the HTTP GET request to the /cloudInfrastructure/tags endpoint.

HTTP Request

GET https://<hostname>/api/v2/cloudInfrastructure/tags

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

TenantId

string($uuid)

Azure ID assigned to a tenant in Veeam Backup for Microsoft Azure v2.

Sync

booelan

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

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 /tags collection. The TagV2 schema is used for the collection representation.

Get Collection of Azure TagsExample

The following request returns a full list of Azure tags.

Request:

GET https://51.11.247.127/api/v2/cloudInfrastructure/tags

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200

 

Response Body:

{

 "offset": 0,

 "limit": 5,

 "totalCount": 125,

 "results": [

   {

     "id": "7arxyrrz439aqpf98n1mtr7e9tbj5neh9et51c81osqc4afqk13y",

     "name": "Name",

     "value": "Value"

   },

   {

     "id": "n8faeu68wtt7ikhww9ydjqu9u9aa1c8purogr6zrdzb8eg4a35io",

     "name": "backup_file",

     "value": "Value"

   },

   {

     "id": "1bzhutpgwx73bdrrssoy4za4o89w79uuciohazfxobutf6nuq34y",

     "name": "auto-backup",

     "value": "false"

   },

   {

     "id": "8f4swb8cpaxxmi8gkj7j81drrxebu4rfg9dnip7e4zz56e4iey4o",

     "name": "sync",

     "value": "true"

   },

   {

     "id": "sh4mdbmt3rz3wwrgphuxeycgtuh4364z94d6noqq1a1q43t9kc1o",

     "name": "obsoleteSnapshot",

     "value": "delete"

   }

 ],

 "_links": {

   "self": {

     "href": "https://51.11.247.127/api/v2/cloudInfrastructure/tags?offset=0&limit=5"

   },

   "next": {

     "href": "https://51.11.247.127/api/v2/cloudInfrastructure/tags?offset=5&limit=5"

   }

 }

}

I want to report a typo

There is a misspelling right here:

 

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