< Back
Set-AzureRmServiceBusTopic
Post
NAME Set-AzureRmServiceBusTopic
SYNOPSIS
Updates the description of a Service Bus topic in the specified Service Bus namespace.
SYNTAX
Set-AzureRmServiceBusTopic [-ResourceGroupName] <String> [-Name] <String> [-Namespace] <String> [-InputObject] <PSTopicAttributes>
[-DefaultProfile <IAzureContextContainer>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmServiceBusTopic cmdlet updates a description object for a 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 <PSTopicAttributes>
ServiceBus Topic definition.
Required? true
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
Topic Name.
Required? true
Position? 1
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
-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
-TopicObj
Microsoft.Azure.Commands.ServiceBus.Models.PSTopicAttributes
OUTPUTS
Microsoft.Azure.Commands.ServiceBus.Models.PSTopicAttributes
NOTES
Example 1
PS C:\\> $topicObj = Get-AzureRmServiceBusTopic -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -TopicName SB-Topic_exampl1
PS C:\\> $topicObj.EnableExpress = $True
PS C:\\> Set-AzureRmServiceBusTopic -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -TopicName SB-Topic_exampl1 -TopicObj
$topicObj
Name : SB-Topic_exampl1
Id : /subscriptions/{subscription
id}d/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.ServiceBus/namespaces/SB-Example1/topics/SB-
Topic_exampl1
Type : Microsoft.ServiceBus/Topic
AccessedAt : 1/20/2017 3:18:54 AM
AutoDeleteOnIdle : 10675199.02:48:05.4775807
CreatedAt : 1/20/2017 3:16:41 AM
CountDetails : Microsoft.Azure.Management.ServiceBus.Models.MessageCountDetails
DefaultMessageTimeToLive : 10675199.02:48:05.4775807
DuplicateDetectionHistoryTimeWindow :
EnableBatchedOperations : True
EnableExpress : True
EnablePartitioning : True
MaxSizeInMegabytes : 16384
RequiresDuplicateDetection : False
SizeInBytes : 0
Status : Active
SubscriptionCount : 1
SupportOrdering : False
UpdatedAt : 1/20/2017 7:12:16 PM
Updates the specified topic with a new description in the specified namespace. This example updates the EnableExpress property to true .
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... cebustopic
SYNOPSIS
Updates the description of a Service Bus topic in the specified Service Bus namespace.
SYNTAX
Set-AzureRmServiceBusTopic [-ResourceGroupName] <String> [-Name] <String> [-Namespace] <String> [-InputObject] <PSTopicAttributes>
[-DefaultProfile <IAzureContextContainer>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmServiceBusTopic cmdlet updates a description object for a 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 <PSTopicAttributes>
ServiceBus Topic definition.
Required? true
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
Topic Name.
Required? true
Position? 1
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
-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
-TopicObj
Microsoft.Azure.Commands.ServiceBus.Models.PSTopicAttributes
OUTPUTS
Microsoft.Azure.Commands.ServiceBus.Models.PSTopicAttributes
NOTES
Example 1
PS C:\\> $topicObj = Get-AzureRmServiceBusTopic -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -TopicName SB-Topic_exampl1
PS C:\\> $topicObj.EnableExpress = $True
PS C:\\> Set-AzureRmServiceBusTopic -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -TopicName SB-Topic_exampl1 -TopicObj
$topicObj
Name : SB-Topic_exampl1
Id : /subscriptions/{subscription
id}d/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.ServiceBus/namespaces/SB-Example1/topics/SB-
Topic_exampl1
Type : Microsoft.ServiceBus/Topic
AccessedAt : 1/20/2017 3:18:54 AM
AutoDeleteOnIdle : 10675199.02:48:05.4775807
CreatedAt : 1/20/2017 3:16:41 AM
CountDetails : Microsoft.Azure.Management.ServiceBus.Models.MessageCountDetails
DefaultMessageTimeToLive : 10675199.02:48:05.4775807
DuplicateDetectionHistoryTimeWindow :
EnableBatchedOperations : True
EnableExpress : True
EnablePartitioning : True
MaxSizeInMegabytes : 16384
RequiresDuplicateDetection : False
SizeInBytes : 0
Status : Active
SubscriptionCount : 1
SupportOrdering : False
UpdatedAt : 1/20/2017 7:12:16 PM
Updates the specified topic with a new description in the specified namespace. This example updates the EnableExpress property to true .
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... cebustopic