Container Services - List Orchestrators

Reference

Service:: AKS

API Version:: 2019-08-01

Gets a list of supported orchestrators in the specified subscription. The operation returns properties of each orchestrator including version, available upgrades and whether that version or upgrades are in preview.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/orchestrators?api-version=2019-08-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/orchestrators?api-version=2019-08-01&resource-type={resource-type}

URI Parameters

Name	In	Required	Type	Description
location	path	True	string	The name of a supported Azure region.
subscriptionId	path	True	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Client Api Version.
resource-type	query		string	resource type for which the list of orchestrators needs to be returned

Responses

Name	Type	Description
200 OK	OrchestratorVersionProfileListResult	OK

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

List Container Service Orchestrators

Sample Request

HTTP

GET https://management.azure.com/subscriptions/subid1/providers/Microsoft.ContainerService/locations/location1/orchestrators?api-version=2019-08-01

Sample Response

Status code:: 200

{
  "id": "/subscriptions/subid1/providers/Microsoft.ContainerService/locations/location1/orchestrators",
  "name": "default",
  "type": "Microsoft.ContainerService/locations/orchestrators",
  "properties": {
    "orchestrators": [
      {
        "orchestratorType": "DCOS",
        "orchestratorVersion": "1.10.0"
      },
      {
        "orchestratorType": "DCOS",
        "orchestratorVersion": "1.9.0"
      },
      {
        "orchestratorType": "DCOS",
        "orchestratorVersion": "1.8.8"
      },
      {
        "orchestratorType": "Swarm",
        "orchestratorVersion": "swarm:1.1.0"
      },
      {
        "orchestratorType": "DockerCE",
        "orchestratorVersion": "17.03.*"
      },
      {
        "orchestratorType": "Kubernetes",
        "orchestratorVersion": "1.8.1",
        "upgrades": [
          {
            "orchestratorVersion": "1.8.4"
          },
          {
            "orchestratorVersion": "1.8.2"
          }
        ]
      },
      {
        "orchestratorType": "Kubernetes",
        "orchestratorVersion": "1.9.10",
        "upgrades": [
          {
            "orchestratorType": "",
            "orchestratorVersion": "1.9.11",
            "isPreview": false
          },
          {
            "orchestratorType": "",
            "orchestratorVersion": "1.10.12",
            "isPreview": false
          },
          {
            "orchestratorType": "",
            "orchestratorVersion": "1.10.13",
            "isPreview": false
          }
        ]
      },
      {
        "orchestratorType": "Kubernetes",
        "orchestratorVersion": "1.9.11",
        "upgrades": [
          {
            "orchestratorType": "",
            "orchestratorVersion": "1.10.12",
            "isPreview": false
          },
          {
            "orchestratorType": "",
            "orchestratorVersion": "1.10.13",
            "isPreview": false
          }
        ]
      },
      {
        "orchestratorType": "Kubernetes",
        "orchestratorVersion": "1.10.12",
        "upgrades": [
          {
            "orchestratorType": "",
            "orchestratorVersion": "1.10.13",
            "isPreview": false
          },
          {
            "orchestratorType": "",
            "orchestratorVersion": "1.11.8",
            "isPreview": false
          },
          {
            "orchestratorType": "",
            "orchestratorVersion": "1.11.9",
            "isPreview": false
          }
        ]
      },
      {
        "orchestratorType": "Kubernetes",
        "orchestratorVersion": "1.10.13",
        "upgrades": [
          {
            "orchestratorType": "",
            "orchestratorVersion": "1.11.8",
            "isPreview": false
          },
          {
            "orchestratorType": "",
            "orchestratorVersion": "1.11.9",
            "isPreview": false
          }
        ]
      },
      {
        "orchestratorType": "Kubernetes",
        "orchestratorVersion": "1.11.8",
        "upgrades": [
          {
            "orchestratorType": "",
            "orchestratorVersion": "1.11.9",
            "isPreview": false
          },
          {
            "orchestratorType": "",
            "orchestratorVersion": "1.12.6",
            "isPreview": false
          },
          {
            "orchestratorType": "",
            "orchestratorVersion": "1.12.7",
            "isPreview": false
          }
        ]
      },
      {
        "orchestratorType": "Kubernetes",
        "orchestratorVersion": "1.11.9",
        "upgrades": [
          {
            "orchestratorType": "",
            "orchestratorVersion": "1.12.6",
            "isPreview": false
          },
          {
            "orchestratorType": "",
            "orchestratorVersion": "1.12.7",
            "isPreview": false
          }
        ]
      },
      {
        "orchestratorType": "Kubernetes",
        "orchestratorVersion": "1.12.6",
        "upgrades": [
          {
            "orchestratorType": "",
            "orchestratorVersion": "1.12.7",
            "isPreview": false
          },
          {
            "orchestratorType": "",
            "orchestratorVersion": "1.13.5",
            "isPreview": false
          }
        ]
      },
      {
        "orchestratorType": "Kubernetes",
        "orchestratorVersion": "1.12.7",
        "default": true,
        "upgrades": [
          {
            "orchestratorType": "",
            "orchestratorVersion": "1.13.5",
            "isPreview": false
          }
        ]
      },
      {
        "orchestratorType": "Kubernetes",
        "orchestratorVersion": "1.13.5",
        "upgrades": [
          {
            "orchestratorType": "",
            "orchestratorVersion": "1.14.0",
            "isPreview": true
          }
        ]
      },
      {
        "orchestratorType": "Kubernetes",
        "orchestratorVersion": "1.14.0",
        "isPreview": true
      }
    ]
  }
}

Definitions

Name	Description
OrchestratorProfile	Contains information about orchestrator.
OrchestratorVersionProfile	The profile of an orchestrator and its available versions.
OrchestratorVersionProfileListResult	The list of versions for supported orchestrators.

OrchestratorProfile

Contains information about orchestrator.

Name	Type	Description
isPreview	boolean	Whether Kubernetes version is currently in preview.
orchestratorType	string	Orchestrator type.
orchestratorVersion	string	Orchestrator version (major, minor, patch).

OrchestratorVersionProfile

The profile of an orchestrator and its available versions.

Name	Type	Description
default	boolean	Installed by default if version is not specified.
isPreview	boolean	Whether Kubernetes version is currently in preview.
orchestratorType	string	Orchestrator type.
orchestratorVersion	string	Orchestrator version (major, minor, patch).
upgrades	OrchestratorProfile[]	The list of available upgrade versions.

OrchestratorVersionProfileListResult

The list of versions for supported orchestrators.

Name	Type	Description
id	string	Id of the orchestrator version profile list result.
name	string	Name of the orchestrator version profile list result.
properties.orchestrators	OrchestratorVersionProfile[]	List of orchestrator version profiles.
type	string	Type of the orchestrator version profile list result.

Share via