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

Adding Service Account

This section explains how to add an Azure service account to the Veeam Backup for Microsoft Azure environment.

Request

POST https://<hostname>/api/v1/accounts/created/azure

Request Headers

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

Request Parameters

None.

Request Body

Property	Type	Description
authenticatedByCertificate	string	Defines if a certificate is used for authentication.
azureEnvironment	string	Sets the Azure environment.
azureConnectionType	string	Sets the Azure connection type.
accessTokenCache	string	Sets the token that was given upon authentication. Can be obtained as described in Authentication.
displayableId	string	Sets the account under which to perform authentication.
familyName	string	Sets the family name.
givenName	string	Sets the given name.
identityProvider	string	Sets the identity provider.
_links	Dictionary of string [key] and Object [value]	Links to related resources (navigation property).
serviceAccount	string	Sets the name and description of the service account that is being added.
adGroupSettings	string	Sets the group to add the group to remove.

Request Example

Request:

POST https://<hostname>/api/v1/accounts/created/azure

Request Header:

Authorization: Bearer <Access-Token>

Request Body:

{

"azureAuthenticationResult":{

"authenticatedByCertificate":false,

"azureEnvironment":"Global",

"azureConnectionType":"Service",

"accessTokenCache":"AwAAAAEAAACRAWh0dHBzOi8vbG9naW4ud2luZG93cy5uZXQvZjhjZGVmMzEtYTMxZS00YjRhLTkzZTQtNWY1NzFlOTEyNTVhLzo6Omh0dHBzOi8vbWFuYWdlbWVudC5jb3JlLndpbmRvd3MubmV0Lzo6OjA0YjA3Nzk1LThkZGItNDYxYS1iYmVlLTAyZjllMWJmN2I0Njo6OjC2InsiUmF3Q2xpZW50SW5mbyI6ImV5SjFhV1FpT2lJd01EQXdNREF3TUMwd01EQXdMVEF3TURBdFpHSTFZeTFqWlRsak1XSTRNVEE1T1RNaUxDSjFkR2xrSWpvaU9URTRPREEwTUdRdE5tTTJOeTAwWXpWaUxXSXhNVEl0TXpaaE16QTBZalkyWkdGa0luMCIsIlJlZnJlc2hUb2tlbiI6IkFRQUJBQUFBQUFCZUFGekR3bGx6VFlHRExoX3FZYkg4cUdQdnRPRUN5TEpPUmVYVkYtVzd5dzNUM05mbHFTVzdGRC12S1NrOVZfUldNMGdST1I0X29hRjJqc2pLN1NVYUlJYkF0QzRsUk9EM3NFQzRISTViVGE0VktxdFlqVjRSXzh4WkhZa3h5TlhwSVp5a0dxc2ZxZlVGTnZmUktZT0N3WVdmdHN5UkRNdm1icXBUS2s0RkpsSkc5b3FsUFpma3UyR3pQeVBXaWRyckRENWwtM3BuenAweFpZdHQxdjdoT0pTa2xQMzlnQWlLM3N5SEhZWnc0TFRldlE4bUlwRktSZVFlTHZDZFdSRWVudW1sbXRnZjJleWtYZGxHeTdWQ0tuSXh0eC0td2VIWmZGb3d5TDZ1bGo3Ym85ZE43YUI5RVpzeUJyLXJlcnpkRTZLbXgtYlFuQkV5LUtwY0tiN2x5Q0FKZTVBSndXS0FJRzVyNFVOX2tnS2N2UEpoMG9JUlFyZ282bEo0di0zOVpTa29nbDc1OElJNEJJRnAxaWUtUVZoblhPaWoxSmExNTU2TFJwOU5FRGFKcExoYTVKdVhjczBySV90LWFUQVZ4WGRvcFpnUGUxbzQ5UnJyakl0ZE9YOVJJRjFSc0J3Q0FfUjhSTjJDQUJCRjV0QjM1WEcycVNCdEMycTg1b3ZualpOeHd4eXpjZ2FiejFoSHBUb0VfNXVBclktQzM1ZTdIVnlzMjZnTDBjV1JDQkQ2SjhhX1FReDVIaVFDYTZ3OHlFbF95NzlyMWpiNWhaNXdTZG0tU2tZTzAzaU1fb0FWR2tXVC1kdEE1WmxmM1NjblhRdzJIUzA4UTJBNzF6UHplQ1RoSlJhekFSbTRrY09YTWRXRUFRaXNicjhsU2J0dGtocTZ4RkQyZVVmUnd2RllrRWgxYjRMXzJRWkNlZ3lDbWxBQkEtWU1RLUR4Wi1MVEEzbk5hYzVzVTNpVkVMVVNESTl0VmR3eTBzVU5PQ3RqWmpFOTdMd2xZLTlWSmJHeEtSMGV2MTV5MzVSazR3UEhnWFgtVFAybFF4c1p4N1cxdldTVC1xVm5ONDNZWG1TaWlZUGlMXzQ5dHAxUVFLZzI4Zmx4TUFxUVpxNVhJMlY3X0YxVmFUQm1ZRnUweXVJSGx3c2ZlSU9vOGVld1diRWNRZW4zN2xlbW9Fck95QV9QUmRjaTNPRTlLTHA3aUlfSVpIZ1RUWVN2UG1rUkVneV9EWXI2ZjZUV29sazdyaUk0LVpaaEVQY1p6c1NBS2w4aUdlNkNEc09aaC1Mbkp2cTZqeDJTR0EzQWlrdThLaWJCX0hldk1UT1MxWWltaE9Xd3pNWFdXX1FIZTBzb0llVTRTMHlwN2lPZjhjNUtZVEw2dEptbktGNG1yc0RFalRqWjBmaTdjNTlqVWFxbXhja00zRkdXdk5vOFlJRVh0T0VMLS1sMVFBSmhaOXRKeEZseWM3TzNLak9IaHE5NVdtNzEwc3VweXVEWXN1ZmtGdXkzck1GRzhhTGJuVkQ5aXFzOFVBVFEzWkVNak1mOUFjMVk4dlFpVU5mdXBHM2tIOUN5aDFrY19HUUlSUm9jbnFTcHdaaVdvQzBVR25KVkFlZ0pFdnBCeDlOVTRsNm9UcUdobVVkd1JOcHB2dy1ORF9pODRJRU0tcmZGc2p2bnVRT1J2M0RydDlvZTJtRFAtaEpqR2p0THJaQkpudFk2Yzg3QzNBYVNGbGtZcG5rXy1HNnNvWVNQOTNjM1pCeTR3WFNmNXU3MVJ6NzJvaUxWMWNVZnhjRVNCS2lwN0VKUk9GRVYwY3A5TmlrWnY5U2dSdTc4UG5CV2hHbFRGVlRhSGRZWEFpQzdoa3ViUzNJb2kxTWdBQSIsIlJlc291cmNlSW5SZXNwb25zZSI6Imh0dHBzOlwvXC9tYW5hZ2VtZW50LmNvcmUud2luZG93cy5uZXRcLyIsIlJlc3VsdCI6eyJBY2Nlc3NUb2tlbiI6ImV5SjBlWEFpT2lKS1YxUWlMQ0poYkdjaU9pSlNVekkxTmlJc0luZzFkQ0k2SWtoc1F6QlNNVEp6YTNoT1dqRlhVWGR0YWs5R1h6WjBYM1JFUlNJc0ltdHBaQ0k2SWtoc1F6QlNNVEp6YTNoT1dqRlhVWGR0YWs5R1h6WjBYM1JFUlNKOS5leUpoZFdRaU9pSm9kSFJ3Y3pvdkwyMWhibUZuWlcxbGJuUXVZMjl5WlM1M2FXNWtiM2R6TG01bGRDOGlMQ0pwYzNNaU9pSm9kSFJ3Y3pvdkwzTjBjeTUzYVc1a2IzZHpMbTVsZEM5bU9HTmtaV1l6TVMxaE16RmxMVFJpTkdFdE9UTmxOQzAxWmpVM01XVTVNVEkxTldFdklpd2lhV0YwSWpveE5UZ3dPREF3TlRZeUxDSnVZbVlpT2pFMU9EQTRNREExTmpJc0ltVjRjQ0k2TVRVNE1EZ3dORFEyTWl3aVlXTnlJam9pTVNJc0ltRnBieUk2SWtGVlVVRjFMemhQUVVGQlFVMVVTbFJoUjNWS1RsQnJaMUZGT1dWbWNsUjBhMWhrYVc0M2RDdExRVlZPTUU1elZIQnhWbkZ2V1dKcE1uWlVOR2N4WW5ST2RUaE1iSFpVWXk5T0wwOVRVR1F2V1dWQlJuVXdkMGh5VWtodlVqazBVVTFSUFQwaUxDSmhiSFJ6WldOcFpDSTZJakU2YkdsMlpTNWpiMjA2TURBd016UXdNREZET1VVM05UTkdSU0lzSW1GdGNpSTZXeUp3ZDJRaVhTd2lZWEJ3YVdRaU9pSXdOR0l3TnpjNU5TMDRaR1JpTFRRMk1XRXRZbUpsWlMwd01tWTVaVEZpWmpkaU5EWWlMQ0poY0hCcFpHRmpjaUk2SWpBaUxDSmxiV0ZwYkNJNklsSkVRMnh2ZFdRdVFtRmphM1Z3TGtScGRqTkFkbVZsWVcwdVkyOXRJaXdpWm1GdGFXeDVYMjVoYldVaU9pSlpZWE41ZFdzaUxDSm5hWFpsYmw5dVlXMWxJam9pUzI5emRIbGhJaXdpYVdSd0lqb2liR2wyWlM1amIyMGlMQ0pwY0dGa1pISWlPaUkxTVM0eE5ERXVNelV1TVRBeklpd2ljMk53SWpvaWRYTmxjbDlwYlhCbGNuTnZibUYwYVc5dUlpd2ljM1ZpSWpvaVptdFBka2RqVTJjeE1IaFZMVmgzZG5ST1RrNU9XbU5CYmt4T2VrdExSVkEzVTJwc2RtMDFXRWQ2WnlJc0luUnBaQ0k2SW1ZNFkyUmxaak14TFdFek1XVXROR0kwWVMwNU0yVTBMVFZtTlRjeFpUa3hNalUxWVNJc0luVnVhWEYxWlY5dVlXMWxJam9pYkdsMlpTNWpiMjBqVWtSRGJHOTFaQzVDWVdOcmRYQXVSR2wyTTBCMlpXVmhiUzVqYjIwaUxDSjFkR2tpT2lKUVVscDFWRGcwVDBRd2JYSkNWME5ITm1WWlRVRkJJaXdpZG1WeUlqb2lNUzR3SW4wLmJDME9sRzZnYzlwSi1jTlJOdGJqdWgwbWRsZUlrOTExVm1lc0tueF9UdE1QdHZCUDdVQmVuMUJpOHRwVlhtbnFSTWVTdmd2VzZvbkxCNVBIWktzN0pzQ3FpZGpCckFDOXUtcUJWTS1MV0JtMkVMTXkwU2stLXdIWmR0cjZhSFdrd0dWVTJnMGhuYzFhQmRjQXItRjM3VzZPeWRzVENhVWdpSkRKdVYtRkJ6TlZ2djVMYVlNb0U5djZER2NQSDkzWlZrYlRzZjg0RXlWbHdFSkNiYkEtQzNvQkpPOGVBeFZKT2luaWJHdHBxUzdmcHFEdmQ0TE9yY2R1SkxxZW13S21sQTFIdl9SY0dtbGVWZGExTUZ3Mk5PeVdiVFpSQlRHb3JjcEwtWnZnNGlGdGJ4WlNFWGdpSTZWOEJPVXFVdlRpOU9EdFBWMHRvSEUxaHNReHFpMXlHZyIsIkFjY2Vzc1Rva2VuVHlwZSI6IkJlYXJlciIsIkV4cGlyZXNPbiI6eyJEYXRlVGltZSI6IlwvRGF0ZSgxNTgwODA0NDYxNDc2KVwvIiwiT2Zmc2V0TWludXRlcyI6MH0sIkV4dGVuZGVkRXhwaXJlc09uIjp7IkRhdGVUaW1lIjoiXC9EYXRlKDE1ODA4MDQ0NjE0NzYpXC8iLCJPZmZzZXRNaW51dGVzIjowfSwiRXh0ZW5kZWRMaWZlVGltZVRva2VuIjpmYWxzZSwiSWRUb2tlbiI6ImV5SjBlWEFpT2lKS1YxUWlMQ0poYkdjaU9pSnViMjVsSW4wLmV5SmhkV1FpT2lJd05HSXdOemM1TlMwNFpHUmlMVFEyTVdFdFltSmxaUzB3TW1ZNVpURmlaamRpTkRZaUxDSnBjM01pT2lKb2RIUndjem92TDNOMGN5NTNhVzVrYjNkekxtNWxkQzltT0dOa1pXWXpNUzFoTXpGbExUUmlOR0V0T1RObE5DMDFaalUzTVdVNU1USTFOV0V2SWl3aWFXRjBJam94TlRnd09EQXdOVFl5TENKdVltWWlPakUxT0RBNE1EQTFOaklzSW1WNGNDSTZNVFU0TURnd05EUTJNaXdpWVd4MGMyVmphV1FpT2lJeE9teHBkbVV1WTI5dE9qQXdNRE0wTURBeFF6bEZOelV6UmtVaUxDSmhiWElpT2xzaWNIZGtJbDBzSW1WdFlXbHNJam9pVWtSRGJHOTFaQzVDWVdOcmRYQXVSR2wyTTBCMlpXVmhiUzVqYjIwaUxDSm1ZVzFwYkhsZmJtRnRaU0k2SWxsaGMzbDFheUlzSW1kcGRtVnVYMjVoYldVaU9pSkxiM04wZVdFaUxDSnBaSEFpT2lKc2FYWmxMbU52YlNJc0ltbHdZV1JrY2lJNklqVXhMakUwTVM0ek5TNHhNRE1pTENKemRXSWlPaUpUVVZCVlVEVnlZMU14Wm5ORGFsOW1TbnBVT0dvMk4zRlBVa3h3UTNSUFVFaHZWVzlpY2tscFdHUmpJaXdpZEdsa0lqb2laamhqWkdWbU16RXRZVE14WlMwMFlqUmhMVGt6WlRRdE5XWTFOekZsT1RFeU5UVmhJaXdpZFc1cGNYVmxYMjVoYldVaU9pSnNhWFpsTG1OdmJTTlNSRU5zYjNWa0xrSmhZMnQxY0M1RWFYWXpRSFpsWldGdExtTnZiU0lzSW5abGNpSTZJakV1TUNKOS4iLCJUZW5hbnRJZCI6ImY4Y2RlZjMxLWEzMWUtNGI0YS05M2U0LTVmNTcxZTkxMjU1YSIsIlVzZXJJbmZvIjp7IkRpc3BsYXlhYmxlSWQiOiJSRENsb3VkLkJhY2t1cC5EaXYzQHZlZWFtLmNvbSIsIkZhbWlseU5hbWUiOiJZYXN5dWsiLCJHaXZlbk5hbWUiOiJLb3N0eWEiLCJJZGVudGl0eVByb3ZpZGVyIjoibGl2ZS5jb20iLCJQYXNzd29yZENoYW5nZVVybCI6bnVsbCwiUGFzc3dvcmRFeHBpcmVzT24iOm51bGwsIlVuaXF1ZUlkIjoiU1FQVVA1cmNTMWZzQ2pfZkp6VDhqNjdxT1JMcEN0T1BIb1VvYnJJaVhkYyJ9fSwiVXNlckFzc2VydGlvbkhhc2giOm51bGx9",

"displayableId":"@tech.com",

"familyName":"Family Name",

"givenName":"Given Name",

"identityProvider":"live.com",

"_links":{

"self":{

"href":"https://abc.ukwest.cloudapp.azure.com/api/v1/accounts/created/authenticate?azureEnvironment=Global&userCode=DZX3N4A2B&deviceCode=DAQABAAEAAABeAFzDwllzTYGDLh_qYbH8y_5xN7a9NzxaG7uCgwf_60CcbjsHleZ_rQR_eW0Az377nuGAF0_4q7W1uNjR_6QSJPBsronxfsiApe5l8oPJ41DDRDyG2YJx6zqh1EflPayT1ZbgVWh1sTQKkVvThan_okCZyGP8q0PHSES-BC2FAfPPdN9kXz8JJ9afnvz5r0wgAA&verificationUrl=https%3A%2F%2Fmicrosoft.com%2Fdevicelogin&expiresOn=02%2F04%2F2020%2006%3A51%3A48%20%2B00%3A00&interval=5&message=To%20sign%20in,%20use%20a%20web%20browser%20to%20open%20the%20page%20https%3A%2F%2Fmicrosoft.com%2Fdevicelogin%20and%20enter%20the%20code%20DZX3N4A2B%20to%20authenticate.&clientId=84b03795-8ddb-261a-bbee-02f9e1bf7b46&resource=https%3A%2F%2Fmanagement.core.windows.net%2F&azureTypeConnection=Service"

}

"serviceAccount":{

"description":"",

"name":"Azure Connection"

"adGroupSettings":{

"groupIdToAdd":null,

"groupIdToRemove":null

}

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.