TemplateCreateTOV2
Properties
ID of the Active Directory configuration that will be used when creating VMs in this template. This defines the domain to which VMs will be joined, and the account used to do so.
Application properties to be added when template is created.
The VMs of this template will be part of this Organization Unit in the AD
An arbitrary description for this template.
The initial admin password for all new VMs created from this template.
The initial admin username for all new VMs created from this template.
Specifies the size of os disk in gigabytes
All other provider resources that should be used when creating VMs for this template. The keys in this map and the interpretation of the values depend on the provider type.
Represents if the Windows License Type was acknowledged and provided by the user
Max number of desktops which can quiesced when the template is undergoing normal maintenance.
Template name.
List of network resources that will be used when creating VMs for this template. The meaning of ’network resource’ will depend on the provider type. For example, in Azure, this will be a list of subnets.
Org ID that owns this template.
List of protocols to be allowed for client connections to desktops in this template. Allowable values are ‘BLAST’, ‘PCOIP’ and ‘RDP’.
Possible values are: BLAST , PCOIP , RDP
ID of the provider instance to used when creating VMs for this template. This will define, for example, the subscription and region of the VMs for Azure templates.
Tags to be added to resources when they are created as part of this template.
Max number of desktops sessions allowed per VM. For Windows desktop VMs, this value must be 1. For MULTI_SESSION, it can be any value greater than 0.
Defines whether this template is ‘offline’ or ‘online’. When offline, noVM lifecycle operations will be performed for this template, and no client connections will be allowed.
Possible values are: OFFLINE , ONLINE
Template type. ‘DEDICATED’ creates single-session Windows 10 VMs that are assigned to and owned by specific users. ‘FLOATING’ creates single-session Windows 10 VMs that are shared. ‘MULTI_SESSION’ creates multi-session Windows Server VMs and multi-session Windows 10 VMs
Possible values are: APP_CAPTURE_STUDIO , DEDICATED , ELASTIC_GPU , FLOATING , MULTI_SESSION , RDSH , STUDIO , WVD
ID of the ‘uagDeployment’ for the template. This will define which UAG cluster will be used to connect clients to desktops
The type of Windows licenses that the creating organization possesses and wishes to use for all VMs created as part of this template
Possible values are: NONE , WINDOWS_CLIENT , WINDOWS_SERVER
Pattern used as prefix for VMs created for this template.
JSON Example
{
"computerAccountOU": "CN=Computers",
"description": "My floating desktop template",
"maxQuiescingServers": 10,
"name": "My floating desktop template"
}