New-AzConfluentConnector
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 connector by Name
Syntax
CreateExpanded (Default)
New-AzConfluentConnector
-Name <String>
-ClusterId <String>
-EnvironmentId <String>
-OrganizationName <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-ConnectorBasicInfoConnectorClassName <String>]
[-ConnectorBasicInfoConnectorId <String>]
[-ConnectorBasicInfoConnectorName <String>]
[-ConnectorBasicInfoConnectorState <String>]
[-ConnectorBasicInfoConnectorType <String>]
[-ConnectorServiceTypeInfoConnectorServiceType <String>]
[-PartnerConnectorInfoPartnerConnectorType <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
CreateViaJsonString
New-AzConfluentConnector
-Name <String>
-ClusterId <String>
-EnvironmentId <String>
-OrganizationName <String>
-ResourceGroupName <String>
-JsonString <String>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
CreateViaJsonFilePath
New-AzConfluentConnector
-Name <String>
-ClusterId <String>
-EnvironmentId <String>
-OrganizationName <String>
-ResourceGroupName <String>
-JsonFilePath <String>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
CreateViaIdentityOrganizationExpanded
New-AzConfluentConnector
-Name <String>
-ClusterId <String>
-EnvironmentId <String>
-OrganizationInputObject <IConfluentIdentity>
[-ConnectorBasicInfoConnectorClassName <String>]
[-ConnectorBasicInfoConnectorId <String>]
[-ConnectorBasicInfoConnectorName <String>]
[-ConnectorBasicInfoConnectorState <String>]
[-ConnectorBasicInfoConnectorType <String>]
[-ConnectorServiceTypeInfoConnectorServiceType <String>]
[-PartnerConnectorInfoPartnerConnectorType <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
CreateViaIdentityEnvironmentExpanded
New-AzConfluentConnector
-Name <String>
-ClusterId <String>
-EnvironmentInputObject <IConfluentIdentity>
[-ConnectorBasicInfoConnectorClassName <String>]
[-ConnectorBasicInfoConnectorId <String>]
[-ConnectorBasicInfoConnectorName <String>]
[-ConnectorBasicInfoConnectorState <String>]
[-ConnectorBasicInfoConnectorType <String>]
[-ConnectorServiceTypeInfoConnectorServiceType <String>]
[-PartnerConnectorInfoPartnerConnectorType <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
CreateViaIdentityClusterExpanded
New-AzConfluentConnector
-Name <String>
-ClusterInputObject <IConfluentIdentity>
[-ConnectorBasicInfoConnectorClassName <String>]
[-ConnectorBasicInfoConnectorId <String>]
[-ConnectorBasicInfoConnectorName <String>]
[-ConnectorBasicInfoConnectorState <String>]
[-ConnectorBasicInfoConnectorType <String>]
[-ConnectorServiceTypeInfoConnectorServiceType <String>]
[-PartnerConnectorInfoPartnerConnectorType <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Create confluent connector by Name
Examples
Example 1: Create confluent Connector
New-AzConfluentConnector `
-OrganizationName "sharedrp-scus-org" `
-ResourceGroupName "sharedrp-confluent" `
-EnvironmentId "env-exampleenv001" `
-ClusterId "lkc-examplekafka1" `
-Name "conn_3" `
-JsonString '{
"properties": {
"connectorBasicInfo": {
"connectorType": "SOURCE",
"connectorClass": "AZUREBLOBSOURCE",
"connectorName": "conn_3"
},
"connectorServiceTypeInfo": {
"connectorServiceType": "AzureBlobStorageSourceConnector",
"storageAccountName": "examplestorageacct",
"storageAccountKey": "<base64-encoded-storage-account-key>",
"storageContainerName": "testcontainer"
},
"partnerConnectorInfo": {
"partnerConnectorType": "KafkaAzureBlobStorageSource",
"maxTasks": "1",
"authType": "KAFKA_API_KEY",
"inputFormat": "AVRO",
"outputFormat": "AVRO",
"topicRegex": "topics:.*",
"topicsDir": "topicsDir"
}
}
}'
ConnectorBasicInfoConnectorClassName : AZUREBLOBSOURCE
ConnectorBasicInfoConnectorId :
ConnectorBasicInfoConnectorName : conn_3
ConnectorBasicInfoConnectorState : PROVISIONING
ConnectorBasicInfoConnectorType : SOURCE
ConnectorServiceTypeInfo : {
"connectorServiceType": "AzureBlobStorageSourceConnector",
"storageAccountName": "examplestorageacct",
"storageContainerName": "testcontainer"
}
ConnectorServiceTypeInfoConnectorServiceType : AzureBlobStorageSourceConnector
Id : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/sharedrp-confluent/providers/Microsoft.Confluent/organizations/sharedrp-scus-org/environ
ments/env-exampleenv001/clusters/lkc-examplekafka1/connectors/conn_3
Name : conn_3
PartnerConnectorInfo : {
"partnerConnectorType": "KafkaAzureBlobStorageSource",
"authType": "KAFKA_API_KEY",
"inputFormat": "AVRO",
"outputFormat": "AVRO",
"topicRegex": "topics:.*",
"topicsDir": "topicsDir",
"maxTasks": "1"
}
PartnerConnectorInfoPartnerConnectorType : KafkaAzureBlobStorageSource
ResourceGroupName : sharedrp-confluent
SystemDataCreatedAt : 3/7/2026 2:13:50 PM
SystemDataCreatedBy : user4@example.com
SystemDataCreatedByType : User
SystemDataLastModifiedAt : 3/7/2026 2:16:41 PM
SystemDataLastModifiedBy : user4@example.com
SystemDataLastModifiedByType : User
Type : microsoft.confluent/organizations/environments/clusters/connectors
This command create confluent connector
Parameters
-ClusterId
Confluent kafka or schema registry cluster id
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
CreateViaIdentityOrganizationExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaIdentityEnvironmentExpanded
Position: Named Mandatory: True 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
CreateViaIdentityClusterExpanded
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
-ConnectorBasicInfoConnectorClassName
Connector Class
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
CreateViaIdentityEnvironmentExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaIdentityClusterExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ConnectorBasicInfoConnectorId
Connector Id
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
CreateViaIdentityEnvironmentExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaIdentityClusterExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ConnectorBasicInfoConnectorName
Connector Name
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
CreateViaIdentityEnvironmentExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaIdentityClusterExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ConnectorBasicInfoConnectorState
Connector Status
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
CreateViaIdentityEnvironmentExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaIdentityClusterExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ConnectorBasicInfoConnectorType
Connector Type
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
CreateViaIdentityEnvironmentExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaIdentityClusterExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ConnectorServiceTypeInfoConnectorServiceType
The connector service type.
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
CreateViaIdentityEnvironmentExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaIdentityClusterExpanded
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
-EnvironmentId
Confluent environment id
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
CreateViaIdentityOrganizationExpanded
Position: Named Mandatory: True 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
CreateViaIdentityEnvironmentExpanded
Position: Named Mandatory: True Value from pipeline: True 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
-Name
Confluent connector name
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: ConnectorName
Parameter sets
(All)
Position: Named Mandatory: True 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
-PartnerConnectorInfoPartnerConnectorType
The partner connector type.
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
CreateViaIdentityEnvironmentExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaIdentityClusterExpanded
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
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
-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.IConnectorResource
