This template is intended for demonstration deployments of Citrix XenDesktop on Azure. As stated below, this will provision all of the resources necessary for a stand-alone deployment with a unique Active Directory domain.
This is not intended to integrate with an existing Active Directory domain, Azure Active Directory, or other existing resources
This template creates a fully self-contained Citrix Cloud Resource Location compatible with Citrix XenDesktop with the XenApp and XenDesktop Service or Citrix XenDesktop Essentials Service trial licensing. A completed deployment from this template will consist of the following resources:
- Windows Server Active Directory Domain Controller
- Citrix NetScaler VPX 11.1
- Citrix Virtual Delivery Agent (VDAs)
- Windows 10 HUB [CBB] (Client VDI golden image)
- Windows Server 2016 (Server VDI golden image)
- Citrix Cloud Connector
- Jump Box / Bastian Host (VM built exclusively for remote access to the other resources)
- Azure Load Balancer
- Azure Virtual Network and Subnet
- Azure Storage Account
- Azure Availability Set
Here are the pre-requisites before you invoke the template:
-
At least 20 Cores should be available within your Azure Subscription.
-
Citrix NetScaler VPX must be available for your Subscription type and in the target Region. For more information: the option must be enabled for Citrix NetScaler 11.1 VPX Bring Your Own License offer within Azure Marketplace.
-
If you want to deploy Windows 10 HUB image, make sure your Azure Subscription has an associated Azure Enterprise Agreement.
-
Obtain a Citrix Cloud automation credential: * Login to https://citrix.cloud.com/ * Navigate to "Identity and Access Management". * Click "API Access". * Enter a name for Secure Client and click Create Client. * Once Secure Client is created, download Secure Client Credentials file. * Record the following for use with the template: id => Passed as parameter for customerId. Secret => Passed as parameter for clientSecret. * If you are going to associate the Cloud Connector machines with an existing Citrix Cloud Resource Location, click Resource Location on the Menu. Record the Name of the Resource Location (not the ID), and pass the exact name as the parameter for ResourceLocationId.
-
Login to https://www.Citrix.com
- Proceed to: https://www.citrix.com/downloads/citrix-cloud/product-software/xenapp-and-xendesktop-service.html
- Download latest RTM version of [Desktop OS Virtual Delivery Agent] for Windows 10 VDA
- Download latest RTM version of [Server OS Virtual Delivery Agent] for Windows Server VDA
-
Upload these installers to a share that can be accessed by Azure Resource Manager Template using a URI.
Note: This tempalte was designed with the scenario of hosting the installers from an Azure Storage Account. You can achieve this by creating an Azure Storage Account, upload the installer to either file or blob container, and use the url as the parameter for the ARM Template.
| Name | Description |
|---|---|
| vhdStorageType | Specifies the type of storage account, if being created. |
| vhdStorageNewOrExisting | Specifies whether the storage account should be created or already exists. |
| publicIpName | Specifies the resource name for the public IP. New IPs will take this name, while references to existing ones should be valid. |
| publicIpNewOrExisting | Specifies whether the public IP should be created or already exists. |
| machineSize | Specifies the size of the virtual machines (6). |
| adminUsername | Specifies the name of the administrator for machines, Active Directory domain, NetScaler and XenApp. Exclusion list: 'admin','administrator'. Must be no more than 9 alphanumeric characters. |
| adminPassword | Specifies the password of the administrator for machines, Active Directory domain, NetScaler and XenApp. |
| domainName | Specifies the name of the newly created Active Directory domain. |
| emailAddress | Specifies the email address that that will be used to request a public SSL certificate for NetScaler gateway from letsencrypt.org on your behalf. This will also be used to notify you when the template has deployed successfully. |
| acmeServer | Specifies the ACME protocol server used for public TLS certificate requests. Allowed values correspond to letsencrypt.org or any certficate provision service. |
| customInboundRules | Specifies additional inbound NAT rules to apply in this deployment. Useful for exposing individual machines more directly. The parameter is specified as an object, as in the default. See variable 'loadBalancerSettings' for an example format. |
| customApplications | Specifies additional applications to be installed on the VDA and published through XenApp. The parameter is specified as an array of objects, as in the default. See variables 'applications', 'vdaSettings', and 'storeFrontSettings' for an example format. |
| artifactsBaseUrl | Specifies the base location of the child templates and desired state configuration scripts. |
| artifactsBaseUrlSasToken | Specifies the shared access signature token which provides access to the base artifacts location. |
| Azure Gov | Specify True if the deployment is for Azure Gov, otherwise false. |
| Customer | This is the customer ID available in the Citrix Cloud console on the API Access page (within Identity and Access Management). |
| clientID | Found on the API Access page. This is the secure client ID an administrator can create. |
| clientSecret | Found on the API Access page. This is the secure client secret available via download after a secure client is created. |
| ResourceLocationId | Specify a Name for a resourcelocation to be created on Citrix Cloud, if there is no resource location available, enter a new ResourceLocation Name |
| CreateMasterImage | Specify if you want the VDI to be created as master Image, Note: If this option is specified the VDI are not provisioned to DDC. |
| CustomCloudConnectorScriptUri | If you want to run any custom configuration on cloudConnector, specify the URL for the powershellScript. else leave it empty. |
| CustomCloudConnectorScriptArgs | Arguments for Script, else leave it blank. |
| CreateClientVDA | Creates a Windows 10 [HUB] CBB Image, if your subscription is not part of Azure Enterprise Agreement, choose "false", the ARM Template will not create Windows 10 [HUB] CBB VM. |
| ClientVDIInstallerUri | Url for the Standalone Desktop OS Virtual Delivery Agent Installer, which can be download here. The downloaded Standalone VDA Installer can be either be uploaded to your existing Azure Storage Account or create an temporary Azure Storage Account which could be deleted once the deployment is completed. |
| CreateServerVDA | If you select "True", ARM Template creates a Windows Server 2016 Server VDA. |
| ServerVDAInstallerUrl | The Standalone Server OS Virtual Delivery Agent Installer, which can be downloaded here. The downloaded Standalone VDA Installer can be either be uploaded to your existing Azure Storage Account or create an temporary Azure Storage Account which could be deleted once the deployment is completed. |
| Example File | Description |
|---|---|
| parameters.vda.json | Example for Creating both Citrix Client VDI and Server VDI. |
| parameters.win10.vda.json | Example for Creating only Citrix Client VDI. |
| parameters.winserver2016.vda.json | Example for Creating only Citrix Server VDI. |