Set-MsmqQueue
Set-MsmqQueue
Sets queue properties.
Syntax
Parameter Set: Default
Set-MsmqQueue -InputObject <MessageQueue[]> [-Authenticate <Boolean> ] [-Journaling <Boolean> ] [-JournalQuota <Int64> ] [-Label <String> ] [-MulticastAddress <String> ] [-PrivacyLevel <EncryptionRequired> ] [-QueueQuota <Int64> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
This cmdlet sets the properties of the private and public queues that are represented by the supplied MsmqQueue objects. The cmdlet will return an error when supplied with a journal queue, system journal queue, system dead-letter queue, or system transactional dead-letter queue. It returns an MsmqQueue object that represents the modified queue.
Parameters
-Authenticate<Boolean>
If specified, sets a value that indicates whether the queue accepts only authenticated messages. No default.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-InputObject<MessageQueue[]>
An MsmqQueue object that represents a queue on which the properties are to be set. Accepts pipelined input.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true(ByValue) |
Accept Wildcard Characters? |
false |
-Journaling<Boolean>
If specified, sets a value that indicates whether received messages are copied to the journal queue. No default.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-JournalQuota<Int64>
If specified, sets the maximum size of the journal queue in KB. No default.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Label<String>
If specified, sets the queue description. No default.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-MulticastAddress<String>
If specified, sets the multicast address associated with the queue. No default.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-PrivacyLevel<EncryptionRequired>
If specified, sets the privacy level associated with the queue. No default.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-QueueQuota<Int64>
If specified, sets the maximum size of the queue in KB. No default.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
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.
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, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Usage Example
PS C:\> Get-MsmqQueue –Name order* –QueueType Private | Set-MsmqQueue –QueueQuota 500000 –Journaling