Set-​Azure​Rm​Service​Bus​Queue

Updates the description of a Service Bus queue in the specified Service Bus namespace.

Syntax

Set-AzureRmServiceBusQueue
   [-ResourceGroup] <String>
   [-NamespaceName] <String>
   [-QueueName] <String>
   [-QueueObj] <QueueAttributes>
   [-Confirm]
   [-WhatIf]
   [<CommonParameters>]

Description

The Set-AzureRmServiceBusQueue cmdlet updates the description for the Service Bus queue in the specified Service Bus namespace.

Examples

Example 1

PS C:\> $QueueObj = Get-AzureRmServiceBusQueue -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -QueueName SB-Queue_exampl1

PS C:\> $QueueObj.DeadLetteringOnMessageExpiration = $True
PS C:\> $QueueObj.SupportOrdering = $True

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

Updates the specified queue with a new description in the specified namespace. This example updates the DeadLetteringOnMessageExpiration property to true and SupportOrdering to true.

Required Parameters

-NamespaceName

The Service Bus namespace name.

Type:String
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-QueueName

The Service Bus queue name.

Type:String
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-QueueObj

The Service Bus queue definition.

Type:QueueAttributes
Position:3
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ResourceGroup

The name of the resource group.

Type:String
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value: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:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

-ResourceGroup

System.String

Inputs

-NamespaceName

System.String

Inputs

-QueueName

System.String

Inputs

-QueueObj

Microsoft.Azure.Commands.ServiceBus.Models.QueueAttributes

Outputs

Microsoft.Azure.Commands.ServiceBus.Models.QueueAttributes

Name : SB-Queue_exampl1 Location : West US LockDuration : AccessedAt : 1/1/0001 12:00:00 AM AutoDeleteOnIdle : 10675199.02:48:05.4775807 EntityAvailabilityStatus : CreatedAt : 1/20/2017 2:51:34 AM DefaultMessageTimeToLive : 10675199.02:48:05.4775807 DuplicateDetectionHistoryTimeWindow : EnableBatchedOperations : True DeadLetteringOnMessageExpiration : False EnableExpress : False EnablePartitioning : True IsAnonymousAccessible : False MaxDeliveryCount : MaxSizeInMegabytes : 16384 MessageCount : CountDetails : Microsoft.Azure.Management.ServiceBus.Models.MessageCountDetails RequiresDuplicateDetection : False RequiresSession : False SizeInBytes : Status : Active SupportOrdering : False UpdatedAt : 1/20/2017 6:16:18 PM