Commands › Exchange Online

Set-FilePlanPropertyReferenceId

Exchange Online ExchangeOnlineManagement Set-*

For more information, see Security & Compliance PowerShell. Use the Set-FilePlanPropertyReferenceId cmdlet to modify file plan property reference IDs.

Quick start script

# Set-FilePlanPropertyReferenceId — 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-FilePlanPropertyReferenceId
$before | Format-List

# 3. Make the change (dry run first)
Set-FilePlanPropertyReferenceId -Identity <ComplianceRuleIdParameter> -WhatIf
Set-FilePlanPropertyReferenceId -Identity <ComplianceRuleIdParameter>

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

Syntax

Set-FilePlanPropertyReferenceId [-Identity] <ComplianceRuleIdParameter>
 [-Confirm]
 [-DisplayName <String>]
 [-WhatIf]
 [<CommonParameters>]

Parameters (4)

Parameter	Type	Required	What it controls
-Identity	ComplianceRuleIdParameter	yes	The Identity parameter specifies the custom file plan property reference ID that you want to modify. You can use any value that uniquely identifies the reference ID. For example:
-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.
-DisplayName	String		The DisplayName parameter specifies the display name of the file plan property reference ID. If the value contains spaces, enclose the value in quotation marks (").
-WhatIf	SwitchParameter		The WhatIf switch doesn't work in Security & Compliance PowerShell.

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