TemplateTOV2
Searchable fields are “id”,“activeDirectoryId”,“diskEncryption.enabled”,“edgeDeploymentId”,“imageReference.streamId”,“imageReference.versionId”,“imageReference.markerId”,“name”,“parentId”,“protocols”,“providerInstanceId”,“templateType”,“uagDeploymentId”
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.
clientAccessLicenseApplicable is set to true if customer has RDS CAL for Server images. Ref : https://docs.microsoft.com/en-us/azure/virtual-desktop/overview
Pool VMs will join this OU if specified else they will be part of the default OU of the AD domain
Template create timestamp.
True when a DELETE call for a template has been made to admin, but the template has not yet finished deleting.
An arbitrary description for this template.
Credential ID that points to desktop admin credentials needed during VM provisioning.
The initial admin username for all new VMs created from this template. Only available in ’expanded’ templates.
Specifies the size of os disk in gigabytes
Searchable fields are “id”, “name”, “providerLabel”, “providerInstanceId”, “status”
ID of the ’edgeDeployment’ for the template. Though this attribute can be inferred from the provider instance, it is referenced here for the purpose of easy lookup.
Template ID.
ID of the gold pattern (image) from which all VMs in the template will be created. This is obtained from the Image Service.
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
location
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.
Parent template ID, if this template is an expansion.
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
Searchable Fields are “id”, “name”, “providerLabel”, “edgeDeploymentId”, “infraTwinSyncStatus”
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.
The type of the provider template belongs to
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.
Synchronization status of the template.
Possible values are: SYNC_COMPLETE , SYNC_CREATE_ERROR , SYNC_CREATE_PENDING , SYNC_DELETE_ERROR , SYNC_DELETE_PENDING , SYNC_RETRY_PROVISIONING_ERROR , SYNC_RETRY_PROVISIONING_PENDING , SYNC_UPDATE_ERROR , SYNC_UPDATE_PENDING
Defines whether this template is ‘offline’ or ‘online’. When offline, no VM 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
Time spacing (in seconds) between consecutive session placement on a MULTI-SESSIONtemplate VM. This property will be used to load balance session slots among theMULTI-SESSION template VMs. This value should be between 0 to 300
Searchable fields are “id”, “name”, “type”, “providerInstanceId”, “providerLabel”, “status”
ID of the ‘uagDeployment’ for the template. This defines the UAG cluster that will be used to connect clients to desktops.
Template update timestamp.
The type of Windows licenses that the creating organization posesses 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
{
"description": "My floating desktop template",
"location": "US",
"maxQuiescingServers": 10,
"name": "My floating desktop template",
"providerLabel": "AZURE|VSPHERE",
"transientLoadThresholdSecs": 10
}
Property Of
PageTemplateTOV2
ProviderInstanceResourcesTOV2
TemplateBatchResponseTO
Returned By
Create
Create Expansion
Patch Expansion By ID
Get By ID
Patch By ID
delete Templates
Patch Pool Settings By Template ID
Perform Action
