Edit

Get-AzConfluentOrganizationCluster

  • Preview
Module:
Az.Confluent Module

This cmdlet is part of a Preview module. Preview versions aren't recommended for use in production environments. For more information, see https://aka.ms/azps-refstatus.

Get cluster by Id

Syntax

List (Default) 

Get-AzConfluentOrganizationCluster
    -EnvironmentId <String>
    -OrganizationName <String>
    -ResourceGroupName <String>
    [-SubscriptionId <String[]>]
    [-PageSize <Int32>]
    [-PageToken <String>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentityOrganization 

Get-AzConfluentOrganizationCluster
    -ClusterId <String>
    -EnvironmentId <String>
    -OrganizationInputObject <IConfluentIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentityEnvironment 

Get-AzConfluentOrganizationCluster
    -ClusterId <String>
    -EnvironmentInputObject <IConfluentIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Get 

Get-AzConfluentOrganizationCluster
    -ClusterId <String>
    -EnvironmentId <String>
    -OrganizationName <String>
    -ResourceGroupName <String>
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentity 

Get-AzConfluentOrganizationCluster
    -InputObject <IConfluentIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Description

Get cluster by Id

Examples

Example 1: Get Cluster by Cluster ID

Get-AzConfluentOrganizationCluster -ClusterId cluster_1 -EnvironmentId env-exampleenv001 -OrganizationName sharedrp-scus-org -ResourceGroupName sharedrp-confluent

Id                           : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/sharedrp-confluent/providers/Microsoft.Confluent/organizations/sharedrp-scus-org/environments/env-exampleenv001/clusters/cluster_1
Kind                         : Cluster
MetadataCreatedTimestamp     : 12/19/2025 09:35:30 +00:00
MetadataDeletedTimestamp     :
MetadataResourceName         : crn://confluent.cloud/organization=00000000-0000-0000-0000-000000000000/environment=env-exampleenv001/cloud-cluster=lkc-examplekafka1/kafka=lkc-examplekafka1
MetadataSelf                 : https://api.example.confluent.io/cmk/v2/clusters/lkc-examplekafka1
MetadataUpdatedTimestamp     : 12/19/2025 09:35:30 +00:00
Name                         : cluster_1
ResourceGroupName            : sharedrp-confluent
Spec                         : {
                                 "config": {
                                   "kind": "Basic"
                                 },
                                 "environment": {
                                   "id": "env-exampleenv001"
                                 },
                                 "name": "cluster_1",
                                 "availability": "SINGLE_ZONE",
                                 "cloud": "AZURE",
                                 "region": "centralus",
                                 "httpEndpoint": "https://pkc-exampleabc001.centralus.azure.example.confluent.io:443",
                                 "apiEndpoint": ""
                               }
StatusCku                    : 0
StatusPhase                  : PROVISIONING
SystemDataCreatedAt          :
SystemDataCreatedBy          :
SystemDataCreatedByType      :
SystemDataLastModifiedAt     :
SystemDataLastModifiedBy     :
SystemDataLastModifiedByType :
Type                         : microsoft.confluent/organizations/environments/clusters

This command fetches the cluster details by cluster ID

Parameters

-ClusterId

Confluent kafka or schema registry cluster id

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

GetViaIdentityOrganization
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
GetViaIdentityEnvironment
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Get
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Parameter properties

Type:PSObject
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzureRMContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-EnvironmentId

Confluent environment id

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

List
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
GetViaIdentityOrganization
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Get
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-EnvironmentInputObject

Identity Parameter

Parameter properties

Type:Microsoft.Azure.PowerShell.Cmdlets.confluent.Models.IConfluentIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

GetViaIdentityEnvironment
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Identity Parameter

Parameter properties

Type:Microsoft.Azure.PowerShell.Cmdlets.confluent.Models.IConfluentIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

GetViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-OrganizationInputObject

Identity Parameter

Parameter properties

Type:Microsoft.Azure.PowerShell.Cmdlets.confluent.Models.IConfluentIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

GetViaIdentityOrganization
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-OrganizationName

Organization resource name

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

List
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Get
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PageSize

Pagination size

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

List
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PageToken

An opaque pagination token to fetch the next set of records

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

List
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResourceGroupName

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

List
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Get
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SubscriptionId

The ID of the target subscription. The value must be an UUID.

Parameter properties

Type:

String[]

Default value:(Get-AzContext).Subscription.Id
Supports wildcards:False
DontShow:False

Parameter sets

List
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Get
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.Azure.PowerShell.Cmdlets.confluent.Models.IConfluentIdentity

Outputs

Microsoft.Azure.PowerShell.Cmdlets.confluent.Models.IScClusterRecord