DeliveryGroupModel

Details of a delivery group.

Properties

Name	Description	Additional information
Href	See Hypermedia.	Type: String
RelatedActions	See Hypermedia.	Type: Array of RelationModel
Id	ID of the delivery group.	Type: String
ChangeId	See Optimistic Concurrency.	Type: String
DeleteState	See Deleting Objects.	Type: ObjectDeleteState
Name	Name.	Type: String
IsolationMode	Isolation mode.	Type: IsolationModeState
Tags	See Tags and Custom Properties.	Type: Array of String
CustomProperties	See Tags and Custom Properties.	Type: Array of CustomPropertyModel
DeliveryControllerArchitecture	Architecture of the delivery controllers which the session machines in the delivery group require.	Type: DeliveryControllerArchitectureType
SessionMachineCatalog	Session machine catalog associated with the delivery group.	Type: ReferenceModel
SessionMachineCatalogVersion	Version of the session machine catalog associated with the delivery group.	Type: Number
Tenant	If the delivery group is assigned to a private tenant, this is a link to that tenant. Otherwise, this property will be unset.	Type: ReferenceModel
NumDesiredMachines	Number of session machines desired in the delivery group.	Type: Number
NumDrainingMachines	Number of session machines that are currently draining user sessions in the delivery group.	Type: Number
NumMachinesAwaitingUpdate	Number of session machines that are awaiting an update in the delivery group.	Type: Number
NumMachinesAllocated	Number of session machines in the delivery group that are allocated; i.e. fully functioning and accepting new connections.	Type: Number
NumAllocatedMachinesPerSessionMachineCatalogVersion	Number of session machines in each version of the associated session machine catalog.	Type: Array of VersionMachineCount
DataCenter	Datacenter containing the delivery group.	Type: ReferenceModel
IsUsedAsPrimary	True if any users are using this delivery group within their primary datacenter.	Type: Boolean
IsUsedAsBackup	True if any users are using this delivery group within their backup datacenter.	Type: Boolean
HealthSummary	Summary of health messages associated with the delivery group.	Type: HealthSummaryModel
Domain	Domain which the session machines in the delivery group must be joined to.	Type: ReferenceModel
Network	Management network with the session machines in the delivery group must be connected to.	Type: String
NeedsDeliverySite	True if there is no existing delivery site appropriate for hosting this delivery group.	Type: Boolean
EstimatedUsersPerSessionMachine	The estimated number of users per session machine in this delivery group. If the delivery group contains single-user session machines, this will be 1. If the delivery group contains multi-user session machines, this will be equal to the load balancing maximum number of users, which is configured on the session machine catalog.	Type: Number

Sample

application/json

Sample:

{
  "Href": "[api:DeliveryGroups(c004375e-a96d-4368-96ba-c80702d7e80f)]",
  "Id": "c004375e-a96d-4368-96ba-c80702d7e80f",
  "ChangeId": "4",
  "DeleteState": "NotDeleted",
  "Name": "dg1",
  "IsolationMode": "PrivateDeliveryGroup",
  "Tags": [
    "tag"
  ],
  "CustomProperties": [
    {
      "Name": "myProperty",
      "Value": "myValue"
    }
  ],
  "DeliveryControllerArchitecture": "FMA",
  "SessionMachineCatalog": {
    "Href": "[api:SessionMachines(77b50020-4252-453c-815b-ce9b9412d543)]",
    "Name": "machine1",
    "Id": "77b50020-4252-453c-815b-ce9b9412d543"
  },
  "SessionMachineCatalogVersion": 4,
  "Tenant": {
    "Href": "[api:Tenants(91ade655-feb5-47d3-9585-a5827ad50132)]",
    "Name": "Tenant 1",
    "Id": "91ade655-feb5-47d3-9585-a5827ad50132"
  },
  "NumDesiredMachines": 30,
  "NumDrainingMachines": 2,
  "NumMachinesAwaitingUpdate": 5,
  "NumMachinesAllocated": 30,
  "NumAllocatedMachinesPerSessionMachineCatalogVersion": [
    {
      "SessionMachineCatalogVersion": 3,
      "MachineCount": 20
    }
  ],
  "DataCenter": {
    "Href": "[api:DataCenters(af1fc9c4-dee5-4b0d-836c-9e1c5b57a88a)]",
    "Name": "datacenter1",
    "Id": "af1fc9c4-dee5-4b0d-836c-9e1c5b57a88a"
  },
  "IsUsedAsPrimary": true,
  "IsUsedAsBackup": true,
  "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": "Shared Delivery Group Management Network",
  "EstimatedUsersPerSessionMachine": 250
}