Open Shift Managed Clusters - List

Service:: AKS

API Version:: 2019-04-30

Gets a list of OpenShift managed clusters in the specified subscription. The operation returns properties of each OpenShift managed cluster.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/openShiftManagedClusters?api-version=2019-04-30

URI Parameters

Name	In	Required	Type	Description
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.

Responses

Name	Type	Description
200 OK	OpenShiftManagedClusterListResult	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 Managed Clusters

GET https://management.azure.com/subscriptions/subid1/providers/Microsoft.ContainerService/openShiftManagedClusters?api-version=2019-04-30


/**
 * Samples for OpenShiftManagedClusters List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2019-04-30/examples/
     * OpenShiftManagedClustersList.json
     */
    /**
     * Sample code: List Managed Clusters.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listManagedClusters(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.kubernetesClusters().manager().serviceClient().getOpenShiftManagedClusters()
            .list(com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/subid1/providers/Microsoft.ContainerService/openShiftManagedClusters",
      "location": "location1",
      "name": "clustername1",
      "tags": {
        "archv2": "",
        "tier": "production"
      },
      "type": "Microsoft.ContainerService/OpenShiftManagedClusters",
      "properties": {
        "provisioningState": "Succeeded",
        "openShiftVersion": "v3.11",
        "clusterVersion": "osa.1",
        "fqdn": "df9337748a4b.location1.cloudapp.azure.com",
        "publicHostname": "openshift.1225bdf9337748a4bd3a.location1.azmosa.io",
        "networkProfile": {
          "vnetCidr": "10.0.0.0/8"
        },
        "masterPoolProfile": {
          "count": 3,
          "vmSize": "Standard_D4s_v3",
          "subnetCidr": "10.0.0.0/24"
        },
        "agentPoolProfiles": [
          {
            "name": "infra",
            "role": "infra",
            "count": 2,
            "vmSize": "Standard_D4s_v3",
            "osType": "Linux",
            "subnetCidr": "10.0.0.0/24"
          },
          {
            "name": "compute",
            "role": "compute",
            "count": 4,
            "vmSize": "Standard_D4s_v3",
            "osType": "Linux",
            "subnetCidr": "10.0.0.0/24"
          }
        ],
        "routerProfiles": [
          {
            "name": "default",
            "fqdn": "osa2925bdf9337748f4bd3b.location1.cloudapp.azure.com",
            "publicSubdomain": "apps.bc309ee87c164153871c.location1.azmosa.io"
          }
        ],
        "authProfile": {
          "identityProviders": [
            {
              "name": "Azure AD",
              "provider": {
                "kind": "AADIdentityProvider",
                "clientId": "clientId",
                "tenantId": "tenantId",
                "customerAdminGroupId": "customerAdminGroupId"
              }
            }
          ]
        }
      }
    }
  ]
}

Definitions

Name	Description
NetworkProfile	Represents the OpenShift networking configuration
OpenShiftAgentPoolProfileRole	OpenShiftAgentPoolProfileRole represents the role of the AgentPoolProfile.
OpenShiftContainerServiceVMSize	Size of OpenShift VMs.
OpenShiftManagedCluster	OpenShift Managed cluster.
OpenShiftManagedClusterAADIdentityProvider	Defines the Identity provider for MS AAD.
OpenShiftManagedClusterAgentPoolProfile	Defines the configuration of the OpenShift cluster VMs.
OpenShiftManagedClusterAuthProfile	Defines all possible authentication profiles for the OpenShift cluster.
OpenShiftManagedClusterIdentityProvider	Defines the configuration of the identity providers to be used in the OpenShift cluster.
OpenShiftManagedClusterListResult	The response from the List OpenShift Managed Clusters operation.
OpenShiftManagedClusterMasterPoolProfile	OpenShiftManagedClusterMaterPoolProfile contains configuration for OpenShift master VMs.
OpenShiftRouterProfile	Represents an OpenShift router
OSType	OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux.
PurchasePlan	Used for establishing the purchase context of any 3rd Party artifact through MarketPlace.

NetworkProfile

Object

Represents the OpenShift networking configuration

Name	Type	Default value	Description
peerVnetId	string		CIDR of the Vnet to peer.
vnetCidr	string	10.0.0.0/8	CIDR for the OpenShift Vnet.
vnetId	string		ID of the Vnet created for OSA cluster.

OpenShiftAgentPoolProfileRole

Enumeration

OpenShiftAgentPoolProfileRole represents the role of the AgentPoolProfile.

Value	Description
compute
infra

OpenShiftContainerServiceVMSize

Enumeration

Size of OpenShift VMs.

Value	Description
Standard_D2s_v3
Standard_D4s_v3
Standard_D8s_v3
Standard_D16s_v3
Standard_D32s_v3
Standard_D64s_v3
Standard_DS4_v2
Standard_DS5_v2
Standard_F8s_v2
Standard_F16s_v2
Standard_F32s_v2
Standard_F64s_v2
Standard_F72s_v2
Standard_F8s
Standard_F16s
Standard_E4s_v3
Standard_E8s_v3
Standard_E16s_v3
Standard_E20s_v3
Standard_E32s_v3
Standard_E64s_v3
Standard_GS2
Standard_GS3
Standard_GS4
Standard_GS5
Standard_DS12_v2
Standard_DS13_v2
Standard_DS14_v2
Standard_DS15_v2
Standard_L4s
Standard_L8s
Standard_L16s
Standard_L32s