PUT StoreFrontServerGroups({id})

Update a StoreFront server group.

Request Information

Parameters

Name	Description	Additional information
id	ID of the StoreFront server group to update.	Type: String
changeId	See Optimistic Concurrency.	Type: String

Request body type

UpdateStoreFrontServerGroupModel

Request body formats

application/json, text/json

Sample:

{
  "Description": "my StoreFront server group",
  "Tags": [
    "tag"
  ],
  "CustomProperties": [
    {
      "Name": "myProperty",
      "Value": "myValue"
    }
  ],
  "Servers": [
    "sf1",
    "sf2"
  ]
}

Response Information

Updated StoreFront server group.

Response type

StoreFrontServerGroupModel

Response body formats

application/json, text/json

Sample:

{
  "Href": "[api:StoreFrontServerGroups(590b3e81-5528-40cf-b13d-690ee2477c5a)]",
  "Id": "590b3e81-5528-40cf-b13d-690ee2477c5a",
  "ChangeId": "3",
  "Name": "servergroup1",
  "Description": "my StoreFront server group",
  "Network": "Shared Controller Management Network",
  "Domain": {
    "Href": "[api:Domains(241b45cc-261d-47d0-81d7-a0a41c54c760)]",
    "Name": "domain1.local",
    "Id": "241b45cc-261d-47d0-81d7-a0a41c54c760"
  },
  "DeleteState": "NotDeleted",
  "AllocationStatus": "Allocated",
  "Tenant": {
    "Href": "[api:Tenants(91ade655-feb5-47d3-9585-a5827ad50132)]",
    "Name": "Tenant 1",
    "Id": "91ade655-feb5-47d3-9585-a5827ad50132"
  },
  "DataCenter": {
    "Href": "[api:DataCenters(af1fc9c4-dee5-4b0d-836c-9e1c5b57a88a)]",
    "Name": "datacenter1",
    "Id": "af1fc9c4-dee5-4b0d-836c-9e1c5b57a88a"
  },
  "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"
      }
    ]
  },
  "LoadBalancerUrl": "https://lb.sf.datacenter1.csp.com",
  "Tags": [
    "tag"
  ],
  "CustomProperties": [
    {
      "Name": "myProperty",
      "Value": "myValue"
    }
  ]
}