< Back
Set-AzureRmServiceBusQueue
Post
NAME Set-AzureRmServiceBusQueue
SYNOPSIS
Updates the description of a Service Bus queue in the specified Service Bus namespace.
SYNTAX
Set-AzureRmServiceBusQueue [-ResourceGroupName] <String> [-Name] <String> [-Namespace] <String> [-InputObject] <PSQueueAttributes>
[-DefaultProfile <IAzureContextContainer>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmServiceBusQueue cmdlet updates the description for the Service Bus queue in the specified Service Bus namespace.
PARAMETERS
-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
-InputObject <PSQueueAttributes>
ServiceBus definition.
Required? true
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
Queue 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
-ResourceGroupName <String>
The name of the resource group
Required? true
Position? 0
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
-ResourceGroup
System.String
-NamespaceName
System.String
-QueueName
System.String
-QueueObj
Microsoft.Azure.Commands.ServiceBus.Models.PSQueueAttributes
OUTPUTS
Microsoft.Azure.Commands.ServiceBus.Models.PSQueueAttributes
NOTES
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
Name : SB-Queue_exampl1
LockDuration :
AccessedAt : 1/1/0001 12:00:00 AM
AutoDeleteOnIdle : 10675199.02:48:05.4775807
CreatedAt : 1/20/2017 2:51:34 AM
DefaultMessageTimeToLive : 10675199.02:48:05.4775807
DuplicateDetectionHistoryTimeWindow :
DeadLetteringOnMessageExpiration : False
EnableExpress : False
EnablePartitioning : True
MaxDeliveryCount :
MaxSizeInMegabytes : 16384
MessageCount :
CountDetails : Microsoft.Azure.Management.ServiceBus.Models.MessageCountDetails
RequiresDuplicateDetection : False
RequiresSession : False
SizeInBytes :
Status : Active
UpdatedAt : 1/20/2017 6:16:18 PM
Updates the specified queue with a new description in the specified namespace. This example updates the DeadLetteringOnMessageExpiration property
to true and SupportOrdering to true .
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... cebusqueue
SYNOPSIS
Updates the description of a Service Bus queue in the specified Service Bus namespace.
SYNTAX
Set-AzureRmServiceBusQueue [-ResourceGroupName] <String> [-Name] <String> [-Namespace] <String> [-InputObject] <PSQueueAttributes>
[-DefaultProfile <IAzureContextContainer>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmServiceBusQueue cmdlet updates the description for the Service Bus queue in the specified Service Bus namespace.
PARAMETERS
-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
-InputObject <PSQueueAttributes>
ServiceBus definition.
Required? true
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
Queue 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
-ResourceGroupName <String>
The name of the resource group
Required? true
Position? 0
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
-ResourceGroup
System.String
-NamespaceName
System.String
-QueueName
System.String
-QueueObj
Microsoft.Azure.Commands.ServiceBus.Models.PSQueueAttributes
OUTPUTS
Microsoft.Azure.Commands.ServiceBus.Models.PSQueueAttributes
NOTES
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
Name : SB-Queue_exampl1
LockDuration :
AccessedAt : 1/1/0001 12:00:00 AM
AutoDeleteOnIdle : 10675199.02:48:05.4775807
CreatedAt : 1/20/2017 2:51:34 AM
DefaultMessageTimeToLive : 10675199.02:48:05.4775807
DuplicateDetectionHistoryTimeWindow :
DeadLetteringOnMessageExpiration : False
EnableExpress : False
EnablePartitioning : True
MaxDeliveryCount :
MaxSizeInMegabytes : 16384
MessageCount :
CountDetails : Microsoft.Azure.Management.ServiceBus.Models.MessageCountDetails
RequiresDuplicateDetection : False
RequiresSession : False
SizeInBytes :
Status : Active
UpdatedAt : 1/20/2017 6:16:18 PM
Updates the specified queue with a new description in the specified namespace. This example updates the DeadLetteringOnMessageExpiration property
to true and SupportOrdering to true .
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... cebusqueue