Commands › Exchange Online

New-ReportSubmissionRule

Exchange Online ExchangeOnlineManagement New-*

Create the report submission rule in your cloud-based organization. The report submission rule identifies the reporting mailbox where user reported messages are delivered. **Note**: If the rule already exists (the Get-ReportSubmissionRule cmdlet returns output), you can't use this cmdlet. To delete the existing rule and start over, use the Remove-ReportSubmissionRule cmdlet first.

Quick start script

# New-ReportSubmissionRule — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-ExchangeOnline -CertificateThumbprint $thumb -AppId $appId -Organization $org

# 2. Capture the current state first — you cannot roll back what you never recorded
$before = Get-ReportSubmissionRule
$before | Format-List

# 3. Make the change (dry run first)
New-ReportSubmissionRule -Name <String> -ReportSubmissionPolicy <ReportSubmissionPolicyIdParameter> -WhatIf
New-ReportSubmissionRule -Name <String> -ReportSubmissionPolicy <ReportSubmissionPolicyIdParameter>

# 4. Verify and diff
$after = Get-ReportSubmissionRule
Compare-Object ($before | Out-String) ($after | Out-String)

Syntax

New-ReportSubmissionRule [-Name] <String> -ReportSubmissionPolicy <ReportSubmissionPolicyIdParameter>
 [-Comments <String>]
 [-Confirm]
 [-Enabled <Boolean>]
 [-SentTo <RecipientIdParameter[]>]
 [-WhatIf]
 [<CommonParameters>]

Parameters (7)

Parameter	Type	Required	What it controls
-Name	String	yes	The Name parameter specifies the name of the report submission rule. When the rule is automatically created, the name of the rule is DefaultReportSubmissionRule. We recommend using this value to avoid confusion.
-ReportSubmissionPolicy	ReportSubmissionPolicyIdParameter	yes	The ReportSubmissionPolicy parameter specifies the report submission policy that's associated with this rule. The only available policy is named DefaultReportSubmissionPolicy.
-Comments	String		The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters.
-Confirm	SwitchParameter		The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on whether the cmdlet requires confirmation before proceeding.
-Enabled	Boolean		The Enabled parameter specifies whether the rule is enabled or disabled. Valid values are:
-SentTo	RecipientIdParameter[]		The SentTo parameter specifies the email address of the reporting mailbox in Exchange Online where user reported messages are sent.
-WhatIf	SwitchParameter		The WhatIf switch shows what the command does without making any changes. You don't need to specify a value with this switch.

Reference facts derived from Microsoft documentation, © Microsoft, licensed CC BY 4.0; restructured with original guidance by serv365.ai.