How to get details of all Azure subscriptions linked to your account

August 14, 2023

Contributed by:

Use REST APIs to get details of all Azure subscriptions that are linked to your account.

You can make API requests using the PowerShell code, C# code, or any tool that supports invoking the REST API.

Azure subscriptions in Quick Deploy documentation.

Steps to get details of all Azure subscriptions

To get details of all Azure subscriptions that are linked to your Azure account use the following procedure:

Read the Get started with Citrix Cloud APIs section to ensure that you have the customerId and bearer token.
Get the siteid from How to get a site ID API.
Use the API in this document to get all Azure subscriptions that are linked to a customer’s account.

Get details of all Azure subscriptions linked to your account using any REST API tool

Learn from the following example about how to get details of all Azure subscriptions that are linked to your account using any REST API tool.

Request

GET https://api-us.cloud.com/catalogservice/{customerId}/{siteId}/subscriptions HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: CwsAuth bearer=<token-from-prerequisites>

Response

HTTP/1.1 200 OK
Content-Length: 1926
Content-Type: application/json; charset=utf-8
Date: Thu, 12 Aug 2021 21:01:06 GMT

{
  "items": [
    {
      "linkedImages": 0,
      "linkedCatalogs": 1,
      "linkedAdvancedCatalogs": 0,
      "linkedCatalogsIds": [
        "9e7dd02a-668b-4152-bc94-46dac37ad3ec"
      ],
      "linkedImagesIds": [],
      "catalogVMs": 1,
      "subscriptionId": "bf8c1be6-...",
      "name": "Citrix Managed",
      "isLinked": true,
      "isValid": true,
      "citrixManaged": true,
      "disabled": false
    },
    {
      "linkedImages": 0,
      "linkedCatalogs": 1,
      "linkedAdvancedCatalogs": 0,
      "linkedCatalogsIds": [
        "68cbc78b-2fb8-4d3f-a0be-e20e233ea9d6"
      ],
      "linkedImagesIds": [],
      "catalogVMs": 1,
      "subscriptionId": "615b632a-...",
      "name": "...@citrix.com",
      "isLinked": true,
      "isValid": true,
      "citrixManaged": false,
      "disabled": false
    }
  ],
  "subscriptions": [
    {
      "linkedImages": 0,
      "linkedCatalogs": 1,
      "linkedAdvancedCatalogs": 0,
      "linkedCatalogsIds": [
        "9e7dd02a-668b-4152-bc94-46dac37ad3ec"
      ],
      "linkedImagesIds": [],
      "catalogVMs": 1,
      "subscriptionId": "bf8c1be6-...",
      "name": "Citrix Managed",
      "isLinked": true,
      "isValid": true,
      "citrixManaged": true,
      "disabled": false
    },
    {
      "linkedImages": 0,
      "linkedCatalogs": 1,
      "linkedAdvancedCatalogs": 0,
      "linkedCatalogsIds": [
        "68cbc78b-2fb8-4d3f-a0be-e20e233ea9d6"
      ],
      "linkedImagesIds": [],
      "catalogVMs": 1,
      "subscriptionId": "615b632a-...",
      "name": "...@citrix.com",
      "isLinked": true,
      "isValid": true,
      "citrixManaged": false,
      "disabled": false
    }
  ],
  "maxCitrixManagedSubscriptions": 1
}

Interpreting the response

The response is a JSON file with a list of all the Azure subscriptions that are linked to a given customer.

Property name	Description
linkedImages	Number of images linked to the subscription.
linkedCatalogs	Number of catalogs linked to the subscription.
linkedAdvancedCatalogs	Number of advanced catalogs linked to the subscription.
linkedCatalogsIds	The IDs of catalogs linked to the subscription.
linkedImagesIds	The IDs of images linked to the subscription.
catalogVMs	Number of virtual machines of the catalogs.
subscriptionId	The Azure subscription ID.
name	Name of the Azure subscription.
isLinked	This field identifies whether the subscription is linked with the customer and site provided.
isValid	This field identifies whether the subscription is valid for the customer and site provided.
citrixManaged	This field identifies whether the subscription is managed by Citrix
disabled	This field identifies whether the subscription is disabled.

Get details of all Azure subscriptions linked to your account using PowerShell

Learn from the following example about how to get details of all Azure subscriptions that are linked to your account using PowerShell code.

function GetAzureSubscriptions {
  param (
    [Parameter(Mandatory=$true)]
    [string] $customerId,
    [Parameter(Mandatory=$true)]
    [string] $siteId,
    [Parameter(Mandatory=$true)]
    [string] $bearerToken
  )
  $requestUri = [string]::Format("https://api-us.cloud.com/catalogservice/{0}/{1}/subscriptions", $customerId, $siteId)
  $headers = @{"Accept"="application/json";
               "Authorization"="CwsAuth bearer=$bearerToken"}

  $response = Invoke-RestMethod -Uri $requestUri -Method GET -Headers $headers
  return $response
}

$customerId = "customer1" #Replace with your customerId
$siteId = "15ae64f2-..." #Replace with your site ID
$bearerToken = "eyJ.." #See Prerequisites for all API calls section for a sample of how to get your bearer token
$response = GetAzureSubscriptions $customerId $siteId $bearerToken
<!--NeedCopy-->

Get details of all Azure subscriptions linked to your account using C# code

Learn from the following example about how to get details of all Azure subscriptions that are linked to your account using C# code.

public static async Task<string> GetAzureSubscriptions (
    string customerId,
    string siteId,
    string bearerToken)
{
    var requestUri = string.Format("https://api-us.cloud.com/catalogservice/{0}/{1}/subscriptions", customerId, siteId);
    using (var client = new HttpClient())
    {
        client.DefaultRequestHeaders.Accept.ParseAdd("application/json");
        client.DefaultRequestHeaders.Authorization =
                   new AuthenticationHeaderValue("CwsAuth", "Bearer=" + bearerToken);

        var response = await client.GetAsync(requestUri);

        if (response != null)
        {
            var content = await response.Content.ReadAsStringAsync();

            // Parsing the JSON content is left as an exercise to the reader.
            // Consult Json.NET documentation on newtonsoft.com for more information.

            return content;
        }

        return null;
    }
}
<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Resources

Citrix Virtual Apps Essentials OpenAPI Specification

Copy Download

How to get details of all Azure subscriptions linked to your account

August 14, 2023

Contributed by:

August 14, 2023

Contributed by:

How to get details of all Azure subscriptions linked to your account

Steps to get details of all Azure subscriptions

Get details of all Azure subscriptions linked to your account using any REST API tool

Request

Response

Interpreting the response

Get details of all Azure subscriptions linked to your account using PowerShell

Get details of all Azure subscriptions linked to your account using C# code

Resources

Citrix Virtual Apps Essentials OpenAPI Specification

In this article

Resources

Citrix Virtual Apps Essentials OpenAPI Specification