Get-AzServiceBusRule

  • Reference
Module:
Az.ServiceBus

Retrieves the description for the specified rule.

Syntax

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

Description

Retrieves the description for the specified rule.

Examples

Example 1: Get details of a ServiceBus Rule

Get-AzServiceBusRule -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name '$Default' -TopicName myTopic -SubscriptionName mySubscription

ActionCompatibilityLevel               :
ActionRequiresPreprocessing            :
ActionSqlExpression                    :
ContentType                            :
CorrelationFilterProperty              : {
                                         }
CorrelationFilterRequiresPreprocessing :
CorrelationId                          :
FilterType                             : SqlFilter
Id                                     : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace/topics/myTopic/subscriptions/mySubscription/rules/$Default
Label                                  :
Location                               : westus
MessageId                              :
Name                                   : $Default
ReplyTo                                :
ReplyToSessionId                       :
ResourceGroupName                      : myResourceGroup
SessionId                              :
SqlExpression                          : 1=1
SqlFilterCompatibilityLevel            : 20

Gets the details of $Default rule from subscription mySubscription of topic myTopic.

Example 2: List all rules in a ServiceBus subscription

Get-AzServiceBusRule -ResourceGroupName myResourceGroup -NamespaceName myNamespace -TopicName myTopic -SubscriptionName mySubscription

Lists all rules in ServiceBus subscription mySubscription.

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

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

-SubscriptionInputObject

Identity Parameter

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

-SubscriptionName

The subscription name.

Type:String
Position:Named
Default value:None
Required:True
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

IRule