How to unpublish desktops from a catalog in Azure account
Use REST APIs to unpublish desktops from a catalog in your Azure account.
You can make API requests using the PowerShell code, C# code, or any tool that supports invoking the REST API.
Steps to unpublish desktops from a catalog in Azure account
To unpublish desktops from a catalog in your Azure account, use the following procedure:
- Read the Get started with Citrix Cloud APIs section to ensure that you have the
customerIdandbearer token. - Get the
siteidfrom How to get a site ID API. - If you do not have the
catalogId, see how to get details of all catalogs to get the details of all your catalogs. - If you do not have the DesktopId of the desktop to un-publish, see how to get all catalog desktops to get the details of all your catalog desktops.
- Use the API listed below to un-publish desktop from a catalog.
Unpublish desktops from a catalog in Azure account using any REST API tool
Learn from the following example about how to unpublish the existing desktops from a catalog in your Azure account using any REST API tool.
Request
DELETE https://api.cloud.com/catalogservice/{customerId}/{siteId}/catalogs/{catalogId}/desktops/{desktopId} HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: CwsAuth bearer=<token-from-prerequisites>
<!--NeedCopy-->
Response
HTTP/1.1 204 NoContent
citrix-transactionid: c2bc6a4c-a807-46dc-847a-4fcb4c971953
content-Length: 0
content-Type: application/json; charset=utf-8
date: "Tue, 03 Oct 2017 22:15:10 GMT"
<!--NeedCopy-->
Interpreting the request URL
appId
desktopId should be replaced with the actual desktop ID of the desktop you want to unpublish. See how to get all catalog desktops API to obtain the desktopId for all your published desktops.
Interpreting the response
The response, in case of success, will have status code “204” without response body.
Unpublish desktops from a catalog in Azure account using PowerShell
Learn from the following example about how to unpublish the existing desktops from a catalog in your Azure account using PowerShell code.
function UnPublishCatalogDesktop {
param (
[Parameter(Mandatory=$true)]
[string] $customerId,
[Parameter(Mandatory=$true)]
[string] $siteId,
[Parameter(Mandatory=$true)]
[string] $bearerToken,
[Parameter(Mandatory=$true)]
[string] $catalogId,
[Parameter(Mandatory=$true)]
[string] $desktopId
)
$requestUri = [string]::Format("https://api.cloud.com/catalogservice/{0}/{1}/catalogs/{2}/desktops/{3}", $customerId, $siteId, $catalogId, $desktopId)
$headers = @{"Accept"="application/json";
"Authorization"="CwsAuth bearer=$bearerToken"}
$response = Invoke-RestMethod -Uri $requestUri -Method DELETE -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
$catalogId = "56f1cbf3-1cc6-40cd-9c82-c95633ba88bb" #Replace with your catalog ID
$desktopId = "50af6370-fff1-4fc9-b082-a33761fd2f20" #Replace with your desktop id
$response = UnPublishCatalogDesktop $customerId $siteId $bearerToken $catalogId $desktopId
<!--NeedCopy-->
Unpublish desktops from a catalog in Azure account using C# code
Learn from the following example about how to unpublish the existing desktops from a catalog in your Azure account using C# code.
public static async Task<string> UnPublishCatalogDesktop(
string customerId,
string siteId,
string bearerToken,
string catalogId,
string desktopId)
{
var requestUri = string.Format("https://api.cloud.com/catalogservice/{0}/{1}/catalogs/{2}/desktops/{3}", customerId, siteId, catalogId, desktopId);
using (var client = new HttpClient())
{
client.DefaultRequestHeaders.Accept.ParseAdd("application/json");
client.DefaultRequestHeaders.Authorization =
new AuthenticationHeaderValue("CwsAuth", "Bearer=" + bearerToken);
var response = await client.DeleteAsync(requestUri);
if (response != null)
{
var content = await response.Content.ReadAsStringAsync();
return content;
}
return null;
}
}
<!--NeedCopy-->