SCComplianceTag

Parameters

Parameter Attribute DataType Description Allowed Values
FilePlanPropertyDepartment Write String File plan department. Can get list by running Get-FilePlanPropertyDepartment.
FilePlanPropertyAuthority Write String File plan Authority. Can get list by running Get-FilePlanPropertyAuthority.
FilePlanPropertyCategory Write String File plan category. Can get a list by running Get-FilePlanPropertyCategory.
FilePlanPropertyCitation Write String File plan citation. Can get a list by running Get-FilePlanPropertyCitation.
FilePlanPropertyReferenceId Write String File plan reference id. Can get a list by running Get-FilePlanPropertyReferenceId.
FilePlanPropertySubCategory Write String File plan subcategory. Can get a list by running Get-FilePlanPropertySubCategory.
Name Key String The Name parameter specifies the unique name of the complaiance tag.
Ensure Write String Specify if this rule should exist or not. Present, Absent
Comment Write String The Comment parameter specifies an optional comment.
EventType Write String The EventType parameter specifies the retention rule that's associated with the label.
IsRecordLabel Write Boolean The IsRecordLabel parameter specifies whether the label is a record label.
Notes Write String 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'
Regulatory Write Boolean Regulatory description
FilePlanProperty Write Instance The FilePlanProperty parameter specifies the file plan properties to include in the label.
ReviewerEmail Write StringArray[] 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.
RetentionDuration Write String The RetentionDuration parameter specifies the hold duration for the retention rule. Valid values are: An integer - The hold duration in days, Unlimited - The content is held indefinitely.
RetentionAction Write String The RetentionAction parameter specifies the action for the label. Valid values are: Delete, Keep or KeepAndDelete. Delete, Keep, KeepAndDelete
RetentionType Write String The RetentionType parameter specifies whether the retention duration is calculated from the content creation date, tagged date, or last modification date. Valid values are: CreationAgeInDays, EventAgeInDays,ModificationAgeInDays, or TaggedAgeInDays. CreationAgeInDays, EventAgeInDays, ModificationAgeInDays, TaggedAgeInDays
Credential Required PSCredential Credentials of the Exchange Global Admin

SCComplianceTag

Description

This resource configures a Compliance Tag in Security and Compliance.

Examples

Example 1

This example is used to test new resources and showcase the usage of new resources being worked on. It is not meant to use as a production baseline.

Configuration Example
{
    param(
        [Parameter(Mandatory = $true)]
        [PSCredential]
        $credsGlobalAdmin
    )
    Import-DscResource -ModuleName Microsoft365DSC

    node localhost
    {
        SCComplianceTag 'ConfigureComplianceTag'
        {
            Name              = "DemoTag"
            Comment           = "This is a Demo Tag"
            RetentionAction   = "Keep"
            RetentionDuration = "1025"
            RetentionType     = "ModificationAgeInDays"
            FilePlanProperty  = MSFT_SCFilePlanProperty
            {
                FilePlanPropertyDepartment  = "DemoDept"
                FilePlanPropertyCitation    = "DemoCit"
                FilePlanPropertyReferenceId = "DemoRef"
                FilePlanPropertyAuthority   = "DemoAuth"
                FilePlanPropertyCategory    = "DemoCat"
                FilePlanPropertySubcategory = "DemoSub"
            }
            Ensure            = "Present"
            Credential        = $credsGlobalAdmin
        }
    }
}