Update-AzConfluentTopic
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 topics by Name
Syntax
UpdateExpanded (Default)
Update-AzConfluentTopic
-ClusterId <String>
-EnvironmentId <String>
-Name <String>
-OrganizationName <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-ConfigRelated <String>]
[-InputConfig <ITopicsInputConfig[]>]
[-Kind <String>]
[-MetadataResourceName <String>]
[-MetadataSelf <String>]
[-PartitionReassignmentRelated <String>]
[-PartitionRelated <String>]
[-PartitionsCount <String>]
[-ReplicationFactor <String>]
[-TopicId <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaIdentityOrganizationExpanded
Update-AzConfluentTopic
-ClusterId <String>
-EnvironmentId <String>
-Name <String>
-OrganizationInputObject <IConfluentIdentity>
[-ConfigRelated <String>]
[-InputConfig <ITopicsInputConfig[]>]
[-Kind <String>]
[-MetadataResourceName <String>]
[-MetadataSelf <String>]
[-PartitionReassignmentRelated <String>]
[-PartitionRelated <String>]
[-PartitionsCount <String>]
[-ReplicationFactor <String>]
[-TopicId <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaIdentityEnvironmentExpanded
Update-AzConfluentTopic
-ClusterId <String>
-Name <String>
-EnvironmentInputObject <IConfluentIdentity>
[-ConfigRelated <String>]
[-InputConfig <ITopicsInputConfig[]>]
[-Kind <String>]
[-MetadataResourceName <String>]
[-MetadataSelf <String>]
[-PartitionReassignmentRelated <String>]
[-PartitionRelated <String>]
[-PartitionsCount <String>]
[-ReplicationFactor <String>]
[-TopicId <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaIdentityClusterExpanded
Update-AzConfluentTopic
-Name <String>
-ClusterInputObject <IConfluentIdentity>
[-ConfigRelated <String>]
[-InputConfig <ITopicsInputConfig[]>]
[-Kind <String>]
[-MetadataResourceName <String>]
[-MetadataSelf <String>]
[-PartitionReassignmentRelated <String>]
[-PartitionRelated <String>]
[-PartitionsCount <String>]
[-ReplicationFactor <String>]
[-TopicId <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaIdentityExpanded
Update-AzConfluentTopic
-InputObject <IConfluentIdentity>
[-ConfigRelated <String>]
[-InputConfig <ITopicsInputConfig[]>]
[-Kind <String>]
[-MetadataResourceName <String>]
[-MetadataSelf <String>]
[-PartitionReassignmentRelated <String>]
[-PartitionRelated <String>]
[-PartitionsCount <String>]
[-ReplicationFactor <String>]
[-TopicId <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Update confluent topics by Name
Examples
Example 1: Update Topic
Update-AzConfluentTopic `
-OrganizationName "sharedrp-scus-org" `
-ResourceGroupName "sharedrp-confluent" `
-EnvironmentId "env-exampleenv001" `
-ClusterId "lkc-examplekafka1" `
-Name "topic_2" `
-PartitionsCount "6" `
-ReplicationFactor "3"
ConfigRelated :
Id : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/sharedrp-confluent/providers/Microsoft.Confluent/organizations/sharedrp-scus-org/environments/env-exampleenv001/clusters/lkc-examplekafka1/topics/topic_2
InputConfig : {}
Kind :
MetadataResourceName :
MetadataSelf : Self
Name : topic_2
PartitionReassignmentRelated :
PartitionRelated :
PartitionsCount : 6
ReplicationFactor : 3
ResourceGroupName : sharedrp-confluent
SystemDataCreatedAt : 1/7/2026 4:23:20 AM
SystemDataCreatedBy : user4@example.com
SystemDataCreatedByType : User
SystemDataLastModifiedAt : 3/7/2026 3:36:11 PM
SystemDataLastModifiedBy : user4@example.com
SystemDataLastModifiedByType : User
TopicId :
Type : microsoft.confluent/organizations/environments/clusters/topics
This command updates confluent topics
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
Identity Parameter
Type: Microsoft.Azure.PowerShell.Cmdlets.confluent.Models.IConfluentIdentity
Default value: None Supports wildcards: False DontShow: False
UpdateViaIdentityClusterExpanded
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
Relationship of the topic
Type: String
Default value: None Supports wildcards: False DontShow: False
(All)
Position: Named Mandatory: False Value from pipeline: False 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
-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
Identity Parameter
Type: Microsoft.Azure.PowerShell.Cmdlets.confluent.Models.IConfluentIdentity
Default value: None Supports wildcards: False DontShow: False
UpdateViaIdentityEnvironmentExpanded
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
Input Config Specification of the topic
Type: Microsoft.Azure.PowerShell.Cmdlets.confluent.Models.ITopicsInputConfig [ ]
Default value: None Supports wildcards: False DontShow: False
(All)
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
UpdateViaIdentityExpanded
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-Kind
Type of topic
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
Resource name of the record
Type: String
Default value: None Supports wildcards: False DontShow: False
(All)
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
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Name
Confluent kafka or schema registry topic name
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: TopicName
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
Identity Parameter
Type: Microsoft.Azure.PowerShell.Cmdlets.confluent.Models.IConfluentIdentity
Default value: None Supports wildcards: False DontShow: False
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
Relationship of the topic
Type: String
Default value: None Supports wildcards: False DontShow: False
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Relationship of the topic
Type: String
Default value: None Supports wildcards: False DontShow: False
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-PartitionsCount
Partition count of the topic
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
-ReplicationFactor
Replication factor of the topic
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
-TopicId
Topic Id returned by Confluent
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
-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.ITopicRecord
