StartUpdateDataModel

Data contract for the workflowStep "Start-Update"

Properties

NameDescription Additional information
Machine

The FQDN of the workloadMachine to be updated.

Type: MachineDataModel

DeliverySite

No documentation available.

Type: ReferenceDataModel

TerminateSessionsBy

Wait and terminate sessions by the time specified. Send message to users 15 minutes prior.

Type: String

UpdateProcessIsAutomatic

Run the update script (reboots machine by default).

Type: Boolean

Version

The workload catalog target version.

Type: Number

Sample

application/json

Sample:
{
  "Machine": {
    "MachineName": "sample string 1",
    "Domain": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    }
  },
  "DeliverySite": {
    "Id": "sample string 1",
    "Name": "sample string 2"
  },
  "TerminateSessionsBy": "sample string 1",
  "UpdateProcessIsAutomatic": true,
  "Version": 3
}