Developer Documentation

Catalog service Quick Deploy APIs

How to get details of an image in Azure account

December 6, 2023

Contributed by:

A C

Use REST APIs to get details of an image that was added to your Azure account.

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

Images in Quick Deploy documentation.

Steps to get details of an image in your Azure account

To get details of an image that was added 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.
If you do not have the imageId, see how to get all images to get the image id of all your posted images.
Use the API in this document to get the image.

Get details of an image in Azure account using any REST API tool

Learn from the following example to get details of an image that was added to your Azure account using any REST API tool.

Request

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

Response

HTTP/1.1 200 OK
citrix-transactionid: 80699539-ae66-4eb7-ae67-370606d12766
content-Length: 1616
content-Type: application/json; charset=utf-8
date: Wed, 02 Aug 2017 20:35:07 GMT

{
    "catalogs": [
        {
            "catalogId": "198a1538-ec7a-48db-8b38-fca55542f4f3",
            "catalogName": "Finance Catalog",
            "state": "Active",
            "azureSubscription": "xxx@citrix.com"
        },
        ...
    ],
    "applications": [
        {
            "id": "fc9d89b5-9914-4367-b32a-2a48b1db40af",
            "name": "Acrobat Reader DC",
            "applicationPath": "C:\\Program Files (x86)\\Adobe\\Acrobat Reader DC\\Reader\\AcroRd32.exe",
            "workingDirectory": "%ProgramFiles(x86)%\\Adobe",
            "description": "Read pdf documents",
            "compressedb64Icon": "..."
            "commandLineParams": "doc.pdf"
        },
        ...
    ],
    "id": "c2bc6a4c-a807-46dc-847a-4fcb4c971953",
    "name": "daas",
    "sessionSupport": "SingleSession",
    "state": "Ready",
    "osName": "Microsoft Windows 10 Pro",
    "osVersion": "10.0.17763",
    "isServerOs": false,
    "vdaVersion": "1811.1.0.20099",
    "status": "",
    "transactionId": "7cc221ad-51e0-4cce-9fe7-c47b38e5fbb2",
    "subscriptionName": "xxx@citrix.com",
    "resourceGroup": "Citrix-ImageBuilder",
    "storageAccount": "ctximagesf6hn2b0kjv9p1",
    "region": "eastus",
    "citrixPrepared": false,
    "isDeprecated": false,
    "linkedCatalogs": 1,
    "linkedCatalogsNames": [
      "Finance Catalog"
    ]
}
<!--NeedCopy-->

Interpreting the request URL

imageId

The imageId should be replaced with the actual image ID of the image. You must have obtained the imageId as response when invoking APIs listed in how to add an image or how to get all images sections.

Interpreting the response

Property name	Description
catalogs	The list of catalogs using this image.
applications	The list of start menu applications on the image. id - The ID of the application. Use this ID when publishing an application. name - The name of the application on the image. Use this name when publishing an application. applicationPath - The application path on the image. Use this path when publishing an application. workingDirectory - By default, this path is the same as the path in the ApplicationPath field. To run the application from a different directory, add an absolute path to this field. description - This is the description that shows in your user’s workspace. compressedb64Icon - The compressed application icon in Base64 format. This icon is for display purpose only. Do not use this when publishing an application. commandLineParams - The command line parameters for the app at startup.
id	The ID of the image.
name	The friendly name if the image.
sessionSupport	Type of sessions that are supported by the OS of the image.
state	The current state of the image. A state of Ready indicates that the image is good and ready to be used by a catalog.
osName	Name of image OS.
osVersion	Version of image OS.
isServerOs	Indicates if the image is using a server based OS.
vdaVersion	Version of the image Virtual Desktop Agent. Only applicable to image builder.
status	If the image is not in Ready state, this will give a friendly message describing the current state of the image.
transactionId	Provide this transactionId to Citrix Support if you need help with this image.
subscriptionName	Name of the Subscription that image VMs are deployed. Only applicable to image builder.
resourceGroup	The resource group that image VMs are deployed. Only applicable to image builder.
storageAccount	The storage account where the image is stored.
region	Azure region where image VMs are deployed. Only applicable to image builder.
citrixPrepared	Indicates if this is a Citrix provided image. This will be false for all images added by the customer.
isDeprecated	Indicates if this is a Citrix prepared deprecated image. This will be false for all images added by the customer.
linkedCatalogs	The number of catalogs using this image. This will be 0 for an image that has just been added and has never been used by a catalog.
linkedCatalogsNames	List of catalogs that are using this image.

Get details of an image in Azure account using PowerShell

Learn from the following example to get details of an image that was added to your Azure account using any PowerShell code.

function GetImage {
  param (
    [Parameter(Mandatory=$true)]
    [string] $customerId,
    [Parameter(Mandatory=$true)]
    [string] $siteId,
    [Parameter(Mandatory=$true)]
    [string] $bearerToken,
    [Parameter(Mandatory=$true)]
    [string] $imageId
  )
  $requestUri = [string]::Format("https://api.cloud.com/catalogservice/{0}/{1}/images/{2}", $customerId, $siteId, $imageId)
  $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 = "61603f15-cdf9-4c7f-99ff-91636601a795" #Replace with your site ID
$bearerToken = "ey1.." #See Prerequisites for all API calls section for a sample of how to get your bearer token
$imageId = "56f1cbf3-1cc6-40cd-9c82-c95633ba88bb" #Replace with your image ID
$response = GetImage $customerId $siteId $bearerToken $imageId
<!--NeedCopy-->

Get details of an image in Azure account using C# code

Learn from the following example to get details of an image that was added to your Azure account using C# code.

public static async Task<string> GetImage(
    string customerId,
    string siteId,
    string bearerToken,
    string imageId)
{
    var requestUri = string.Format("https://api.cloud.com/catalogservice/{0}/{1}/images/{2}", customerId, siteId, imageId);
    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

Catalog service Quick Deploy APIs OpenAPI Specification

Copy Download

How to get details of an image in Azure account

December 6, 2023

Contributed by:

A C

December 6, 2023

Contributed by:

A C

How to get details of an image in Azure account

Steps to get details of an image in your Azure account

Get details of an image in Azure account using any REST API tool

Request

Response

Interpreting the request URL

imageId

Interpreting the response

Get details of an image in Azure account using PowerShell

Get details of an image in Azure account using C# code

Resources

Catalog service Quick Deploy APIs OpenAPI Specification

In this article

Resources

Catalog service Quick Deploy APIs OpenAPI Specification