Set-FilePlanPropertyCitation

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

Use the Set-FilePlanPropertyCitation cmdlet to modify file plan property citations.

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

Syntax

Set-FilePlanPropertyCitation
   [-Identity] <ComplianceRuleIdParameter>
   [-CitationJurisdiction <String>]
   [-CitationUrl <String>]
   [-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--FilePlanPropertyCitation -Identity "Contoso-0001" -CitationUrl https:intra.contoso.com/citation

This example modifies the citation URL for the custom file plan property citation named Contoso-0001.

Parameters

-CitationJurisdiction

The CitationJurisdiction parameter specifies the jurisdiction for the file plan property citation. 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

-CitationUrl

The CitationJurisdiction parameter specifies the URL for the file plan property citation.

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

-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 citation. 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 citation that you want to modify. You can use any value that uniquely identifies the citation. 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