PUT DeliveryGroups

Simultaneously create new delivery groups, edit existing delivery groups, and delete existing delivery groups.

Request Information

Request body type

EditDeliveryGroupsModel

Request body formats

application/json, text/json

Sample:
{
  "DeliveryGroupsForCreation": [
    {
      "DataCenterId": "af1fc9c4-dee5-4b0d-836c-9e1c5b57a88a",
      "OfferingId": "2f08f456-7ec8-4edc-866d-25037776ef4f",
      "Capacity": 10,
      "TenantId": "91ade655-feb5-47d3-9585-a5827ad50132",
      "Tags": [
        "tag"
      ],
      "CustomProperties": [
        {
          "Name": "myProperty",
          "Value": "myValue"
        }
      ]
    }
  ],
  "DeliveryGroupsForUpdate": [
    {
      "DeliveryGroupId": "c004375e-a96d-4368-96ba-c80702d7e80f",
      "DeliveryGroupChangeId": "4",
      "NumDesiredMachines": 5,
      "Tags": [
        "tag"
      ],
      "CustomProperties": [
        {
          "Name": "myProperty",
          "Value": "myValue"
        }
      ]
    }
  ],
  "DeliveryGroupsForDeletion": [
    {
      "DeliveryGroupId": "05da9c34-c350-4c85-947c-c4108c22c57b",
      "DeliveryGroupChangeId": "9"
    }
  ]
}

Response Information

List of all created and edited delivery groups.

Response type

CollectionResultModel<DeliveryGroupModel>

Response body formats

application/json, text/json

Sample:
{
  "Href": "[api:DeliveryGroups]",
  "Count": 1,
  "TotalMatchingFilter": 1,
  "Items": [
    {
      "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": {
        "ActiveCount": 0,
        "ErrorCount": 0,
        "WarningCount": 0,
        "InfoCount": 1,
        "Messages": [
          {
            "Text": "Attempting to reach desired capacity",
            "IsError": false,
            "IsWarning": false,
            "IsInfo": false,
            "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",
      "NeedsDeliverySite": false,
      "EstimatedUsersPerSessionMachine": 250
    }
  ]
}