Redigera

Dela via

Get-AzServiceBusSubscription

  • Reference
Module:
Az.ServiceBus

Returns a subscription description for the specified topic.

Syntax

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

Description

Returns a subscription description for the specified topic.

Examples

Example 1: Get details of the ServiceBus subscription

Get-AzServiceBusSubscription -ResourceGroupName myResourceGroup -NamespaceName myNamespace -TopicName myTopic -Name 'sub$$D'

AccessedAt                                : 1/1/0001 12:00:00 AM
AutoDeleteOnIdle                          : 1.00:03:04
ClientId                                  :
CountDetailActiveMessageCount             : 0
CountDetailDeadLetterMessageCount         : 0
CountDetailScheduledMessageCount          : 0
CountDetailTransferDeadLetterMessageCount : 0
CountDetailTransferMessageCount           : 0
CreatedAt                                 : 9/22/2022 6:17:32 AM
DeadLetteringOnFilterEvaluationException  : False
DeadLetteringOnMessageExpiration          : False
DefaultMessageTimeToLive                  : 14.00:00:00
DuplicateDetectionHistoryTimeWindow       :
EnableBatchedOperations                   : True
ForwardDeadLetteredMessagesTo             :
ForwardTo                                 :
Id                                        : /subscriptions/326100e2-f69d-4268-8503-075374f62b6e/resourceGroups/damorg/providers/Microsoft.ServiceBus/namespaces/testlatestS
                                            BMSI/topics/myTopic/subscriptions/sub$$D
IsClientAffine                            : True
IsDurable                                 : True
IsShared                                  : True
Location                                  : westus
LockDuration                              : 00:00:30
MaxDeliveryCount                          : 10
MessageCount                              : 0
Name                                      : sub$$D
RequiresSession                           : False
ResourceGroupName                         : damorg
Status                                    : Active

Get details of subcription sub$$D from ServiceBus topic myTopic.

Example 2: List all subscriptions in a topic

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

List all subscriptions in ServiceBus topic myTopic.

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 subscription name.

Type:String
Aliases:SubscriptionName
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

-TopicInputObject

Identity Parameter

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

-TopicName

The topic name.

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

Inputs

IServiceBusIdentity

Outputs

ISbSubscription