Edit

Get-AzConfluentOrganizationEnvironment

  • 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 Environment details by environment Id

Syntax

List (Default) 

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

GetViaIdentityOrganization 

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

Get 

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

GetViaIdentity 

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

Description

Get Environment details by environment Id

Examples

Example 1: List all environments in the organization

Get-AzConfluentOrganizationEnvironment -OrganizationName sharedrp-scus-org -ResourceGroupName sharedrp-confluent

Get-AzConfluentOrganizationEnvironment -OrganizationName sharedrp-scus-org -ResourceGroupName sharedrp-confluent

Name                  SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType Kind        ResourceGroupName
----                  ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----        -----------------
default                                                                                                                                                              Environment sharedrp-confluent
test-env-0                                                                                                                                                         Environment sharedrp-confluent
test-env-1                                                                                                                                                         Environment sharedrp-confluent
test-env-2                                                                                                                                                         Environment sharedrp-confluent
test-env-3                                                                                                                                                         Environment sharedrp-confluent
shekarTest                                                                                                                                                           Environment sharedrp-confluent
test-env-4                                                                                                                                                Environment sharedrp-confluent
praveen-test-env                                                                                                                                                     Environment sharedrp-confluent
env1136                                                                                                                                                              Environment sharedrp-confluent
testEnv1                                                                                                                                                             Environment sharedrp-confluent

This commands list all environments in an organization

Example 2: Get Environment details by environment ID

Get-AzConfluentOrganizationEnvironment -EnvironmentId 'shekarTest' -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/shekarTes
                                t
Kind                          : Environment
MetadataCreatedTimestamp      : 12/19/2025 09:33:39 +00:00
MetadataDeletedTimestamp      :
MetadataResourceName          : crn://example.confluent.io/organization=00000000-0000-0000-0000-000000000000/environment=env-exampleenv001
MetadataSelf                  : https://api.example.confluent.io/org/v2/environments/env-exampleenv001
MetadataUpdatedTimestamp      : 12/19/2025 09:33:39 +00:00
Name                          : shekarTest
ResourceGroupName             : sharedrp-confluent
StreamGovernanceConfigPackage : ESSENTIALS
SystemDataCreatedAt           :
SystemDataCreatedBy           :
SystemDataCreatedByType       :
SystemDataLastModifiedAt      :
SystemDataLastModifiedBy      :
SystemDataLastModifiedByType  :
Type                          : microsoft.confluent/organizations/environments

This commands fetches environment details of an environment by environment ID

Parameters

-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

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

-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.IScEnvironmentRecord