< Back

New-AzureRmServiceBusQueue

Tue Jan 29, 2019 10:07 pm

NAME New-AzureRmServiceBusQueue



SYNOPSIS

Creates a Service Bus queue in the specified Service Bus namespace.





SYNTAX

New-AzureRmServiceBusQueue [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> [-AutoDeleteOnIdle <String>] [-Confirm]

[-DeadLetteringOnMessageExpiration {TRUE | FALSE}] [-DefaultMessageTimeToLive <String>] [-DefaultProfile <IAzureContextContainer>]

[-DuplicateDetectionHistoryTimeWindow <String>] [-EnableBatchedOperations] [-EnableExpress {TRUE | FALSE}] [-EnablePartitioning {TRUE | FALSE}]

[-ForwardDeadLetteredMessagesTo <String>] [-ForwardTo <String>] [-LockDuration <String>] [-MaxDeliveryCount <Int32>] [-MaxSizeInMegabytes <Int64>]

[-MessageCount <Int64>] [-RequiresDuplicateDetection {TRUE | FALSE}] [-RequiresSession {TRUE | FALSE}] [-SizeInBytes <Int64>] [-WhatIf]

[<CommonParameters>]





DESCRIPTION

The New-AzureRmServiceBusQueue cmdlet creates a Service Bus queue 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 queue 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



-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



-DeadLetteringOnMessageExpiration <Boolean>

Dead Lettering On Message Expiration



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-DefaultMessageTimeToLive <String>

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. For Standard = Timespan.Max and Basic = 14 dyas



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 duplicate detection history time window, a TimeSpan (https://msdn.microsoft.com/library/system.timespan.aspx)valuethat 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 [<SwitchParameter>]

Enable Batched Operations - value that indicates whether server-side batched operations are enabled



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-EnableExpress <Boolean>

EnableExpress - a value that 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>

EnablePartitioning



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ForwardDeadLetteredMessagesTo <String>

Queue/Topic name to forward the Dead Letter message



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ForwardTo <String>

Queue/Topic name to forward the messages



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-LockDuration <String>

Lock Duration



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-MaxDeliveryCount <Int32>

MaxDeliveryCount - the maximum delivery count. A message is automatically deadlettered after this number of deliveries.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-MaxSizeInMegabytes <Int64>

MaxSizeInMegabytes - the maximum size of the queue in megabytes, which is the size of memory allocated for the queue.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-MessageCount <Int64>

MessageCount - the number of messages in the queue



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Name <String>

Queue Name



Required? true

Position? 2

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>

RequiresDuplicateDetection - a value that indicates whether the queue supports the concept of session



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-RequiresSession <Boolean>

RequiresSession - the value indicating if this queue requires duplicate 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>

SizeInBytes - the size of the queue in bytes



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

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



-QueueName

System.String



-EnablePartitioning

System.Boolean?





OUTPUTS

Microsoft.Azure.Commands.ServiceBus.Models.PSQueueAttributes







NOTES









Example 1



PS C:\\> New-AzureRmServiceBusQueue -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -QueueName SB-Queue_exampl1

-EnablePartitioning $True



Name : SB-Queue_exampl1

LockDuration :

AccessedAt :

AutoDeleteOnIdle : 10675199.02:48:05.4775807

CreatedAt : 1/20/2017 2:51:36 AM

DefaultMessageTimeToLive : 10675199.02:48:05.4775807

DuplicateDetectionHistoryTimeWindow :

DeadLetteringOnMessageExpiration : False

EnableExpress : False

EnablePartitioning : True

MaxDeliveryCount :

MaxSizeInMegabytes : 16384

MessageCount :

CountDetails :

RequiresDuplicateDetection : False

RequiresSession : False

SizeInBytes :

Status : Active

UpdatedAt : 1/20/2017 2:51:37 AM



Creates a new Service Bus queue `SB-Queue_exampl1` in the specified Service Bus namespace `SB-Example1`.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... cebusqueue