Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Set-MsmqQueue

Last Updated: 3/8/2017

SYNOPSIS

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

PS C:\> Get-MsmqQueue -Name "Order*" -QueueType Private | Set-MsmqQueue -Journaling -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.

Type: Boolean
Parameter Sets: (All)
Aliases: 

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: 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[]
Parameter Sets: (All)
Aliases: 

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
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
Parameter Sets: (All)
Aliases: 

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

-Journaling

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

Type: Boolean
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
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
Parameter Sets: (All)
Aliases: 

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

-MulticastAddress

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

Type: String
Parameter Sets: (All)
Aliases: 

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

-PrivacyLevel

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

Type: EncryptionRequired
Parameter Sets: (All)
Aliases: 
Accepted values: None, Optional, Body

Required: False
Position: Named
Default value: None
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
Parameter Sets: (All)
Aliases: 

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

-WhatIf

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

CommonParameters

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

INPUTS

OUTPUTS

NOTES

Clear-MsmqQueue

Get-MsmqQueue

New-MsmqQueue

Receive-MsmqQueue

Remove-MsmqQueue

Send-MsmqQueue

© 2017 Microsoft