Applies to: Exchange Server 2013, Exchange Online
Topic Last Modified: 2012-09-13
Use the Set-JournalRule cmdlet to modify an existing journal rule in your organization.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Set-JournalRule -Identity <RuleIdParameter>
[-Confirm [<SwitchParameter>]] [-DomainController
<Fqdn>] [-ExpiryDate <DateTime>] [-FullReport <$true
| $false>] [-JournalEmailAddress <RecipientIdParameter>]
[-LawfulInterception <SwitchParameter>] [-Name
<String>] [-Recipient <SmtpAddress>] [-Scope
<Internal | External | Global>] [-WhatIf
[<SwitchParameter>]]
|
Examples
EXAMPLE 1
This example modifies the journal email address to which journal reports are sent by the existing journal rule Consolidated Messenger.
Copy Code | |
---|---|
Set-JournalRule "Consolidated Messenger" -JournalEmailAddress "ArchiveMailbox@contoso.com" |
EXAMPLE 2
This example modifies the journal email address for all journal rules. The Get-JournalRule cmdlet is used to retrieve all journal rules. The results are piped to the Set-JournalRule cmdlet to modify the journal recipient.
Copy Code | |
---|---|
Get-JournalRule | Set-JournalRule -JournalEmailAddress "Archive Mailbox" |
Detailed Description
The Set-JournalRule cmdlet modifies an existing journal rule used in your organization.
You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Journaling" entry in the Messaging Policy and Compliance Permissions topic.
Parameters
Parameter | Required | Type | Description |
---|---|---|---|
Identity |
Required |
Microsoft.Exchange.MessagingPolicies.Rules.Tasks.RuleIdParameter |
The Identity parameter specifies the name or GUID of the rule you want to modify. The Identity parameter is a positional parameter. When using positional parameters in a command, you can omit the parameter label. |
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch. |
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory. |
ExpiryDate |
Optional |
System.DateTime |
This parameter is reserved for internal Microsoft use. |
FullReport |
Optional |
System.Boolean |
This parameter is reserved for internal Microsoft use. |
JournalEmailAddress |
Optional |
Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter |
The JournalEmailAddress parameter specifies a journal recipient. Journal reports for the specified rule are sent to the journal recipient. |
LawfulInterception |
Optional |
System.Management.Automation.SwitchParameter |
This parameter is reserved for internal Microsoft use. |
Name |
Optional |
System.String |
The Name parameter specifies the name of the journal rule. The name of the rule can be up to 64 characters. |
Recipient |
Optional |
Microsoft.Exchange.Data.SmtpAddress |
The Recipient parameter specifies the SMTP address of a mailbox, contact, or distribution group to journal. If you specify a distribution group, all recipients in that distribution group are journaled. All messages sent to or received from a recipient are journaled. |
Scope |
Optional |
Microsoft.Exchange.MessagingPolicies.Journaling.JournalRuleScope |
The Scope parameter specifies the scope of email messages to which the journal rule is applied. You can use the following values:
|
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch. |
Input Types
To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.
Return Types
To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.