Open Shift Clusters - List

Service:

Red Hat OpenShift

API Version:

2023-09-04

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

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.RedHatOpenShift/openShiftClusters?api-version=2023-09-04

URI Parameters

Name	In	Required	Type	Description
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	OpenShiftClusterList	OK
Other Status Codes	CloudError	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.

Sample Request

HTTP

GET https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.RedHatOpenShift/openShiftClusters?api-version=2023-09-04

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.redhatopenshift import AzureRedHatOpenShiftClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-redhatopenshift
# USAGE
    python open_shift_clusters_list.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = AzureRedHatOpenShiftClient(
        credential=DefaultAzureCredential(),
        subscription_id="subscriptionId",
    )

    response = client.open_shift_clusters.list()
    for item in response:
        print(item)


# x-ms-original-file: specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/stable/2023-09-04/examples/OpenShiftClusters_List.json
if __name__ == "__main__":
    main()

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

Go

package armredhatopenshift_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/redhatopenshift/armredhatopenshift"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/bce66ff64f0e9edc9ea6119d00324058413e81ed/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/stable/2023-09-04/examples/OpenShiftClusters_List.json
func ExampleOpenShiftClustersClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armredhatopenshift.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewOpenShiftClustersClient().NewListPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.OpenShiftClusterList = armredhatopenshift.OpenShiftClusterList{
		// 	Value: []*armredhatopenshift.OpenShiftCluster{
		// 		{
		// 			Name: to.Ptr("resourceName"),
		// 			Type: to.Ptr("Microsoft.RedHatOpenShift/OpenShiftClusters"),
		// 			ID: to.Ptr("/subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.RedHatOpenShift/OpenShiftClusters/resourceName"),
		// 			SystemData: &armredhatopenshift.SystemData{
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-02-03T01:01:01.107Z"); return t}()),
		// 				CreatedBy: to.Ptr("string"),
		// 				CreatedByType: to.Ptr(armredhatopenshift.CreatedByTypeApplication),
		// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-02-03T01:01:01.107Z"); return t}()),
		// 				LastModifiedBy: to.Ptr("string"),
		// 				LastModifiedByType: to.Ptr(armredhatopenshift.CreatedByTypeApplication),
		// 			},
		// 			Location: to.Ptr("location"),
		// 			Tags: map[string]*string{
		// 				"key": to.Ptr("value"),
		// 			},
		// 			Properties: &armredhatopenshift.OpenShiftClusterProperties{
		// 				ApiserverProfile: &armredhatopenshift.APIServerProfile{
		// 					IP: to.Ptr("1.2.3.4"),
		// 					URL: to.Ptr("https://api.cluster.location.aroapp.io:6443/"),
		// 					Visibility: to.Ptr(armredhatopenshift.VisibilityPublic),
		// 				},
		// 				ClusterProfile: &armredhatopenshift.ClusterProfile{
		// 					Domain: to.Ptr("cluster.location.aroapp.io"),
		// 					ResourceGroupID: to.Ptr("/subscriptions/subscriptionId/resourceGroups/clusterResourceGroup"),
		// 					Version: to.Ptr("4.11.0"),
		// 				},
		// 				ConsoleProfile: &armredhatopenshift.ConsoleProfile{
		// 					URL: to.Ptr("https://console-openshift-console.apps.cluster.location.aroapp.io/"),
		// 				},
		// 				IngressProfiles: []*armredhatopenshift.IngressProfile{
		// 					{
		// 						Name: to.Ptr("default"),
		// 						IP: to.Ptr("1.2.3.4"),
		// 						Visibility: to.Ptr(armredhatopenshift.VisibilityPublic),
		// 				}},
		// 				MasterProfile: &armredhatopenshift.MasterProfile{
		// 					SubnetID: to.Ptr("/subscriptions/subscriptionId/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/master"),
		// 					VMSize: to.Ptr("Standard_D8s_v3"),
		// 				},
		// 				NetworkProfile: &armredhatopenshift.NetworkProfile{
		// 					PodCidr: to.Ptr("10.128.0.0/14"),
		// 					PreconfiguredNSG: to.Ptr(armredhatopenshift.PreconfiguredNSGDisabled),
		// 					ServiceCidr: to.Ptr("172.30.0.0/16"),
		// 				},
		// 				ProvisioningState: to.Ptr(armredhatopenshift.ProvisioningStateSucceeded),
		// 				ServicePrincipalProfile: &armredhatopenshift.ServicePrincipalProfile{
		// 					ClientID: to.Ptr("clientId"),
		// 				},
		// 				WorkerProfiles: []*armredhatopenshift.WorkerProfile{
		// 					{
		// 						Name: to.Ptr("worker"),
		// 						Count: to.Ptr[int32](3),
		// 						DiskSizeGB: to.Ptr[int32](128),
		// 						SubnetID: to.Ptr("/subscriptions/subscriptionId/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/worker"),
		// 						VMSize: to.Ptr("Standard_D2s_v3"),
		// 				}},
		// 				WorkerProfilesStatus: []*armredhatopenshift.WorkerProfile{
		// 					{
		// 						Name: to.Ptr("worker1"),
		// 						Count: to.Ptr[int32](1),
		// 						DiskSizeGB: to.Ptr[int32](128),
		// 						SubnetID: to.Ptr("/subscriptions/subscriptionId/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/worker"),
		// 						VMSize: to.Ptr("Standard_D2s_v3"),
		// 					},
		// 					{
		// 						Name: to.Ptr("worker2"),
		// 						Count: to.Ptr[int32](1),
		// 						DiskSizeGB: to.Ptr[int32](128),
		// 						SubnetID: to.Ptr("/subscriptions/subscriptionId/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/worker"),
		// 						VMSize: to.Ptr("Standard_D2s_v3"),
		// 					},
		// 					{
		// 						Name: to.Ptr("worker3"),
		// 						Count: to.Ptr[int32](1),
		// 						DiskSizeGB: to.Ptr[int32](128),
		// 						SubnetID: to.Ptr("/subscriptions/subscriptionId/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/worker"),
		// 						VMSize: to.Ptr("Standard_D2s_v3"),
		// 				}},
		// 			},
		// 	}},
		// }
	}
}

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/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.RedHatOpenShift/OpenShiftClusters/resourceName",
      "name": "resourceName",
      "type": "Microsoft.RedHatOpenShift/OpenShiftClusters",
      "location": "location",
      "systemData": {
        "createdBy": "string",
        "createdByType": "Application",
        "createdAt": "2020-02-03T01:01:01.1075056Z",
        "lastModifiedBy": "string",
        "lastModifiedByType": "Application",
        "lastModifiedAt": "2020-02-03T01:01:01.1075056Z"
      },
      "tags": {
        "key": "value"
      },
      "properties": {
        "provisioningState": "Succeeded",
        "clusterProfile": {
          "domain": "cluster.location.aroapp.io",
          "version": "4.11.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",
          "preconfiguredNSG": "Disabled"
        },
        "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
          }
        ],
        "workerProfilesStatus": [
          {
            "name": "worker1",
            "vmSize": "Standard_D2s_v3",
            "diskSizeGB": 128,
            "subnetId": "/subscriptions/subscriptionId/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/worker",
            "count": 1
          },
          {
            "name": "worker2",
            "vmSize": "Standard_D2s_v3",
            "diskSizeGB": 128,
            "subnetId": "/subscriptions/subscriptionId/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/worker",
            "count": 1
          },
          {
            "name": "worker3",
            "vmSize": "Standard_D2s_v3",
            "diskSizeGB": 128,
            "subnetId": "/subscriptions/subscriptionId/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/worker",
            "count": 1
          }
        ],
        "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

