List Operating System Families

  • Article

 

The List Operating System Families operation lists the guest operating system families available in Microsoft Azure, and also lists the operating system versions available for each family.

Request

The List Operating System Families request may be specified as follows. Replace <subscription-id> with the subscription ID.

Method

Request URI

GET

https://management.core.windows.net/<subscription-id>/operatingsystemfamilies

URI Parameters

None.

Request Headers

The following table describes the request headers.

Request Header

Description

x-ms-version

Required. Specifies the version of the operation to use for this request. The value of this header must be set to 2010-10-28 or higher.

Request Body

None.

Response

The response includes an HTTP status code, a set of response headers, and a response body.

Status Code

A successful operation returns status code 200 (OK).

Response Headers

The response for this operation includes the following headers. The response may also include additional standard HTTP headers.

Response Header

Description

x-ms-request-id

A value that uniquely identifies a request made against the management service.

Response Body

<?xml version="1.0" encoding="utf-8"?>
<OperatingSystemFamilies xmlns="https://schemas.microsoft.com/windowsazure">
  <OperatingSystemFamily>
    <Name>osfamily-number</Name>
    <Label>base64-encoded-label</Label>
    <OperatingSystems>
      <OperatingSystem>
        <Version>operating-system-version</Version>
        <Label>base64-encoded-label</Label> 
        <IsDefault>true|false</IsDefault>
        <IsActive>true|false</IsActive>
      </OperatingSystem>
    </OperatingSystems>
  </OperatingSystemFamily>
</OperatingSystemFamilies>

The following example shows the format of the response body.

Element Name

Description

Name

Specifies the operating system family this version belongs to.

Label

Specifies the base-64 encoded label of the operating system family.

Version

Specifies the operating system version. This value corresponds to the configuration value for specifying that your service is to run on a particular version of the Azure guest operating system.

Label

Specifies the base-64 encoded label of the operating system version.

IsDefault

Indicates whether this operating system version is the default version for a service that has not otherwise specified a particular version. The default operating system version is applied to services that are configured for auto-upgrade. An operating system family has exactly one default operating system version at any given time, for which the IsDefault element is set to true; for all other versions, IsDefault is set to false.

IsActive

Indicates whether this operating system version is currently active for running a service. If an operating system version is active, you can manually configure your service to run on that version.

An operating system version may be inactive for one of two reasons:

  • It is not yet active as it is in the process of being rolled out to Azure data centers. If your service is configured to use auto-upgrade, it will be upgraded to the new operating system version during the rollout. If you are manually configuring your operating system version, you can upgrade to the latest version once it becomes active.

  • It is no longer supported for running a service. In this case you will either need to manually configure your service to run on a newer version, or configure your service to use auto-upgrade to manage operating system upgrades.