< Back
New-AzureRmServiceBusTopic
Post
NAME New-AzureRmServiceBusTopic
SYNOPSIS
Creates a new Service Bus topic in the specified Service Bus namespace.
SYNTAX
New-AzureRmServiceBusTopic [-ResourceGroupName] <String> [-Name] <String> [-Namespace] <String> [-AutoDeleteOnIdle <String>]
[-DefaultMessageTimeToLive <String>] [-DefaultProfile <IAzureContextContainer>] [-DuplicateDetectionHistoryTimeWindow <String>]
[-EnableBatchedOperations {TRUE | FALSE}] [-EnableExpress {TRUE | FALSE}] -EnablePartitioning {TRUE | FALSE} [-MaxSizeInMegabytes <Int64>]
[-RequiresDuplicateDetection {TRUE | FALSE}] [-SizeInBytes <Int64>] [-SupportOrdering {TRUE | FALSE}] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The New-AzureRmServiceBusTopic cmdlet creates a new Service Bus topic in the specified Service Bus namespace.
PARAMETERS
-AutoDeleteOnIdle <String>
Specifies the TimeSpan (https://msdn.microsoft.com/library/system.timespan.aspx)idle interval after which the topic is automatically deleted.
The minimum duration is 5 minutes.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultMessageTimeToLive <String>
Specifies the duration after which the message expires, starting from when the message is sent to Service Bus.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-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
-DuplicateDetectionHistoryTimeWindow <String>
Specifies the TimeSpan (https://msdn.microsoft.com/library/system.timespan.aspx)structure that defines the duration of the duplicate detection
history. The default value is 10 minutes.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-EnableBatchedOperations <Boolean>
Indicates whether server-side batched operations are enabled.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-EnableExpress <Boolean>
Indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-EnablePartitioning <Boolean>
Specifies whether to enable the topic to be partitioned across multiple message brokers.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-MaxSizeInMegabytes <Int64>
The maximum size of the topic in megabytes, which is the size of memory allocated for the topic.
Required? false
Position? named
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
-RequiresDuplicateDetection <Boolean>
Indicates whether the topic requires duplication detection.
Required? false
Position? named
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
-SizeInBytes <Int64>
Specifies the size of the topic in bytes.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SupportOrdering <Boolean>
Indicates whether the topic supports ordering.
Required? false
Position? named
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
System.String
System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
System.Nullable`1[[System.Int64, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
-ResourceGroup
System.String
-NamespaceName
System.String
-TopicName
System.String
-EnablePartitioning
System.Boolean?
OUTPUTS
Microsoft.Azure.Commands.ServiceBus.Models.PSTopicAttributes
NOTES
Example 1
PS C:\\> New-AzureRmServiceBusTopic -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -TopicName SB-Topic_exampl1
-EnablePartitioning $True
Name : SB-Topic_exampl1
Id : /subscriptions/{subscription
id}/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.ServiceBus/namespaces/SB-Example1/topics/S
B-Topic_exampl1
Type : Microsoft.ServiceBus/Topic
AccessedAt :
AutoDeleteOnIdle : 10675199.02:48:05.4775807
CreatedAt : 1/20/2017 3:16:42 AM
CountDetails :
DefaultMessageTimeToLive : 10675199.02:48:05.4775807
DuplicateDetectionHistoryTimeWindow :
EnableBatchedOperations : True
EnableExpress : False
EnablePartitioning : True
MaxSizeInMegabytes : 16384
RequiresDuplicateDetection : False
SizeInBytes : 0
Status : Active
SubscriptionCount :
SupportOrdering : False
UpdatedAt : 1/20/2017 3:16:43 AM
Creates a new Service Bus topic `SB-Topic_exampl1` in the specified Service Bus namespace `SB-Example1`.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... cebustopic
SYNOPSIS
Creates a new Service Bus topic in the specified Service Bus namespace.
SYNTAX
New-AzureRmServiceBusTopic [-ResourceGroupName] <String> [-Name] <String> [-Namespace] <String> [-AutoDeleteOnIdle <String>]
[-DefaultMessageTimeToLive <String>] [-DefaultProfile <IAzureContextContainer>] [-DuplicateDetectionHistoryTimeWindow <String>]
[-EnableBatchedOperations {TRUE | FALSE}] [-EnableExpress {TRUE | FALSE}] -EnablePartitioning {TRUE | FALSE} [-MaxSizeInMegabytes <Int64>]
[-RequiresDuplicateDetection {TRUE | FALSE}] [-SizeInBytes <Int64>] [-SupportOrdering {TRUE | FALSE}] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The New-AzureRmServiceBusTopic cmdlet creates a new Service Bus topic in the specified Service Bus namespace.
PARAMETERS
-AutoDeleteOnIdle <String>
Specifies the TimeSpan (https://msdn.microsoft.com/library/system.timespan.aspx)idle interval after which the topic is automatically deleted.
The minimum duration is 5 minutes.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultMessageTimeToLive <String>
Specifies the duration after which the message expires, starting from when the message is sent to Service Bus.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-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
-DuplicateDetectionHistoryTimeWindow <String>
Specifies the TimeSpan (https://msdn.microsoft.com/library/system.timespan.aspx)structure that defines the duration of the duplicate detection
history. The default value is 10 minutes.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-EnableBatchedOperations <Boolean>
Indicates whether server-side batched operations are enabled.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-EnableExpress <Boolean>
Indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-EnablePartitioning <Boolean>
Specifies whether to enable the topic to be partitioned across multiple message brokers.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-MaxSizeInMegabytes <Int64>
The maximum size of the topic in megabytes, which is the size of memory allocated for the topic.
Required? false
Position? named
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
-RequiresDuplicateDetection <Boolean>
Indicates whether the topic requires duplication detection.
Required? false
Position? named
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
-SizeInBytes <Int64>
Specifies the size of the topic in bytes.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SupportOrdering <Boolean>
Indicates whether the topic supports ordering.
Required? false
Position? named
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
System.String
System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
System.Nullable`1[[System.Int64, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
-ResourceGroup
System.String
-NamespaceName
System.String
-TopicName
System.String
-EnablePartitioning
System.Boolean?
OUTPUTS
Microsoft.Azure.Commands.ServiceBus.Models.PSTopicAttributes
NOTES
Example 1
PS C:\\> New-AzureRmServiceBusTopic -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -TopicName SB-Topic_exampl1
-EnablePartitioning $True
Name : SB-Topic_exampl1
Id : /subscriptions/{subscription
id}/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.ServiceBus/namespaces/SB-Example1/topics/S
B-Topic_exampl1
Type : Microsoft.ServiceBus/Topic
AccessedAt :
AutoDeleteOnIdle : 10675199.02:48:05.4775807
CreatedAt : 1/20/2017 3:16:42 AM
CountDetails :
DefaultMessageTimeToLive : 10675199.02:48:05.4775807
DuplicateDetectionHistoryTimeWindow :
EnableBatchedOperations : True
EnableExpress : False
EnablePartitioning : True
MaxSizeInMegabytes : 16384
RequiresDuplicateDetection : False
SizeInBytes : 0
Status : Active
SubscriptionCount :
SupportOrdering : False
UpdatedAt : 1/20/2017 3:16:43 AM
Creates a new Service Bus topic `SB-Topic_exampl1` in the specified Service Bus namespace `SB-Example1`.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... cebustopic