Name	Description
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.
createdByType	The type of identity that created the resource.
EncryptionAtHost	EncryptionAtHost represents encryption at host state
FipsValidatedModules	FipsValidatedModules determines if FIPS is used.
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.
OutboundType	The outbound routing strategy used to provide your cluster egress to the internet.
PreconfiguredNSG	PreconfiguredNSG represents whether customers want to use their own NSG attached to the subnets
ProvisioningState	ProvisioningState represents a provisioning state.
ServicePrincipalProfile	ServicePrincipalProfile represents a service principal profile.
systemData	Metadata pertaining to creation and last modification of the resource.
Visibility	Visibility represents visibility.
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.
url	string	The URL to access the cluster API server.
visibility	Visibility	API server visibility.

CloudError

CloudError represents a cloud error.

Name	Type	Description
error	CloudErrorBody	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	CloudErrorBody[]	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.
fipsValidatedModules	FipsValidatedModules	If FIPS validated crypto modules are used
pullSecret	string	The pull secret for the cluster.
resourceGroupId	string	The ID of the cluster resource group.
version	string	The version of the cluster.

ConsoleProfile

ConsoleProfile represents a console profile.

Name	Type	Description
url	string	The URL to access the cluster console.

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

EncryptionAtHost

EncryptionAtHost represents encryption at host state

