GET StoreFrontServers

Get all StoreFront servers.

Request Information

Parameters

NameDescriptionAdditional information
name

See Filtering, Arranging, and Paging.

Type: String

filterBy

See Filtering, Arranging, and Paging. The supported filters are:

  • All: All StoreFront servers.
  • NotDeleted: All StoreFront servers that are not currently being deleted. (default)
  • Allocated: All StoreFront servers that are part of a StoreFront server group which is allocated either for shared use, or to a tenant.
  • NotUsed: All StoreFront servers that are not used as part of a StoreFront server group.

Type: Filter

filterProp

See Filtering, Arranging, and Paging.

Type: String

arrangeBy

See Filtering, Arranging, and Paging. The supported arrangers are:

  • Name: Arrange by name. (default)

Type: String

skip

See Filtering, Arranging, and Paging.

Type: Number

take

See Filtering, Arranging, and Paging.

Type: Number

Response Information

A list of StoreFront servers.

Response type

CollectionResultModel<StoreFrontServerModel>

Response body formats

application/json, text/json

Sample:
{
  "Href": "[api:StoreFrontServers]",
  "Count": 1,
  "TotalMatchingFilter": 1,
  "Items": [
    {
      "Href": "[api:StoreFrontServers(c1b9add5-480e-42c8-844c-de9b9e62a5a5)]",
      "Id": "c1b9add5-480e-42c8-844c-de9b9e62a5a5",
      "ChangeId": "9",
      "Name": "server1",
      "Tags": [
        "tag"
      ],
      "CustomProperties": [
        {
          "Name": "myProperty",
          "Value": "myValue"
        }
      ],
      "DeleteState": "NotDeleted",
      "State": "Allocated",
      "CPUs": 2,
      "MemoryMB": 4096,
      "OSName": "Windows Server 2008 R2",
      "OSVersion": "Service Pack 1",
      "StoreFrontServerGroup": {
        "Href": "[api:StoreFrontServerGroups(590b3e81-5528-40cf-b13d-690ee2477c5a)]",
        "Name": "servergroup1",
        "Id": "590b3e81-5528-40cf-b13d-690ee2477c5a"
      },
      "MachineDetail": {
        "Href": "[api:MachineDetails(bff69e21-c280-488b-ad9e-74b674ffb7c9)]",
        "Name": "machine1",
        "Id": "bff69e21-c280-488b-ad9e-74b674ffb7c9"
      }
    }
  ]
}