Edit Service Account Created Using Existing Application

You can update a service account with the specified ID.

Request

To update a service account settings, send the HTTP PUT request to the /accounts/azure/service/updateByApp/{accountId} endpoint. {accountId} is a system ID assigned to the service account in the Veeam Backup for Microsoft Azure.

HTTP Request

PUT https://<hostname>/api/v2/accounts/azure/service/updateByApp/{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.

Request Body

To update the service account settings, send the parameters of the SaveAzureAccountInfoV2 schema in the request body.

Set the parameter values in the following format:

{

 "accountInfo": {

   "name": "string",

   "description": "string"

 },

 "clientLoginParameters": {

   "azureEnvironment": "Global",

   "applicationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

   "clientSecret": "string",

   "tenantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

   "applicationCertificate": "string",

   "certificatePassword": "string",

   "purpose": "Service"

 }

}

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns a response code 204 (No Content).

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 204 Code.

Edit Service Account Created Using Existing ApplicationExample

The following request updates a service account with the ID 1.

Request:

PUT https://51.11.247.127/api/v2/accounts/azure/service/updateByApp/1.

 

Request Header:

Authorization: Bearer <Access-Token>

 

Request Body:

{

 "serviceAccount": {

   "name": "Repository Account",

   "description": "New Description"

 },

 "clientLoginParameters": {

   "azureEnvironment": "Global",

   "applicationId": "79b0fe30-6b85-44c3-98df-39a748c1dfb1",

   "clientSecret": "0395by30-4v56-46b3-12d5-45fn763t6",

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

   "applicationCertificate": "E.Z@aZc1w00]CZ-6--86U=r/k3lDgSfc",

   "certificatePassword": "3b_0395by30-3b",

   "purpose": "Service"

 }

}

 

Response:

204

I want to report a typo

There is a misspelling right here:

 

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