Azure Tags

The /cloudInfrastructure/tags resource collection represents Azure tags that can be assigned to Microsoft Azure resources.

Get Collection of Azure Tags

The HTTP GET request to the /cloudInfrastructure/tags endpoint retrieves a list of all Azure tags assigned to Azure resources to which Veeam Backup for Microsoft Azure has permissions.

SecurityBearer
Request
query Parameters
Offset
integer <int32> >= 0

Specifies the first N items of a resource collection that will be excluded from the response.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
Limit
integer <int32> >= -1

Specifies the maximum number of items of a resource collection that will be returned in the response.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
TenantId
string or null <uuid>

Returns only Azure tags that belong to a tenant with the specified ID.

x-veeam-parameter-group: TagOptions
ServiceAccountId
string

Returns only Azure tags to which a service account with the specified system ID has permissions.

x-veeam-parameter-group: TagOptions
SearchPattern
string or null

Returns only those items of a resource collection whose names match the specified search pattern in the parameter value.

x-veeam-parameter-group: TagOptions
Sync
boolean or null

Defines whether to force rescanning of the Microsoft Azure infrastructure before the response.

x-veeam-parameter-group: TagOptions
Responses
200

OK

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8/cloudInfrastructure/tags
Request samples
curl -i -X GET \
  'https://123.123.123.123/api/v8/cloudInfrastructure/tags?Offset=0&Limit=-1&TenantId=497f6eca-6276-4993-bfeb-53cbbbba6f08&ServiceAccountId=string&SearchPattern=string&Sync=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "_links": {},
  • "results": [
    ]
}