Get Service Account Data

You can get data on a service account with the specified ID.

Request

To retrieve information on a specific service account, send the HTTP GET request to the /accounts/azure/service/{accountId} endpoint. {accountId} is a system ID assigned to the service account  in the Veeam Backup for Microsoft Azure REST API.

HTTP Request

GET https://<hostname>/api/v2/accounts/azure/service/{accountId}

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 service account with the specified ID. The AzureAccountV2 schema is used for the resource representation.

Get Service Account DataExample

The following request returns information on a service account with the ID 1.

Request:

GET https://51.11.247.127/api/v2/accounts/azure/service/1

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200

 

Response Body:

{

  "connectionId": 1,

  "applicationId": "70c4e044-31b5-4c16-s84a-89550aaed346",

  "name": "Azure Connection",

  "description": "none",

  "region": "Global",

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

  "_links":    {

     "self": {"href": "https://51.11.247.127/api/v2/accounts/1"},

     "subscriptions": {"href": "https://51.11.247.127/api/v2/cloudInfrastructure/subscriptions?connectionId=1"}

  },

  "connectionType": "Device Authentication",

  "expirationDate": "2021-01-28T08:15:48.175376Z",

  "connectionState": "Created",

  "connectionUseType": "Service"

}

I want to report a typo

There is a misspelling right here:

 

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