Get-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 .
Get confluent topic by Name
Syntax
List (Default)
Get-AzConfluentTopic
-ClusterId <String>
-EnvironmentId <String>
-OrganizationName <String>
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-PageSize <Int32>]
[-PageToken <String>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
GetViaIdentityOrganization
Get-AzConfluentTopic
-ClusterId <String>
-EnvironmentId <String>
-Name <String>
-OrganizationInputObject <IConfluentIdentity>
[-DefaultProfile <PSObject>]
[<CommonParameters>]
GetViaIdentityEnvironment
Get-AzConfluentTopic
-ClusterId <String>
-Name <String>
-EnvironmentInputObject <IConfluentIdentity>
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get
Get-AzConfluentTopic
-ClusterId <String>
-EnvironmentId <String>
-Name <String>
-OrganizationName <String>
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
GetViaIdentityCluster
Get-AzConfluentTopic
-Name <String>
-ClusterInputObject <IConfluentIdentity>
[-DefaultProfile <PSObject>]
[<CommonParameters>]
GetViaIdentity
Get-AzConfluentTopic
-InputObject <IConfluentIdentity>
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Description
Get confluent topic by Name
Examples
Example 1: List Topics in a cluster
Get-AzConfluentTopic -ClusterId lkc-examplekafka1 -EnvironmentId env-exampleenv001 -OrganizationName sharedrp-scus-org -ResourceGroupName sharedrp-confluent
Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName
---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- -----------------
cosmos.metadata.topic.lcc-stgc1vpmx5 sharedrp-confluent
cosmos.metadata.topic.lcc-stgcm9kon1 sharedrp-confluent
cosmos.metadata.topic.lcc-stgcq309wp sharedrp-confluent
dlq-lcc-stgc3xwgpm sharedrp-confluent
dlq-lcc-stgc5jmo38 sharedrp-confluent
dlq-lcc-stgc62rn93 sharedrp-confluent
dlq-lcc-stgc80v17q sharedrp-confluent
dlq-lcc-stgcdn1njo sharedrp-confluent
dlq-lcc-stgcdnvydz sharedrp-confluent
dlq-lcc-stgcgokr23 sharedrp-confluent
dlq-lcc-stgcgow69m sharedrp-confluent
dlq-lcc-stgcm92vnw sharedrp-confluent
dlq-lcc-stgcm9g1zq sharedrp-confluent
dlq-lcc-stgcn8j9gk sharedrp-confluent
dlq-lcc-stgcp2kpgk sharedrp-confluent
dlq-lcc-stgcydg857 sharedrp-confluent
dlq-lcc-stgcydyj1o sharedrp-confluent
dlq-lcc-stgcyv2666 sharedrp-confluent
dlq-lcc-stgcyvd3ok sharedrp-confluent
dlq-lcc-stgcyvg91k sharedrp-confluent
dlq-lcc-stgczxdz73 sharedrp-confluent
testtopic1 sharedrp-confluent
topic_1 sharedrp-confluent
topic_2 sharedrp-confluent
topic_3 sharedrp-confluent
This command lists all topics in cluster
Example 2: Get Topic by topic name
Get-AzConfluentTopic -ClusterId lkc-examplekafka1 -EnvironmentId env-exampleenv001 -Name <String> -OrganizationName sharedrp-scus-org -ResourceGroupName sharedrp-confluent
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_1
InputConfig : {}
Kind :
MetadataResourceName :
MetadataSelf : Self
Name : topic_1
PartitionReassignmentRelated :
PartitionRelated :
PartitionsCount : 6
ReplicationFactor : 3
ResourceGroupName : sharedrp-confluent
SystemDataCreatedAt :
SystemDataCreatedBy :
SystemDataCreatedByType :
SystemDataLastModifiedAt :
SystemDataLastModifiedBy :
SystemDataLastModifiedByType :
TopicId :
Type : microsoft.confluent/organizations/environments/clusters/topics
This command fetches topic details by topic name
Parameters
-ClusterId
Confluent kafka or schema registry cluster id
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
List
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetViaIdentityOrganization
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetViaIdentityEnvironment
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Get
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
GetViaIdentityCluster
Position: Named Mandatory: True Value from pipeline: True 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
List
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetViaIdentityOrganization
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Get
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
GetViaIdentityEnvironment
Position: Named Mandatory: True Value from pipeline: True 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
GetViaIdentity
Position: Named Mandatory: True Value from pipeline: True 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
GetViaIdentityOrganization
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetViaIdentityEnvironment
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Get
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetViaIdentityCluster
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
GetViaIdentityOrganization
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
List
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Get
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-PageSize
Pagination size
Parameter properties
Type: Int32
Default value: None Supports wildcards: False DontShow: False
Parameter sets
List
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-PageToken
An opaque pagination token to fetch the next set of records
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
List
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
List
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Get
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
List
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Get
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
