This is an archive version of the document. To get the most up-to-date information, see the current version.

Editing Service Account by Connection ID

This section explains how to edit parameters of the specified service account.

Request

PUT https://<hostname>/api/api/v1/accounts/imported/azure/{accountId}

Request Headers

The request header must contain an authorization token of the current session.

Request Parameters

The following parameters must be posted as URL.

Parameter

Description

accountId

The identification number of the account. Can be obtained as described in Getting Accounts.

Request Body

Property

Type

Description

repositoryAccount

RepositoryAccountInfo Object

Sets the Azure environment.

clientLoginParameters

ClientLoginParameters Object

Sets the identification number of the application.

RepositoryAccountInfo Object

Property

Type

Description

name

string

Sets the name for the service account.

description

string

Sets the description for the service account.

ClientLoginParameters Object

Property

Type

Description

azureEnvironment

string

Sets the Azure environment.

applicationId

string

Sets the identification number of the application.

applicationPassword

string

Sets the password for the specified application.

tenantId

string

Sets the identification number of the tenant.

applicationCertificate

string

Sets the application certificate.

certificatePassword

string

Sets the password for the application certificate.

useType

string

Sets the user type.

Editing Service Account by Connection ID Note:

Make sure to use either applicationId or applicationCertificate. Using both parameters at the same time is not possible.

Request Example

Request:

PUT https://abc.ukwest.cloudapp.azure.com/api/v1/accounts/imported/azure/2

 

Request Header:

Authorization: Bearer <Access-Token>

 

Request Body:

{

 "repositoryAccount": {

   "name": "Azure Service Account",

   "description": "New Description"

 },

 "clientLoginParameters": {

   "azureEnvironment": "Global",

   "applicationId": "09m0fv30-6b35-44c3-98df-79a748c1dfb1",

   "applicationPassword": "R.T@aZc1w64]CZ-3--86U=k/k3lDgSfc",

   "tenantId": "3e974ba9-93bc-40d5-8j47-33f07b239a52",

   "useType": "Service"

 }

}

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 HTTPS headers.

Header

Description

Content-length

The length of the response body.

Content-type

The media type and syntax of the response body message: application/json; charset=utf-8

Response Body

None.

I want to report a typo

There is a misspelling right here:

 

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