Help Page Home

# SessionMachineModel

Details about a session machine.

### Properties

Name | Description | Additional information
--- | --- | ---
Href | See Hypermedia. | Type: String
RelatedActions | See Hypermedia. | Type: Array of RelationModel
Id | ID of the session machine. | Type: String
ChangeId | See Optimistic Concurrency. | Type: String
Name | Name. | Type: String
DeleteState | See Deleting Objects. | Type: ObjectDeleteState
State | State of the session machine. | Type: SessionMachineState
IsShared | If true, the session machine is in a shared delivery group. If false, the session machine is in a private delivery group, and therefore available to only one tenant's users. If the session machine is not in a delivery group, this property will not be set. | Type: Boolean
VersionUpdatePending | If true, the session machine is pending an update to a newer version of the session machine catalog. | Type: Boolean
SessionMachineCatalogVersion | The version of the session machine catalog which the session machine has most recently been updated to. | Type: Number
SessionMachineCatalog | The session machine catalog containing the session machine. | Type: ReferenceModel
MachineDetail | A link to more details about the session machine. | Type: ReferenceModel
DeliveryGroup | The delivery group that the session machine is a member of. If the session machine is not a member of a delivery group, this property will not be set. | Type: ReferenceModel
DeliverySite | The delivery site that the session machine is a member of. If the session machine is not a member of a delivery site, this property will not be set. | Type: ReferenceModel
Tenant | If the session machine is a member of a delivery group, and the delivery group is allocated to a single tenant, this is a link to that tenant. Otherwise, this property will not be set. | Type: ReferenceModel
Tags | See Tags and Custom Properties. | Type: Array of String
CustomProperties | See Tags and Custom Properties. | Type: Array of CustomPropertyModel
HealthSummary | A summary of health indicators for the session machine. | Type: HealthSummaryModel
Domain | The domain which the session machine is a member of. | Type: ReferenceModel
Network | The management network which the session machine is connected to. If network isolation is disabled, this may not be set. | Type: String
DataCenter | The datacenter where the session machine resides. | Type: ReferenceModel
UserName | If the session machine is statically allocated to a user, this is the SAM name of the user (i.e. "DOMAIN\user"). Otherwise, this property will not be set. | Type: String
UserTenant | If the session machine is statically allocated to a user, this is the tenant to which the user belongs. Otherwise, this property will not be set. Note that the value of this property may differ from the Tenant property. If the session machine is a member of a shared delivery group but has been statically allocated to a user, this property will be set to the user's tenant even though the Tenant property is unset. Likewise, if the session machine is a member of a private delivery group but has not been statically allocated, then the Tenant property will be set and this property will be unset. | Type: ReferenceModel

### Sample

#### application/json

Sample:

    {
      "Href": "[api:SessionMachines(77b50020-4252-453c-815b-ce9b9412d543)]",
      "Id": "77b50020-4252-453c-815b-ce9b9412d543",
      "ChangeId": "12",
      "Name": "machine1",
      "DeleteState": "NotDeleted",
      "State": "Allocated",
      "IsShared": false,
      "SessionMachineCatalogVersion": 2,
      "SessionMachineCatalog": {
        "Href": "[api:SessionMachineCatalogs(628fa898-0c36-4024-8fe4-d7e9a9bfbcfa)]",
        "Name": "catalog 1",
        "Id": "628fa898-0c36-4024-8fe4-d7e9a9bfbcfa"
      },
      "MachineDetail": {
        "Href": "[api:MachineDetails(bff69e21-c280-488b-ad9e-74b674ffb7c9)]",
        "Name": "machine1",
        "Id": "bff69e21-c280-488b-ad9e-74b674ffb7c9"
      },
      "DeliveryGroup": {
        "Href": "[api:DeliveryGroups(c004375e-a96d-4368-96ba-c80702d7e80f)]",
        "Name": "dg1",
        "Id": "c004375e-a96d-4368-96ba-c80702d7e80f"
      },
      "DeliverySite": {
        "Href": "[api:DeliverySites(0ef3e68d-bb8e-4b69-9c30-ae3fac533996)]",
        "Name": "site1",
        "Id": "0ef3e68d-bb8e-4b69-9c30-ae3fac533996"
      },
      "Tenant": {
        "Href": "[api:Tenants(91ade655-feb5-47d3-9585-a5827ad50132)]",
        "Name": "Tenant 1",
        "Id": "91ade655-feb5-47d3-9585-a5827ad50132"
      },
      "Tags": [
        "tag"
      ],
      "CustomProperties": [
        {
          "Name": "myProperty",
          "Value": "myValue"
        }
      ],
      "HealthSummary": {
        "InfoCount": 1,
        "Messages": [
          {
            "Text": "Attempting to reach desired capacity",
            "IsActive": true,
            "Type": "Allocation"
          }
        ]
      },
      "Domain": {
        "Href": "[api:Domains(241b45cc-261d-47d0-81d7-a0a41c54c760)]",
        "Name": "domain1.local",
        "Id": "241b45cc-261d-47d0-81d7-a0a41c54c760"
      },
      "Network": "network1",
      "DataCenter": {
        "Href": "[api:DataCenters(af1fc9c4-dee5-4b0d-836c-9e1c5b57a88a)]",
        "Name": "datacenter1",
        "Id": "af1fc9c4-dee5-4b0d-836c-9e1c5b57a88a"
      },
      "UserName": "DOMAIN\\user1",
      "UserTenant": {
        "Href": "[api:Tenants(91ade655-feb5-47d3-9585-a5827ad50132)]",
        "Name": "Tenant 1",
        "Id": "91ade655-feb5-47d3-9585-a5827ad50132"
      }
    }