New-AzServiceBusTopic
Creates a topic in the specified namespace.
Syntax
New-AzServiceBusTopic
-Name <String>
-NamespaceName <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-AutoDeleteOnIdle <TimeSpan>]
[-DefaultMessageTimeToLive <TimeSpan>]
[-DuplicateDetectionHistoryTimeWindow <TimeSpan>]
[-EnableBatchedOperations]
[-EnableExpress]
[-EnablePartitioning]
[-MaxMessageSizeInKilobytes <Int64>]
[-MaxSizeInMegabytes <Int32>]
[-RequiresDuplicateDetection]
[-Status <EntityStatus>]
[-SupportOrdering]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
Creates a topic in the specified namespace.
Examples
Example 1: Creates a new ServiceBus topic
New-AzServiceBusTopic -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name myTopic -DefaultMessageTimeToLive (New-TimeSpan -Days 18) -EnableBatchedOperations
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 : 18.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 : 1024
MaxSizeInMegabytes : 1024
Name : myTopic
RequiresDuplicateDetection : False
ResourceGroupName : myResourceGroup
SizeInByte : 0
Status : Active
SubscriptionCount : 0
SupportOrdering : TrueCreates a new ServiceBus topic myTopic within namespace myNamespace.
Parameters
-AutoDeleteOnIdle
Idle interval after which the queue 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
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 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 |
-DuplicateDetectionHistoryTimeWindow
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
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 |
-EnablePartitioning
Value that indicates whether the topic to be partitioned across multiple message brokers is enabled.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| 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
Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
The topic name.
| Type: | String |
| Aliases: | TopicName |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| 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 |
-RequiresDuplicateDetection
Value indicating if this topic requires duplicate detection.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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 |
-Status
Enumerates the possible values for the status of a messaging entity.
| Type: | EntityStatus |
| 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 |
-SupportOrdering
Value that indicates whether the topic supports ordering.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Outputs
Azure PowerShell
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for