Get List of Subscriptions by Application

You can get a list of all subscriptions available for the repository account connected to the existing AD application.

Request

To retrieve a representation of a collection of subscriptions, send the HTTP POST request to the /accounts/azure/repository/listSubscriptionsByApp endpoint.

HTTP Request

POST https://<hostname>/api/v2/accounts/azure/repository/listSubscriptionsByApp

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 get a list  of all subscriptions, send the parameters of the ClientLoginParametersV2 schema in the request body.

Set the parameter values in the following format:

{

 "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 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 /accounts/azure/repository/listSubscriptionsByApp collection. The SubscriptionsListingResultV2 schema is used for the collection representation.

Get List of Subscriptions by ApplicationExample

The following request returns a list of available subscriptions.

Request:

POST https://51.11.247.127/api/v2/accounts/azure/repository/listSubscriptionsByApp

 

Request Header:

Authorization: Bearer <Access-Token>

 

Request Body:

{

 "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": "Repository"

}

 

Response:

200

 

Response Body:

{

  "environment": "Global",

  "defaultTenantId": "3e924la9-93bc-40d5-3a47-33f07b239a52",

  "defaultTenantName": "Default_tenant",

  "subscriptions": [   {

     "id": "3p9a8330-7bmc-4b03-9c68-15d674lbc809",

     "name": "Visual Studio Premium MSDN",

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

     "permissionsState": "AvailableAll",

     "missingPermissions": []

  }],

  "requiredRolesHint": ["Contributor"]

}

I want to report a typo

There is a misspelling right here:

 

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