IncrementSessionMachineCatalogVersionModel

Details for incrementing a session machine catalog version.

Properties

NameDescription Additional information
TerminateSessionsBy

If set, the date and time when sessions will be terminated and the upgrade process begun, for session machines that are not upgraded to the latest version of the session machine catalog.

This date and time represents the local time for delivery controllers in the delivery site where the session machines are located. For example, if this indicates midnight, then it will happen at the local midnight within each affected delivery site, as determined by the delivery controllers in that delivery site.

If not set, user sessions will not be terminated. The system will wait as long as necessary for users to log out on their own.

Type: String (ISO 8601 standard date)

UpdateProcessIsAutomatic

If true, the update process will complete automatically, without administrator intervention.

If false, the update process will stop once the users have drained off of the session machine, and the administrator must use the POST SessionMachines({id})/CompleteUpdate API to complete the update process for each machine.

Note: This property can only be set if the session machine catalog's AutomaticUpdateProcessType is AdminControlled.

If not set, the default is false.

Type: Boolean

Template

Name of a template (VM) that will be used as the basis for provisioning machines into the session machine catalog. The session machine catalog is only compatible with compute resources that have this template available within their storage pools.

Existing provisioned session machines will be updated to use this template for their operating system disk if possible. However, statically-allocated single-user session machines which do not reset on reboot will need to be upgraded in-place, similarly to externally-provisioned session machines. In this case, this new template is still used for provisioning additional new machines on-demand.

Required, if the session machine catalog is using integrated provisioning.

Type: String

Sample

application/json

Sample:
{
  "TerminateSessionsBy": "2013-12-05T16:13:28.8155317-05:00",
  "UpdateProcessIsAutomatic": true,
  "Template": "win7_base_updated"
}