Microsoft Entra Tenants

The /cloudInfrastructure/tenants resource collection represents tenants available to service accounts added to the Veeam Backup for Microsoft Azure configuration database.

Get Collection of Tenants

The HTTP GET request to the /cloudInfrastructure/tenants endpoint retrieves a list of tenants in which Azure resources protected by Veeam backup for Microsoft Azure reside.

SecurityBearer

Request

query Parameters

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: TenantOptions
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

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8/cloudInfrastructure/tenants

Request samples

curl

curl -i -X GET \
  'https://123.123.123.123/api/v8/cloudInfrastructure/tenants?SearchPattern=string&Offset=0&Limit=-1' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"startTime": "2019-08-24T14:15:22Z",
"status": "Canceled",
"error": {"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"extensions": {"property1": { },
"property2": { }
}
},
"_links": {"property1": {"href": "http://example.com"
},
"property2": {"href": "http://example.com"
}
},
"result": {"offset": 0,
"limit": 0,
"totalCount": 0,
"_links": {"property1": {"href": "http://example.com"
},
"property2": {"href": "http://example.com"
}
},
"results": [{"tenantId": "string",
"name": "string",
"_links": {"property1": {"href": "http://example.com"
},
"property2": {"href": "http://example.com"
}
}
}
]
}
}

Get Tenants by Service Account

The HTTP GET request to the /cloudInfrastructure/tenants/withAccount endpoint retrieves tenants with information on service accounts linked to these tenants.

SecurityBearer

Request

query Parameters

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: TenantWithAccountOptions
Sync	boolean or null Defines whether to force rescanning of the Microsoft Azure infrastructure before the response. x-veeam-parameter-group: TenantWithAccountOptions
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

Responses

200

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8/cloudInfrastructure/tenants/withAccount

Request samples

curl

curl -i -X GET \
  'https://123.123.123.123/api/v8/cloudInfrastructure/tenants/withAccount?SearchPattern=string&Sync=true&Offset=0&Limit=-1' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"offset": 0,
"limit": 0,
"totalCount": 0,
"_links": {"property1": {"href": "http://example.com"
},
"property2": {"href": "http://example.com"
}
},
"results": [{"id": "string",
"account": {"accountId": "string",
"applicationId": "97ab27fa-30e2-43e3-92a3-160e80f4c0d5",
"applicationCertificateName": "string",
"name": "string",
"description": "string",
"region": "Global",
"tenantId": "string",
"tenantName": "string",
"accountOrigin": "Device Authentication",
"expirationDate": "2019-08-24T14:15:22Z",
"accountState": "Created",
"adGroupId": "9a83eeeb-9c7f-43c1-8266-9a86d08b7e4a",
"cloudState": "Unknown",
"adGroupName": "string",
"purposes": ["None"
],
"managementGroupId": "string",
"managementGroupName": "string",
"subscriptionIds": ["string"
],
"selectedForWorkermanagement": true,
"azurePermissionsState": ["AllPermissionsAvailable"
],
"azurePermissionsStateCheckTimeUtc": "2019-08-24T14:15:22Z",
"subscriptionIdForWorkerDeployment": "fa8415e4-16b1-41c7-a585-5c880fe4dc6f",
"_links": {"property1": {"href": "http://example.com"
},
"property2": {"href": "http://example.com"
}
}
},
"tenantId": "string",
"name": "string",
"_links": {"property1": {"href": "http://example.com"
},
"property2": {"href": "http://example.com"
}
}
}
]
}

Get Tenant Data

The HTTP GET request to the /cloudInfrastructure/tenants/{tenantId} endpoint retrieves information on a tenant with the specified ID.

SecurityBearer

Request

path Parameters

tenantId

required

string <uuid>

Microsoft Entra tenant ID.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

get/api/v8/cloudInfrastructure/tenants/{tenantId}

Request samples

curl

curl -i -X GET \
  'https://123.123.123.123/api/v8/cloudInfrastructure/tenants/{tenantId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"tenantId": "string",
"name": "string",
"_links": {"property1": {"href": "http://example.com"
},
"property2": {"href": "http://example.com"
}
}
}