Edit

Get-AzConfluentAccessEnvironment

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

Environment list of an organization

Syntax

ListExpanded (Default) 

Get-AzConfluentAccessEnvironment
    -OrganizationName <String>
    -ResourceGroupName <String>
    [-SubscriptionId <String[]>]
    [-SearchFilter <Hashtable>]
    [-DefaultProfile <PSObject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

List 

Get-AzConfluentAccessEnvironment
    -OrganizationName <String>
    -ResourceGroupName <String>
    -Body <IListAccessRequestModel>
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ListViaJsonFilePath 

Get-AzConfluentAccessEnvironment
    -OrganizationName <String>
    -ResourceGroupName <String>
    -JsonFilePath <String>
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ListViaJsonString 

Get-AzConfluentAccessEnvironment
    -OrganizationName <String>
    -ResourceGroupName <String>
    -JsonString <String>
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Environment list of an organization

Examples

Example 1: List all Confluent Environments under organization and under resource group

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

Data              : {{
                      "metadata": {
                        "self": "https://api.example.confluent.io/org/v2/environments/env-exampleenv002",
                        "resource_name": "crn://example.confluent.io/organization=00000000-0000-0000-0000-000000000000/environment=env-exampleenv002",
                        "created_at": "2025-11-03T14:15:40.878158+00:00",
                        "updated_at": "2025-11-03T14:15:40.878158+00:00"
                      },
                      "kind": "Environment",
                      "id": "env-exampleenv002",
                      "display_name": "default"
                    }, {
                      "metadata": {
                        "self": "https://api.example.confluent.io/org/v2/environments/env-exampleenv003",
                        "resource_name": "crn://example.confluent.io/organization=00000000-0000-0000-0000-000000000000/environment=env-exampleenv003",
                        "created_at": "2025-11-17T10:14:45.640567+00:00",
                        "updated_at": "2025-11-17T10:14:45.640567+00:00"
                      },
                      "kind": "Environment",
                      "id": "env-exampleenv003",
                      "display_name": "test-env-0"
                    }, {
                      "metadata": {
                        "self": "https://api.example.confluent.io/org/v2/environments/env-exampleenv004",
                        "resource_name": "crn://example.confluent.io/organization=00000000-0000-0000-0000-000000000000/environment=env-exampleenv004",
                        "created_at": "2025-11-28T09:41:04.588316+00:00",
                        "updated_at": "2025-11-28T09:41:04.588316+00:00"
                      },
                      "kind": "Environment",
                      "id": "env-exampleenv004",
                      "display_name": "test-env-1"
                    }, {
                      "metadata": {
                        "self": "https://api.example.confluent.io/org/v2/environments/env-exampleenv005",
                        "resource_name": "crn://example.confluent.io/organization=00000000-0000-0000-0000-000000000000/environment=env-exampleenv005",
                        "created_at": "2025-11-28T09:44:36.482039+00:00",
                        "updated_at": "2025-11-28T09:44:36.482039+00:00"
                      },
                      "kind": "Environment",
                      "id": "env-exampleenv005",
                      "display_name": "test-env-2"
                    }…}
Kind              : EnvironmentList
MetadataFirst     :
MetadataLast      :
MetadataNext      :
MetadataPrev      :
MetadataTotalSize : 0

This command lists all confluent environments under a organization and resource group

Parameters

-Body

List Access Request Model

Parameter properties

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

Parameter sets

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
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

-JsonFilePath

Path of Json file supplied to the List operation

Parameter properties

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

Parameter sets

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

-JsonString

Json string supplied to the List operation

Parameter properties

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

Parameter sets

ListViaJsonString
Position:Named
Mandatory:True
Value from pipeline:False
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

(All)
Position:Named
Mandatory:True
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

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

-SearchFilter

Search filters for the request

Parameter properties

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

Parameter sets

ListExpanded
Position:Named
Mandatory:False
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

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
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.IListAccessRequestModel

Outputs

Microsoft.Azure.PowerShell.Cmdlets.confluent.Models.IAccessListEnvironmentsSuccessResponse