Edit

Set-MsmqQueue

  • Reference
Module:
MSMQ

Sets properties of queues.

Syntax

Set-MsmqQueue
   -InputObject <MessageQueue[]>
   [-Label <String>]
   [-Authenticate <Boolean>]
   [-Journaling <Boolean>]
   [-QueueQuota <Int64>]
   [-JournalQuota <Int64>]
   [-PrivacyLevel <EncryptionRequired>]
   [-MulticastAddress <String>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-MsmqQueue cmdlet sets properties of queues. This cmdlet returns an MsmqQueue object that represents the modified queue. Specify private or public queues to modify. If you specify a journal queue, system journal queue, system dead-letter queue, or system transactional dead-letter queue, the cmdlet returns an error.

Examples

Example 1

PS C:\>Get-MsmqQueue -Name "order*" -QueueType Private | Set-MsmqQueue -Journaling -QueueQuota 500000

Parameters

-Authenticate

Indicates whether the queue accepts only authenticated messages. There is no default value.

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Specifies an array of MsmqQueue objects. This cmdlet modifies properties of the queues that this parameter specifies. This parameter accepts pipeline input.

Type:MessageQueue[]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Journaling

Indicates whether to copy received messages to the journal queue. There is no default value.

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-JournalQuota

Specifies the maximum size of the journal queue. Specify a value in kilobytes. There is no default value.

Type:Int64
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Label

Specifies a label. The label that this parameter specifies describes the queue. There is no default value.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-MulticastAddress

Specifies the multicast address associated with the queue. There is no default value.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PrivacyLevel

Specifies the privacy level associated with the queue. There is no default value.

Type:EncryptionRequired
Accepted values:None, Optional, Body
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-QueueQuota

Specifies the maximum size, in kilobytes, of the queue. There is no default value.

Type:Int64
Position:Named
Default value:None
Required: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
Required:False
Accept pipeline input:False
Accept wildcard characters:False