Edit

Share via

Set-MsmqQueue

Module:
MSMQ Module

Sets properties of queues.

Syntax

Default (Default) 

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: Modify properties of queues

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

This command gets private queues that have names that start with Order by using the Get-MsmqQueue cmdlet. The command passes the results to the current cmdlet by using the pipeline operator. The current cmdlet modifies journaling and the size of the queue quota.

Parameters

-Authenticate

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

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

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

Parameter properties

Type:

MessageQueue[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Journaling

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

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-JournalQuota

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

Parameter properties

Type:Int64
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Label

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MulticastAddress

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PrivacyLevel

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

Parameter properties

Type:EncryptionRequired
Default value:None
Accepted values:None, Optional, Body
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-QueueQuota

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

Parameter properties

Type:Int64
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.Msmq.PowerShell.Commands.MessageQueue

Outputs

Object