Edit

Update-AzConfluentConnector

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

Update confluent connector by Name

Syntax

UpdateExpanded (Default) 

Update-AzConfluentConnector
    -ClusterId <String>
    -EnvironmentId <String>
    -Name <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>]

UpdateViaIdentityOrganizationExpanded 

Update-AzConfluentConnector
    -ClusterId <String>
    -EnvironmentId <String>
    -Name <String>
    -OrganizationInputObject <IConfluentIdentity>
    [-ConnectorBasicInfoConnectorClassName <String>]
    [-ConnectorBasicInfoConnectorId <String>]
    [-ConnectorBasicInfoConnectorName <String>]
    [-ConnectorBasicInfoConnectorState <String>]
    [-ConnectorBasicInfoConnectorType <String>]
    [-ConnectorServiceTypeInfoConnectorServiceType <String>]
    [-PartnerConnectorInfoPartnerConnectorType <String>]
    [-DefaultProfile <PSObject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UpdateViaIdentityEnvironmentExpanded 

Update-AzConfluentConnector
    -ClusterId <String>
    -Name <String>
    -EnvironmentInputObject <IConfluentIdentity>
    [-ConnectorBasicInfoConnectorClassName <String>]
    [-ConnectorBasicInfoConnectorId <String>]
    [-ConnectorBasicInfoConnectorName <String>]
    [-ConnectorBasicInfoConnectorState <String>]
    [-ConnectorBasicInfoConnectorType <String>]
    [-ConnectorServiceTypeInfoConnectorServiceType <String>]
    [-PartnerConnectorInfoPartnerConnectorType <String>]
    [-DefaultProfile <PSObject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UpdateViaIdentityClusterExpanded 

Update-AzConfluentConnector
    -Name <String>
    -ClusterInputObject <IConfluentIdentity>
    [-ConnectorBasicInfoConnectorClassName <String>]
    [-ConnectorBasicInfoConnectorId <String>]
    [-ConnectorBasicInfoConnectorName <String>]
    [-ConnectorBasicInfoConnectorState <String>]
    [-ConnectorBasicInfoConnectorType <String>]
    [-ConnectorServiceTypeInfoConnectorServiceType <String>]
    [-PartnerConnectorInfoPartnerConnectorType <String>]
    [-DefaultProfile <PSObject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UpdateViaIdentityExpanded 

Update-AzConfluentConnector
    -InputObject <IConfluentIdentity>
    [-ConnectorBasicInfoConnectorClassName <String>]
    [-ConnectorBasicInfoConnectorId <String>]
    [-ConnectorBasicInfoConnectorName <String>]
    [-ConnectorBasicInfoConnectorState <String>]
    [-ConnectorBasicInfoConnectorType <String>]
    [-ConnectorServiceTypeInfoConnectorServiceType <String>]
    [-PartnerConnectorInfoPartnerConnectorType <String>]
    [-DefaultProfile <PSObject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Update confluent connector by Name

Examples

Example 1: Update confluent connector

Update-AzConfluentConnector `
    -OrganizationName "sharedrp-scus-org" `
    -ResourceGroupName "sharedrp-confluent" `
    -EnvironmentId "env-exampleenv001" `
    -ClusterId "lkc-examplekafka1" `
    -Name "conn_2" `
    -ConnectorBasicInfoConnectorClassName "AZUREBLOBSOURCE" `
    -ConnectorBasicInfoConnectorName "conn_2" `
    -ConnectorBasicInfoConnectorType "SOURCE" `
    -ConnectorServiceTypeInfoConnectorServiceType "AzureBlobStorageSourceConnector" `
    -PartnerConnectorInfoPartnerConnectorType "KafkaAzureBlobStorageSource"

ConnectorBasicInfoConnectorClassName             : AZUREBLOBSOURCE
ConnectorBasicInfoConnectorId                : /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_2
ConnectorBasicInfoConnectorName              : conn_2
ConnectorBasicInfoConnectorState             : PROVISIONING
ConnectorBasicInfoConnectorType              : SOURCE
ConnectorServiceTypeInfo                     : {
                                                 "connectorServiceType": "AzureBlobStorageSinkConnector",
                                                 "storageAccountName": "examplestorageacct",
                                                 "storageAccountKey": "<base64-encoded-storage-account-key>",
                                                 "storageContainerName": "testcontainer"
                                               }
ConnectorServiceTypeInfoConnectorServiceType : AzureBlobStorageSinkConnector
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_2
Name                                         : conn_2
PartnerConnectorInfo                         : {
                                                 "partnerConnectorType": "KafkaAzureBlobStorageSink",
                                                 "authType": "KAFKA_API_KEY",
                                                 "inputFormat": "AVRO",
                                                 "outputFormat": "AVRO",
                                                 "apiKey": "<ApiKey>",
                                                 "apiSecret": "<ApiSecret>",
                                                 "topics": [ "topic_1" ],
                                                 "topicsDir": "topicsDir",
                                                 "flushSize": "1000",
                                                 "maxTasks": "1",
                                                 "timeInterval": "DAILY"
                                               }
PartnerConnectorInfoPartnerConnectorType     : KafkaAzureBlobStorageSink
ResourceGroupName                            : sharedrp-confluent
SystemDataCreatedAt                          : 3/7/2026 11:57:53 AM
SystemDataCreatedBy                          : user4@example.com
SystemDataCreatedByType                      : User
SystemDataLastModifiedAt                     : 3/7/2026 3:35:10 PM
SystemDataLastModifiedBy                     : user4@example.com
SystemDataLastModifiedByType                 : User
Type                                         : microsoft.confluent/organizations/environments/clusters/connectors

This command updated 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

UpdateExpanded
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityOrganizationExpanded
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityEnvironmentExpanded
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ClusterInputObject

Identity Parameter

Parameter properties

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

Parameter sets

UpdateViaIdentityClusterExpanded
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

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

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

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

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

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

(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

-EnvironmentId

Confluent environment id

Parameter properties

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

Parameter sets

UpdateExpanded
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityOrganizationExpanded
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

UpdateViaIdentityEnvironmentExpanded
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

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

UpdateExpanded
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityOrganizationExpanded
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityEnvironmentExpanded
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityClusterExpanded
Position:Named
Mandatory:True
Value from pipeline:False
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

UpdateViaIdentityOrganizationExpanded
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

UpdateExpanded
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

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

UpdateExpanded
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

UpdateExpanded
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.IConfluentIdentity

Outputs

Microsoft.Azure.PowerShell.Cmdlets.confluent.Models.IConnectorResource