Set-ComplianceTag

{{ Fill AutoApprovalPeriod Description }}

The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note".

{{ Fill ComplianceTagForNextStage Description }}

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.

The EventType specifies the retention rule that's associated with the label. You can use any value that uniquely identifies the rule. For example:

• Name
• Distinguished name (DN)
• GUID

You can use the Get-RetentionComplianceRule cmdlet to view the available retention rules.

The FilePlanProperty parameter specifies the file plan properties to include in the label. To view the file plan property names that you need to use in this parameter, run the following commands:

• Get-FilePlanPropertyAuthority | Format-List Name
• Get-FilePlanPropertyCategory | Format-List Name
• Get-FilePlanPropertyCitation | Format-List Name
• Get-FilePlanPropertyDepartment | Format-List Name
• Get-FilePlanPropertyReferenceId | Format-List Name
• Get-FilePlanPropertySubCategory | Format-List Name

A valid value for this parameter involves two steps:

• A variable to store the file plan properties as a PSCustomObject using the following syntax:

  $Variable1=[PSCustomObject]@{Settings=@(@{Key="FilePlanPropertyDepartment";Value="Name"},@{Key="FilePlanPropertyCategory";Value="Name"},@{Key="FilePlanPropertySubcategory";Value="Name"},@{Key="FilePlanPropertyCitation";Value="Name"},@{Key="FilePlanPropertyReferenceId";Value="Name"},@{Key="FilePlanPropertyAuthority";Value="Name"})}

  For example:

  $retentionLabelAction=[PSCustomObject]@{Settings=@(@{Key="FilePlanPropertyDepartment";Value="Legal"},@{Key="FilePlanPropertyCategory";Value="Tax"},@{Key="FilePlanPropertySubcategory";Value="US_Tax"},@{Key="FilePlanPropertyCitation";Value="LegalCitation"},@{Key="FilePlanPropertyReferenceId";Value="ReferenceA"},@{Key="FilePlanPropertyAuthority";Value="Auth1"})}

• A second variable to convert the PSCustomObject to a JSON object using the following syntax:

  $Variable2 = ConvertTo-Json $Variable1

  For example:

  $fpStr = ConvertTo-Json $retentionLabelAction

You use the second variable as the value for this parameter.

Note: This parameter is currently in Preview, is not available in all organizations, and is subject to change.

The FlowId parameter specifies the Power Automate flow to run at the end of the retention period. A valid value for this parameter is the GUID value of the flow.

You can find the GUID value of the flow by using either of the following methods:

• Navigate to the flow from the Power Automate portal. The GUID value of the flow is in the URL.
• Use the Power Automate action named 'List flows as admin'.

The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch.

You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate.

The Identity parameter specifies the label that you want to modify. You can use any value that uniquely identifies the tag. For example:

• Name
• Distinguished name (DN)
• GUID

The MultiStageReviewProperty parameter specifies the multi-stage review properties to include in the label. This parameter uses the following syntax:

'{"MultiStageReviewSettings":[{"StageName":"Stage1","Reviewers":[reviewer1,reviewer2,...reviewerN]},{"StageName":"Stage2","Reviewers":[reviewer1,reviewer2,...reviewerN]},]}'

For example:

'{"MultiStageReviewSettings":[{"StageName":"Stage1","Reviewers":[[email protected]]},{"StageName":"Stage2","Reviewers":[[email protected],[email protected]]},]}'

This syntax is a JSON object that defines each review stage id, review stage name, and list of reviewers.

The Notes parameter specifies an optional note. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is a user note".

The RetentionDuration parameter specifies the number of days to retain the content. Valid values are:

• A positive integer.
• The value unlimited.

The ReviewerEmail parameter specifies the email address of a reviewer for Delete and KeepAndDelete retention actions. You can specify multiple email addresses separated by commas.

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