Set-AzServiceBusTopic

Reference

Module:: Az.ServiceBus

Updates a ServiceBus Topic

Syntax

Set-AzServiceBusTopic
   -Name <String>
   -NamespaceName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   [-AutoDeleteOnIdle <TimeSpan>]
   [-DefaultMessageTimeToLive <TimeSpan>]
   [-DuplicateDetectionHistoryTimeWindow <TimeSpan>]
   [-EnableBatchedOperations]
   [-EnableExpress]
   [-SupportOrdering]
   [-MaxSizeInMegabytes <Int32>]
   [-MaxMessageSizeInKilobytes <Int64>]
   [-Status <EntityStatus>]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzServiceBusTopic
   -InputObject <IServiceBusIdentity>
   [-AutoDeleteOnIdle <TimeSpan>]
   [-DefaultMessageTimeToLive <TimeSpan>]
   [-DuplicateDetectionHistoryTimeWindow <TimeSpan>]
   [-EnableBatchedOperations]
   [-EnableExpress]
   [-SupportOrdering]
   [-MaxSizeInMegabytes <Int32>]
   [-MaxMessageSizeInKilobytes <Int64>]
   [-Status <EntityStatus>]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Updates a ServiceBus Topic

Examples

Example 1: Updates a ServiceBus topic

Set-AzServiceBusTopic -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name myTopic -DefaultMessageTimeToLive (New-TimeSpan -Days 20) -MaxMessageSizeInKilobytes 102400

AccessedAt                                : 1/1/0001 12:00:00 AM
AutoDeleteOnIdle                          : 10675199.02:48:05.4775807
CountDetailActiveMessageCount             : 0
CountDetailDeadLetterMessageCount         : 0
CountDetailScheduledMessageCount          : 0
CountDetailTransferDeadLetterMessageCount : 0
CountDetailTransferMessageCount           : 0
CreatedAt                                 : 1/1/0001 12:00:00 AM
DefaultMessageTimeToLive                  : 20.00:00:00
DuplicateDetectionHistoryTimeWindow       : 00:10:00
EnableBatchedOperations                   : True
EnableExpress                             : False
EnablePartitioning                        : False
Id                                        : /subscriptions/000000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace/topics/myTopic
Location                                  : westus
MaxMessageSizeInKilobytes                 : 102400
MaxSizeInMegabytes                        : 1024
Name                                      : myTopic
RequiresDuplicateDetection                : False
ResourceGroupName                         : myResourceGroup
SizeInByte                                : 0
Status                                    : Active
SubscriptionCount                         : 0
SupportOrdering                           : True

Updates a ServiceBus topic myTopic within namespace myNamespace.

Example 2: Updates a ServiceBus topic using InputObject parameter set

$topic = Get-AzServiceBusTopic -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name myTopic
Set-AzServiceBusTopic -InputObject $topic -DefaultMessageTimeToLive (New-TimeSpan -Days 20) -MaxMessageSizeInKilobytes 102400

AccessedAt                                : 1/1/0001 12:00:00 AM
AutoDeleteOnIdle                          : 10675199.02:48:05.4775807
CountDetailActiveMessageCount             : 0
CountDetailDeadLetterMessageCount         : 0
CountDetailScheduledMessageCount          : 0
CountDetailTransferDeadLetterMessageCount : 0
CountDetailTransferMessageCount           : 0
CreatedAt                                 : 1/1/0001 12:00:00 AM
DefaultMessageTimeToLive                  : 20.00:00:00
DuplicateDetectionHistoryTimeWindow       : 00:10:00
EnableBatchedOperations                   : True
EnableExpress                             : False
EnablePartitioning                        : False
Id                                        : /subscriptions/000000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace/topics/myTopic
Location                                  : westus
MaxMessageSizeInKilobytes                 : 102400
MaxSizeInMegabytes                        : 1024
Name                                      : myTopic
RequiresDuplicateDetection                : False
ResourceGroupName                         : myResourceGroup
SizeInByte                                : 0
Status                                    : Active
SubscriptionCount                         : 0
SupportOrdering                           : True

Updates a ServiceBus topic myTopic within namespace myNamespace using InputObject parameter set.

Parameters

-AsJob

Run the command as a job

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

-AutoDeleteOnIdle

ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultMessageTimeToLive

ISO 8601 default message 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.

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

-DefaultProfile

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

Type:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DuplicateDetectionHistoryTimeWindow

ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.

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

-EnableBatchedOperations

Value that indicates whether server-side batched operations are enabled.

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

-EnableExpress

A value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage.

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

-InputObject

Identity parameter. To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

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

-MaxMessageSizeInKilobytes

Maximum size (in KB) of the message payload that can be accepted by the topic. This property is only used in Premium today and default is 1024.

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

-MaxSizeInMegabytes

The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10.

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

-Name

The name of the Topic.

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

-NamespaceName

The name of ServiceBus namespace

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

-NoWait

Run the command asynchronously

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

-ResourceGroupName

The name of the resource group. The name is case insensitive.

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

-Status