Set-FilePlanPropertyReferenceId

Module:

ExchangePowerShell

Applies to:

Security & Compliance

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Set-FilePlanPropertyReferenceId cmdlet to modify file plan property reference IDs.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Syntax

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

Description

To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see Permissions in Security & Compliance.

Examples

Example 1

Set-FilePlanPropertyReferenceId -Identity "Contoso-0001" -DisplayName "Reference ID Contoso-0001"

This example modifies the display name for the custom file plan property reference ID named Contoso-0001.

Parameters

-Confirm

The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.

• Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false.
• Most other cmdlets (for example, New-* and Set-* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Security & Compliance

-DisplayName

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 (").

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Security & Compliance

-Identity

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:

• Name
• Distinguished name (DN)
• Id

Type:	ComplianceRuleIdParameter
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	Security & Compliance

-WhatIf

The WhatIf switch doesn't work in Security & Compliance PowerShell.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Security & Compliance