New-AzConfluentEnvironment
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 .
Create confluent environment
Syntax
CreateExpanded (Default)
New-AzConfluentEnvironment
-Id <String>
-OrganizationName <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-Kind <String>]
[-MetadataCreatedTimestamp <String>]
[-MetadataDeletedTimestamp <String>]
[-MetadataResourceName <String>]
[-MetadataSelf <String>]
[-MetadataUpdatedTimestamp <String>]
[-StreamGovernanceConfigPackage <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
CreateViaJsonString
New-AzConfluentEnvironment
-Id <String>
-OrganizationName <String>
-ResourceGroupName <String>
-JsonString <String>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
CreateViaJsonFilePath
New-AzConfluentEnvironment
-Id <String>
-OrganizationName <String>
-ResourceGroupName <String>
-JsonFilePath <String>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
CreateViaIdentityOrganizationExpanded
New-AzConfluentEnvironment
-Id <String>
-OrganizationInputObject <IConfluentIdentity>
[-Kind <String>]
[-MetadataCreatedTimestamp <String>]
[-MetadataDeletedTimestamp <String>]
[-MetadataResourceName <String>]
[-MetadataSelf <String>]
[-MetadataUpdatedTimestamp <String>]
[-StreamGovernanceConfigPackage <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Create confluent environment
Examples
Example 1: Create confluent environment
New-AzConfluentEnvironment `
-OrganizationName "sharedrp-scus-org" `
-ResourceGroupName "sharedrp-confluent" `
-Id "env-xxxxx" `
-Kind "Environment" `
-StreamGovernanceConfigPackage "ESSENTIALS"
Id : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/sharedrp-confluent/providers/Microsoft.Confluent/organizations/sharedrp-scus-org/environments/env-xxxxx
Kind : Environment
MetadataCreatedTimestamp :
MetadataDeletedTimestamp :
MetadataResourceName :
MetadataSelf :
MetadataUpdatedTimestamp :
Name : env-xxxxx
ResourceGroupName : sharedrp-confluent
StreamGovernanceConfigPackage : ESSENTIALS
SystemDataCreatedAt : 3/7/2026 2:11:30 PM
SystemDataCreatedBy : user4@example.com
SystemDataCreatedByType : User
SystemDataLastModifiedAt : 3/7/2026 2:11:30 PM
SystemDataLastModifiedBy : user4@example.com
SystemDataLastModifiedByType : User
Type : microsoft.confluent/organizations/environments
This command create confluent environment
Example 2: Create confluent environment with JSON string
New-AzConfluentEnvironment `
-OrganizationName "sharedrp-scus-org" `
-ResourceGroupName "sharedrp-confluent" `
-Id "env-zzzzz" `
-JsonString '{
"properties": {
"streamGovernanceConfig": {
"package": "ESSENTIALS"
}
}
}'
Id : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/sharedrp-confluent/providers/Microsoft.Confluent/organizations/sharedrp-scus-org/environments/env-zzzzz
Kind :
MetadataCreatedTimestamp :
MetadataDeletedTimestamp :
MetadataResourceName :
MetadataSelf :
MetadataUpdatedTimestamp :
Name : env-zzzzz
ResourceGroupName : sharedrp-confluent
StreamGovernanceConfigPackage : ESSENTIALS
SystemDataCreatedAt : 3/7/2026 2:12:38 PM
SystemDataCreatedBy : user4@example.com
SystemDataCreatedByType : User
SystemDataLastModifiedAt : 3/7/2026 2:12:38 PM
SystemDataLastModifiedBy : user4@example.com
SystemDataLastModifiedByType : User
Type : microsoft.confluent/organizations/environments
This command create confluent environment
Parameters
-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
-Id
Confluent environment id
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: EnvironmentId
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-JsonFilePath
Path of Json file supplied to the Create operation
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateViaJsonFilePath
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 Create operation
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Kind
Type of environment
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaIdentityOrganizationExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Created Date Time
Type: String
Default value: None Supports wildcards: False DontShow: False
CreateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaIdentityOrganizationExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Deleted Date time
Type: String
Default value: None Supports wildcards: False DontShow: False
CreateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaIdentityOrganizationExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Resource name of the record
Type: String
Default value: None Supports wildcards: False DontShow: False
CreateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaIdentityOrganizationExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Self lookup url
Type: String
Default value: None Supports wildcards: False DontShow: False
CreateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaIdentityOrganizationExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Updated Date time
Type: String
Default value: None Supports wildcards: False DontShow: False
CreateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaIdentityOrganizationExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Identity Parameter
Type: Microsoft.Azure.PowerShell.Cmdlets.confluent.Models.IConfluentIdentity
Default value: None Supports wildcards: False DontShow: False
CreateViaIdentityOrganizationExpanded
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
CreateExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaJsonFilePath
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
CreateExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaJsonFilePath
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-StreamGovernanceConfigPackage
Stream governance configuration
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaIdentityOrganizationExpanded
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
CreateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaJsonString
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaJsonFilePath
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 .
Microsoft.Azure.PowerShell.Cmdlets.confluent.Models.IConfluentIdentity
Outputs
Microsoft.Azure.PowerShell.Cmdlets.confluent.Models.IScEnvironmentRecord
