< Back
Set-AzureRmServiceBusSubscription
Post
NAME Set-AzureRmServiceBusSubscription
SYNOPSIS
Updates a subscription description for a Service Bus topic in the specified Service Bus namespace.
SYNTAX
Set-AzureRmServiceBusSubscription [-ResourceGroupName] <String> [-Namespace] <String> [-Topic] <String> [-InputObject] <PSSubscriptionAttributes>
[-DefaultProfile <IAzureContextContainer>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmServiceBusSubscription cmdlet updates the description of the subscription for the Service Bus topic in the specified Service Bus
namespace.
PARAMETERS
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-InputObject <PSSubscriptionAttributes>
ServiceBus Subscription definition.
Required? true
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Namespace <String>
Namespace Name.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
The name of the resource group
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Topic <String>
Topic Name.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
-ResourceGroup
System.String
-NamespaceName
System.String
-TopicName
System.String
-SubscriptionObj
Microsoft.Azure.Commands.ServiceBus.Models.PSSubscriptionAttributes
OUTPUTS
Microsoft.Azure.Commands.ServiceBus.Models.PSSubscriptionAttributes
NOTES
Example 1
PS C:\\> $subscriptionObj = Get-AzureRmServiceBusSubscription -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -TopicName
SB-Topic_exampl1 -SubscriptionName SB-TopicSubscription-Example1
PS C:\\> $subscriptionObj.DeadLetteringOnMessageExpiration = $True
PS C:\\> $subscriptionObj.MaxDeliveryCount = 9
Name : SB-TopicSubscription-Example1
AccessedAt : 1/1/0001 12:00:00 AM
AutoDeleteOnIdle : 10675199.02:48:05.4775807
CountDetails :
CreatedAt : 1/20/2017 9:59:15 PM
DefaultMessageTimeToLive : 10675199.02:48:05.4775807
DeadLetteringOnMessageExpiration : True
EnableBatchedOperations : True
LockDuration : 00:01:00
MaxDeliveryCount : 9
MessageCount : 0
RequiresSession : False
Status : Active
UpdatedAt : 1/20/2017 9:59:15 PM
PS C:\\> Set-AzureRmServiceBusSubscription -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -TopicName SB-Topic_exampl1
-SubscriptionObj $subscriptionObj
Updates the description for the specified subscription to the given topic. This example updates the DeadLetteringOnMessageExpiration property to
true and MaxDeliveryCount to 9.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... bscription
SYNOPSIS
Updates a subscription description for a Service Bus topic in the specified Service Bus namespace.
SYNTAX
Set-AzureRmServiceBusSubscription [-ResourceGroupName] <String> [-Namespace] <String> [-Topic] <String> [-InputObject] <PSSubscriptionAttributes>
[-DefaultProfile <IAzureContextContainer>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmServiceBusSubscription cmdlet updates the description of the subscription for the Service Bus topic in the specified Service Bus
namespace.
PARAMETERS
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-InputObject <PSSubscriptionAttributes>
ServiceBus Subscription definition.
Required? true
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Namespace <String>
Namespace Name.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
The name of the resource group
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Topic <String>
Topic Name.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
-ResourceGroup
System.String
-NamespaceName
System.String
-TopicName
System.String
-SubscriptionObj
Microsoft.Azure.Commands.ServiceBus.Models.PSSubscriptionAttributes
OUTPUTS
Microsoft.Azure.Commands.ServiceBus.Models.PSSubscriptionAttributes
NOTES
Example 1
PS C:\\> $subscriptionObj = Get-AzureRmServiceBusSubscription -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -TopicName
SB-Topic_exampl1 -SubscriptionName SB-TopicSubscription-Example1
PS C:\\> $subscriptionObj.DeadLetteringOnMessageExpiration = $True
PS C:\\> $subscriptionObj.MaxDeliveryCount = 9
Name : SB-TopicSubscription-Example1
AccessedAt : 1/1/0001 12:00:00 AM
AutoDeleteOnIdle : 10675199.02:48:05.4775807
CountDetails :
CreatedAt : 1/20/2017 9:59:15 PM
DefaultMessageTimeToLive : 10675199.02:48:05.4775807
DeadLetteringOnMessageExpiration : True
EnableBatchedOperations : True
LockDuration : 00:01:00
MaxDeliveryCount : 9
MessageCount : 0
RequiresSession : False
Status : Active
UpdatedAt : 1/20/2017 9:59:15 PM
PS C:\\> Set-AzureRmServiceBusSubscription -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -TopicName SB-Topic_exampl1
-SubscriptionObj $subscriptionObj
Updates the description for the specified subscription to the given topic. This example updates the DeadLetteringOnMessageExpiration property to
true and MaxDeliveryCount to 9.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... bscription