New-AzureRmServiceBusSubscription

Creates a subscription to the specified Service Bus topic.

Syntax

New-AzureRmServiceBusSubscription
   [-ResourceGroupName] <String>
   [-Namespace] <String>
   [-Topic] <String>
   [-Name] <String>
   [-AutoDeleteOnIdle <String>]
   [-DefaultMessageTimeToLive <String>]
   [-DeadLetteringOnMessageExpiration <Boolean>]
   [-EnableBatchedOperations <Boolean>]
   [-LockDuration <String>]
   [-MaxDeliveryCount <Int32>]
   [-RequiresSession <Boolean>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The New-AzureRmServiceBusSubscription cmdlet creates a new subscription to the specified Service Bus topic.

Examples

Example 1

PS C:\> New-AzureRmServiceBusSubscription -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -TopicName SB-Topic_exampl1 -SubscriptionName SB-TopicSubscription-Example1

Creates the subscription SB-TopicSubscription-Example1 for the specified Service Bus topic SB-Topic_exampl1.

Required Parameters

-Name

Subscription Name

Type:String
Aliases:SubscriptionName
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Namespace

Namespace Name.

Type:String
Aliases:NamespaceName
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ResourceGroupName

The name of the resource grou.

Type:String
Aliases:ResourceGroup
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Topic

Topic Name.

Type:String
Aliases:TopicName
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-AutoDeleteOnIdle

Specifies the TimeSpan idle interval, after which the subscription is automatically deleted. The minimum duration is 5 minutes.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:System.Management.Automation.SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-DeadLetteringOnMessageExpiration

Indicates if a subscription has deadletter support when a message expires.

Type:System.Nullable`1[System.Boolean]
Parameter Sets:TRUE, FALSE
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-DefaultMessageTimeToLive

Timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself. For Standard = Timespan.Max and Basic = 14 dyas

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

Type:Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-EnableBatchedOperations

Indicates whether server-side batched operations are enabled.

Type:System.Nullable`1[System.Boolean]
Parameter Sets:TRUE, FALSE
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-LockDuration

Specifies the lock duration time span for the subscription.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-MaxDeliveryCount

Specifies the number of maximum deliveries. A message is automatically deadlettered after this number of deliveries.

Type:System.Nullable`1[System.Int32]
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-RequiresSession

Specifies whether a subscription supports the concept of sessions.

Type:System.Nullable`1[System.Boolean]
Parameter Sets:TRUE, FALSE
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:System.Management.Automation.SwitchParameter
Aliases:wi
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

-ResourceGroup

System.String

Inputs

-NamespaceName

System.String

Inputs

-TopicName

System.String

Inputs

-SubscriptionName

System.String

Outputs

Microsoft.Azure.Commands.ServiceBus.Models.SubscriptionAttributes

Name : SB-TopicSubscription-Example1 AccessedAt : 1/20/2017 3:18:54 AM AutoDeleteOnIdle : 10675199.02:48:05.4775807 CountDetails : Microsoft.Azure.Management.ServiceBus.Models.MessageCountDetails CreatedAt : 1/20/2017 3:18:52 AM DefaultMessageTimeToLive : 10675199.02:48:05.4775807 DeadLetteringOnMessageExpiration : False EnableBatchedOperations : True LockDuration : 00:01:00 MaxDeliveryCount : 10 MessageCount : 0 RequiresSession : False Status : Active UpdatedAt : 1/20/2017 3:18:54 AM