Name	Type	Description
Disabled	string
Enabled	string

FipsValidatedModules

FipsValidatedModules determines if FIPS is used.

Name	Type	Description
Disabled	string
Enabled	string

IngressProfile

IngressProfile represents an ingress profile.

Name	Type	Description
ip	string	The IP of the ingress.
name	string	The ingress profile name.
visibility	Visibility	Ingress visibility.

MasterProfile

MasterProfile represents a master profile.

Name	Type	Description
diskEncryptionSetId	string	The resource ID of an associated DiskEncryptionSet, if applicable.
encryptionAtHost	EncryptionAtHost	Whether master virtual machines are encrypted at host.
subnetId	string	The Azure resource ID of the master subnet.
vmSize	string	The size of the master VMs.

NetworkProfile

NetworkProfile represents a network profile.

Name	Type	Description
outboundType	OutboundType	The OutboundType used for egress traffic.
podCidr	string	The CIDR used for OpenShift/Kubernetes Pods.
preconfiguredNSG	PreconfiguredNSG	Specifies whether subnets are pre-attached with an NSG
serviceCidr	string	The CIDR used for OpenShift/Kubernetes Services.

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	APIServerProfile	The cluster API server profile.
properties.clusterProfile	ClusterProfile	The cluster profile.
properties.consoleProfile	ConsoleProfile	The console profile.
properties.ingressProfiles	IngressProfile[]	The cluster ingress profiles.
properties.masterProfile	MasterProfile	The cluster master profile.
properties.networkProfile	NetworkProfile	The cluster network profile.
properties.provisioningState	ProvisioningState	The cluster provisioning state.
properties.servicePrincipalProfile	ServicePrincipalProfile	The cluster service principal profile.
properties.workerProfiles	WorkerProfile[]	The cluster worker profiles.
properties.workerProfilesStatus	WorkerProfile[]	The cluster worker profiles status.
systemData	systemData	The system meta data relating to this resource.
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	OpenShiftCluster[]	The list of OpenShift clusters.

OutboundType

The outbound routing strategy used to provide your cluster egress to the internet.

Name	Type	Description
Loadbalancer	string
UserDefinedRouting	string

PreconfiguredNSG

PreconfiguredNSG represents whether customers want to use their own NSG attached to the subnets

Name	Type	Description
Disabled	string
Enabled	string

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.
clientSecret	string	The client secret used for the cluster.

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

Visibility

Visibility represents visibility.

Name	Type	Description
Private	string
Public	string

WorkerProfile

WorkerProfile represents a worker profile.

Name	Type	Description
count	integer	The number of worker VMs.
diskEncryptionSetId	string	The resource ID of an associated DiskEncryptionSet, if applicable.
diskSizeGB	integer	The disk size of the worker VMs.
encryptionAtHost	EncryptionAtHost	Whether master virtual machines are encrypted at host.
name	string	The worker profile name.
subnetId	string	The Azure resource ID of the worker subnet.
vmSize	string	The size of the worker VMs.