Get-AzServiceBusTopic

  • Reference
Module:
Az.ServiceBus

Returns a description for the specified topic.

Syntax

Get-AzServiceBusTopic
   -NamespaceName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-Skip <Int32>]
   [-Top <Int32>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzServiceBusTopic
   -Name <String>
   -NamespaceInputObject <IServiceBusIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzServiceBusTopic
   -Name <String>
   -NamespaceName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzServiceBusTopic
   -InputObject <IServiceBusIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Returns a description for the specified topic.

Examples

Example 1: Get the details of the ServiceBus topic

Get-AzServiceBusTopic -ResourceGroupName myResourceGroup -NamespaceName myNamespace -TopicName myTopic

AccessedAt                                : 9/21/2022 2:30:14 PM
AutoDeleteOnIdle                          : 3.00:00:00
CreatedAt                                 : 9/7/2022 10:05:52 AM
DefaultMessageTimeToLive                  : 10675197.00:00:00
DuplicateDetectionHistoryTimeWindow       : 00:10:00
EnableBatchedOperations                   : True
EnableExpress                             : False
EnablePartitioning                        : False
Id                                        : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace/topics/myTopic
Location                                  : westus
MaxMessageSizeInKilobytes                 : 1024
MaxSizeInMegabytes                        : 1024
Name                                      : a
RequiresDuplicateDetection                : False
ResourceGroupName                         : damorg
SizeInByte                                : 0
Status                                    : Active
SubscriptionCount                         : 2
SupportOrdering                           : True

Get the details of ServiceBus topic myTopic from namespace myNamespace.

Example 2: List all topics in a ServiceBus namespace

Get-AzServiceBusTopic -ResourceGroupName myResourceGroup -NamespaceName myNamespace

Lists all topics in ServiceBus namespace myNamespace.

Parameters

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Identity Parameter

Type:IServiceBusIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

The topic name.

Type:String
Aliases:TopicName
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-NamespaceInputObject

Identity Parameter

Type:IServiceBusIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-NamespaceName

The namespace name

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

Name of the Resource group within the Azure subscription.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Skip

Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SubscriptionId

Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Type:String[]
Position:Named
Default value:(Get-AzContext).Subscription.Id
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Top

May be used to limit the number of results to the most recent N usageDetails.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

IServiceBusIdentity

Outputs

ISbTopic