Open Shift Clusters - List By Resource Group

Lists OpenShift clusters in the specified subscription and resource group.
The operation returns properties of each OpenShift cluster.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RedHatOpenShift/openShiftClusters?api-version=2020-04-30

URI Parameters

Name In Required Type Description
resourceGroupName
path True
  • string

The name of the resource group. The name is case insensitive.

Regex pattern: ^[-\w\._\(\)]+$

subscriptionId
path True
  • string

The ID of the target subscription.

api-version
query True
  • string

The API version to use for this operation.

Responses

Name Type Description
200 OK

OK

Other Status Codes

Error response describing why the operation failed. If the resource doesn't exist, 404 (Not Found) is returned. If any of the input parameters is wrong, 400 (Bad Request) is returned.

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

Lists OpenShift clusters in the specified subscription and resource group.

Sample Request

GET https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.RedHatOpenShift/openShiftClusters?api-version=2020-04-30

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.RedHatOpenShift/OpenShiftClusters/resourceName",
      "name": "resourceName",
      "type": "Microsoft.RedHatOpenShift/OpenShiftClusters",
      "location": "location",
      "tags": {
        "key": "value"
      },
      "properties": {
        "provisioningState": "Succeeded",
        "clusterProfile": {
          "domain": "cluster.location.aroapp.io",
          "version": "4.3.0",
          "resourceGroupId": "/subscriptions/subscriptionId/resourceGroups/clusterResourceGroup"
        },
        "consoleProfile": {
          "url": "https://console-openshift-console.apps.cluster.location.aroapp.io/"
        },
        "servicePrincipalProfile": {
          "clientId": "clientId"
        },
        "networkProfile": {
          "podCidr": "10.128.0.0/14",
          "serviceCidr": "172.30.0.0/16"
        },
        "masterProfile": {
          "vmSize": "Standard_D8s_v3",
          "subnetId": "/subscriptions/subscriptionId/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/master"
        },
        "workerProfiles": [
          {
            "name": "worker",
            "vmSize": "Standard_D2s_v3",
            "diskSizeGB": 128,
            "subnetId": "/subscriptions/subscriptionId/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/worker",
            "count": 3
          }
        ],
        "apiserverProfile": {
          "visibility": "Public",
          "url": "https://api.cluster.location.aroapp.io:6443/",
          "ip": "1.2.3.4"
        },
        "ingressProfiles": [
          {
            "name": "default",
            "visibility": "Public",
            "ip": "1.2.3.4"
          }
        ]
      }
    }
  ]
}

Definitions

APIServerProfile

APIServerProfile represents an API server profile.

CloudError

CloudError represents a cloud error.

CloudErrorBody

CloudErrorBody represents the body of a cloud error.

ClusterProfile

ClusterProfile represents a cluster profile.

ConsoleProfile

ConsoleProfile represents a console profile.

IngressProfile

IngressProfile represents an ingress profile.

MasterProfile

MasterProfile represents a master profile.

NetworkProfile

NetworkProfile represents a network profile.

OpenShiftCluster

OpenShiftCluster represents an Azure Red Hat OpenShift cluster.

OpenShiftClusterList

OpenShiftClusterList represents a list of OpenShift clusters.

ProvisioningState

ProvisioningState represents a provisioning state.

ServicePrincipalProfile

ServicePrincipalProfile represents a service principal profile.

Visibility

Visibility represents visibility.

VMSize

VMSize represents a VM size.

WorkerProfile

WorkerProfile represents a worker profile.

APIServerProfile

APIServerProfile represents an API server profile.

Name Type Description
ip
  • string

The IP of the cluster API server (immutable).

url
  • string

The URL to access the cluster API server (immutable).

visibility

API server visibility (immutable).

CloudError

CloudError represents a cloud error.

Name Type Description
error

An error response from the service.

CloudErrorBody

CloudErrorBody represents the body of a cloud error.

Name Type Description
code
  • string

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

details

A list of additional details about the error.

message
  • string

A message describing the error, intended to be suitable for display in a user interface.

target
  • string

The target of the particular error. For example, the name of the property in error.

ClusterProfile

ClusterProfile represents a cluster profile.

Name Type Description
domain
  • string

The domain for the cluster (immutable).

pullSecret
  • string

The pull secret for the cluster (immutable).

resourceGroupId
  • string

The ID of the cluster resource group (immutable).

version
  • string

The version of the cluster (immutable).

ConsoleProfile

ConsoleProfile represents a console profile.

Name Type Description
url
  • string

The URL to access the cluster console (immutable).

IngressProfile

IngressProfile represents an ingress profile.

Name Type Description
ip
  • string

The IP of the ingress (immutable).

name
  • string

The ingress profile name. Must be "default" (immutable).

visibility

Ingress visibility (immutable).

MasterProfile

MasterProfile represents a master profile.

Name Type Description
subnetId
  • string

The Azure resource ID of the master subnet (immutable).

vmSize

The size of the master VMs (immutable).

NetworkProfile

NetworkProfile represents a network profile.

Name Type Description
podCidr
  • string

The CIDR used for OpenShift/Kubernetes Pods (immutable).

serviceCidr
  • string

The CIDR used for OpenShift/Kubernetes Services (immutable).

OpenShiftCluster

OpenShiftCluster represents an Azure Red Hat OpenShift cluster.

Name Type Description
id
  • string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location
  • string

The geo-location where the resource lives

name
  • string

The name of the resource

properties.apiserverProfile

The cluster API server profile.

properties.clusterProfile

The cluster profile.

properties.consoleProfile

The console profile.

properties.ingressProfiles

The cluster ingress profiles.

properties.masterProfile

The cluster master profile.

properties.networkProfile

The cluster network profile.

properties.provisioningState

The cluster provisioning state (immutable).

properties.servicePrincipalProfile

The cluster service principal profile.

properties.workerProfiles

The cluster worker profiles.

tags
  • object

Resource tags.

type
  • string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

OpenShiftClusterList

OpenShiftClusterList represents a list of OpenShift clusters.

Name Type Description
nextLink
  • string

The link used to get the next page of operations.

value

The list of OpenShift clusters.

ProvisioningState

ProvisioningState represents a provisioning state.

Name Type Description
AdminUpdating
  • string
Creating
  • string
Deleting
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

ServicePrincipalProfile

ServicePrincipalProfile represents a service principal profile.

Name Type Description
clientId
  • string

The client ID used for the cluster (immutable).

clientSecret
  • string

The client secret used for the cluster (immutable).

Visibility

Visibility represents visibility.

Name Type Description
Private
  • string
Public
  • string

VMSize

VMSize represents a VM size.

Name Type Description
Standard_D2s_v3
  • string
Standard_D4s_v3
  • string
Standard_D8s_v3
  • string

WorkerProfile

WorkerProfile represents a worker profile.

Name Type Description
count
  • integer

The number of worker VMs. Must be between 3 and 20 (immutable).

diskSizeGB
  • integer

The disk size of the worker VMs. Must be 128 or greater (immutable).

name
  • string

The worker profile name. Must be "worker" (immutable).

subnetId
  • string

The Azure resource ID of the worker subnet (immutable).

vmSize

The size of the worker VMs (immutable).