Organization - List Clusters

Service:: Confluent

API Version:: 2024-07-01

Lists of all the clusters in a environment

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/environments/{environmentId}/clusters?api-version=2024-07-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/environments/{environmentId}/clusters?api-version=2024-07-01&pageSize={pageSize}&pageToken={pageToken}

URI Parameters

Name	In	Required	Type	Description
environmentId	path	True	string	Confluent environment id
organizationName	path	True	string	Organization resource name
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.
pageSize	query		integer (int32)	Pagination size
pageToken	query		string	An opaque pagination token to fetch the next set of records

Responses

Name	Type	Description
200 OK	ListClustersSuccessResponse	Azure operation completed successfully.
Other Status Codes	ResourceProviderDefaultErrorResponse	An unexpected error response.

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

Organization_ListClusters

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Confluent/organizations/myOrganization/environments/env-12132/clusters?api-version=2024-07-01&pageSize=10

Sample response

Status code:: 200

{
  "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Confluent/organizations/myOrganization/environments/env-12132/clusters?api-version=2024-07-01&$count=10&$skipToken=xoi3753asdfe",
  "value": [
    {
      "name": "ProdKafkaCluster",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Confluent/organizations/myOrganization/environments/env-12132/clusters/ProdKafkaCluster",
      "kind": "Cluster",
      "properties": {
        "metadata": {
          "createdTimestamp": "2006-01-02T15:04:05-07:00",
          "deletedTimestamp": "2006-01-02T15:04:05-07:00",
          "resourceName": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/cloud-cluster=lkc-12345",
          "self": "https://api.confluent.cloud/cmk/v2/clusters/lkc-12345",
          "updatedTimestamp": "2006-01-02T15:04:05-07:00"
        },
        "spec": {
          "name": "ProdKafkaCluster",
          "apiEndpoint": "https://pkac-00000.us-west-2.aws.confluent.cloud",
          "availability": "SINGLE_ZONE",
          "byok": {
            "id": "cck-00000",
            "related": "https://api.confluent.cloud/byok/v1/keys/cck-00000",
            "resourceName": "https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/key=cck-00000"
          },
          "cloud": "GCP",
          "config": {
            "kind": "Basic"
          },
          "environment": {
            "environment": "string",
            "id": "env-00000",
            "related": "https://api.confluent.cloud/v2/environments/env-00000",
            "resourceName": "https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000"
          },
          "httpEndpoint": "https://lkc-00000-00000.us-central1.gcp.glb.confluent.cloud",
          "kafkaBootstrapEndpoint": "lkc-00000-00000.us-central1.gcp.glb.confluent.cloud:9092",
          "network": {
            "environment": "string",
            "id": "n-00000",
            "related": "https://api.confluent.cloud/networking/v1/networks/n-00000",
            "resourceName": "https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-00000"
          },
          "region": "us-east4"
        },
        "status": {
          "cku": 2,
          "phase": "PROVISIONED"
        }
      }
    }
  ]
}

Definitions

Name	Description
ClusterConfigEntity	The configuration of the Kafka cluster
ClusterStatusEntity	Status of the cluster record
createdByType	The type of identity that created the resource.
ErrorResponseBody	Response body of Error
ListClustersSuccessResponse	Result of GET request to list clusters in the environment of a confluent organization
Package	Stream Governance Package. Supported values are ESSENTIALS and ADVANCED
ResourceProviderDefaultErrorResponse	Default error response for resource provider
SCClusterByokEntity	The network associated with this object
SCClusterNetworkEnvironmentEntity	The environment or the network to which cluster belongs
SCClusterRecord	Details of cluster record
SCClusterSpecEntity	Spec of the cluster record
SCMetadataEntity	Metadata of the data record
systemData	Metadata pertaining to creation and last modification of the resource.

ClusterConfigEntity

Object

The configuration of the Kafka cluster

Name	Type	Description
kind	string	The lifecycle phase of the cluster

ClusterStatusEntity

Object

Status of the cluster record

Name	Type	Description
cku	integer (int32)	The number of Confluent Kafka Units
phase	string	The lifecycle phase of the cluster

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

ErrorResponseBody

Object

Response body of Error

Name	Type	Description
code	string	Error code
details	ErrorResponseBody[]	Error detail
message	string	Error message
target	string	Error target

ListClustersSuccessResponse

Object

Result of GET request to list clusters in the environment of a confluent organization

Name	Type	Description
nextLink	string (uri)	The link to the next page of items
value	SCClusterRecord[]	The SCClusterRecord items on this page

Package

Enumeration

Stream Governance Package. Supported values are ESSENTIALS and ADVANCED

Value	Description
ESSENTIALS
ADVANCED

ResourceProviderDefaultErrorResponse

Object

Default error response for resource provider

Name	Type	Description
error	ErrorResponseBody	Response body of Error

SCClusterByokEntity

Object

The network associated with this object

Name	Type	Description
id	string	ID of the referred resource
related	string	API URL for accessing or modifying the referred object
resourceName	string	CRN reference to the referred resource

SCClusterNetworkEnvironmentEntity

Object

The environment or the network to which cluster belongs

Name	Type	Description
environment	string	Environment of the referred resource
id	string	ID of the referred resource
related	string	API URL for accessing or modifying the referred object
resourceName	string	CRN reference to the referred resource

SCClusterRecord

Object

Details of cluster record

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string	Type of cluster
name	string	The name of the resource
properties.metadata	SCMetadataEntity	Metadata of the record
properties.spec	SCClusterSpecEntity	Specification of the cluster
properties.status	ClusterStatusEntity	Specification of the cluster status
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

SCClusterSpecEntity

Object

Spec of the cluster record

Name	Type	Description
apiEndpoint	string	The Kafka API cluster endpoint
availability	string	The availability zone configuration of the cluster
byok	SCClusterByokEntity	Specification of the cluster byok
cloud	string	The cloud service provider
config	ClusterConfigEntity	Specification of the cluster configuration
environment	SCClusterNetworkEnvironmentEntity	Specification of the cluster environment
httpEndpoint	string	The cluster HTTP request URL.
kafkaBootstrapEndpoint	string	The bootstrap endpoint used by Kafka clients to connect to the cluster
name	string	The name of the cluster
network	SCClusterNetworkEnvironmentEntity	Specification of the cluster network
package	Package	Stream governance configuration
region	string	The cloud service provider region
zone	string	type of zone availability

SCMetadataEntity

Object

Metadata of the data record

Name	Type	Description
createdTimestamp	string	Created Date Time
deletedTimestamp	string	Deleted Date time
resourceName	string	Resource name of the record
self	string	Self lookup url
updatedTimestamp	string	Updated Date time

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	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 (date-time)	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.

Share via

Organization - List Clusters

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

Organization_ListClusters

Sample request

Sample response

Definitions

ClusterConfigEntity

ClusterStatusEntity

createdByType

ErrorResponseBody

ListClustersSuccessResponse

Package

ResourceProviderDefaultErrorResponse

SCClusterByokEntity

SCClusterNetworkEnvironmentEntity

SCClusterRecord

SCClusterSpecEntity

SCMetadataEntity

systemData