StoreFrontServerGroupModel

StoreFront server group details.

Properties

Name	Description	Additional information
Href	See Hypermedia.	Type: String
RelatedActions	See Hypermedia.	Type: Array of RelationModel
Id	ID of the StoreFront server group.	Type: String
ChangeId	See Optimistic Concurrency.	Type: String
Name	Name.	Type: String
Description	Description.	Type: String
Network	Management network which the server group is connected to.	Type: String
Domain	Domain which the servers in the group are a member of.	Type: ReferenceModel
DeleteState	See Deleting Objects.	Type: ObjectDeleteState
AllocationStatus	Allocation status of the server group.	Type: StoreFrontServerGroupAllocationStatus
Tenant	If the server group is privately allocated to a tenant, this is a link to that tenant.	Type: ReferenceModel
DataCenter	Datacenter where the server group is located.	Type: ReferenceModel
HealthSummary	Summary of health notifications associated with the server group.	Type: HealthSummaryModel
LoadBalancerUrl	URL of the load balancer for the server group.	Type: String
Tags	See Tags and Custom Properties.	Type: Array of String
CustomProperties	See Tags and Custom Properties.	Type: Array of CustomPropertyModel

Sample

application/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": {
    "InfoCount": 1,
    "Messages": [
      {
        "Text": "Attempting to reach desired capacity",
        "IsActive": true,
        "Type": "Allocation"
      }
    ]
  },
  "LoadBalancerUrl": "https://lb.sf.datacenter1.csp.com",
  "Tags": [
    "tag"
  ],
  "CustomProperties": [
    {
      "Name": "myProperty",
      "Value": "myValue"
    }
  ]
}