DSCResources/MSFT_SCComplianceTag/MSFT_SCComplianceTag.psm1
|
function Get-TargetResource { [CmdletBinding()] [OutputType([System.Collections.Hashtable])] param ( [Parameter(Mandatory = $true)] [System.String] $Name, [Parameter()] [System.String] $Comment, [Parameter()] [Microsoft.Management.Infrastructure.CimInstance] $FilePlanProperty, [Parameter()] [System.String] $RetentionDuration, [Parameter()] [System.Boolean] $IsRecordLabel, [Parameter()] [System.Boolean] $Regulatory, [Parameter()] [System.String] $Notes, [Parameter()] [System.String[]] $ReviewerEmail, [Parameter()] [ValidateSet("Delete", "Keep", "KeepAndDelete")] [System.String] $RetentionAction, [Parameter()] [System.String] $EventType, [Parameter()] [ValidateSet("CreationAgeInDays", "EventAgeInDays", "ModificationAgeInDays", "TaggedAgeInDays")] [System.String] $RetentionType, [Parameter()] [ValidateSet('Present', 'Absent')] [System.String] $Ensure = 'Present', [Parameter(Mandatory = $true)] [System.Management.Automation.PSCredential] $GlobalAdminAccount ) Write-Verbose -Message "Getting configuration of ComplianceTag for $Name" if ($Global:CurrentModeIsExport) { $ConnectionMode = New-M365DSCConnection -Platform 'SecurityComplianceCenter' ` -InboundParameters $PSBoundParameters ` -SkipModuleReload $true } else { $ConnectionMode = New-M365DSCConnection -Platform 'SecurityComplianceCenter' ` -InboundParameters $PSBoundParameters } #region Telemetry $ResourceName = $MyInvocation.MyCommand.ModuleName.Replace("MSFT_", "") $data = [System.Collections.Generic.Dictionary[[String], [String]]]::new() $data.Add("Resource", $ResourceName) $data.Add("Method", $MyInvocation.MyCommand) $data.Add("Principal", $GlobalAdminAccount.UserName) $data.Add("TenantId", $TenantId) $data.Add("ConnectionMode", $ConnectionMode) Add-M365DSCTelemetryEvent -Data $data #endregion $nullReturn = $PSBoundParameters $nullReturn.Ensure = 'Absent' try { $tagObject = Get-ComplianceTag -Identity $Name -ErrorAction SilentlyContinue if ($null -eq $tagObject) { Write-Verbose -Message "ComplianceTag $($Name) does not exist." return $nullReturn } else { Write-Verbose "Found existing ComplianceTag $($Name)" $result = @{ Name = $tagObject.Name Comment = $tagObject.Comment RetentionDuration = $tagObject.RetentionDuration IsRecordLabel = $tagObject.IsRecordLabel Regulatory = $tagObject.Regulatory Notes = $tagObject.Notes ReviewerEmail = $tagObject.ReviewerEmail RetentionAction = $tagObject.RetentionAction EventType = $tagObject.EventType RetentionType = $tagObject.RetentionType GlobalAdminAccount = $GlobalAdminAccount Ensure = 'Present' } if (-not [System.String]::IsNullOrEmpty($tagObject.FilePlanMetadata)) { $ConvertedFilePlanProperty = Get-SCFilePlanProperty $tagObject.FilePlanMetadata $result.Add("FilePlanProperty", $ConvertedFilePlanProperty) } Write-Verbose -Message "Get-TargetResource Result: `n $(Convert-M365DscHashtableToString -Hashtable $result)" return $result } } catch { try { Write-Verbose -Message $_ $tenantIdValue = "" if (-not [System.String]::IsNullOrEmpty($TenantId)) { $tenantIdValue = $TenantId } elseif ($null -ne $GlobalAdminAccount) { $tenantIdValue = $GlobalAdminAccount.UserName.Split('@')[1] } Add-M365DSCEvent -Message $_ -EntryType 'Error' ` -EventID 1 -Source $($MyInvocation.MyCommand.Source) ` -TenantId $tenantIdValue } catch { Write-Verbose -Message $_ } return $nullReturn } } function Set-TargetResource { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [System.String] $Name, [Parameter()] [System.String] $Comment, [Parameter()] [Microsoft.Management.Infrastructure.CimInstance] $FilePlanProperty, [Parameter()] [System.String] $RetentionDuration, [Parameter()] [System.Boolean] $IsRecordLabel, [Parameter()] [System.Boolean] $Regulatory, [Parameter()] [System.String] $Notes, [Parameter()] [System.String[]] $ReviewerEmail, [Parameter()] [ValidateSet("Delete", "Keep", "KeepAndDelete")] [System.String] $RetentionAction, [Parameter()] [System.String] $EventType, [Parameter()] [ValidateSet("CreationAgeInDays", "EventAgeInDays", "ModificationAgeInDays", "TaggedAgeInDays")] [System.String] $RetentionType, [Parameter()] [ValidateSet('Present', 'Absent')] [System.String] $Ensure = 'Present', [Parameter(Mandatory = $true)] [System.Management.Automation.PSCredential] $GlobalAdminAccount ) Write-Verbose -Message "Setting configuration of ComplianceTag for $Name" #region Telemetry $ResourceName = $MyInvocation.MyCommand.ModuleName.Replace("MSFT_", "") $data = [System.Collections.Generic.Dictionary[[String], [String]]]::new() $data.Add("Resource", $ResourceName) $data.Add("Method", $MyInvocation.MyCommand) $data.Add("Principal", $GlobalAdminAccount.UserName) Add-M365DSCTelemetryEvent -Data $data #endregion $ConnectionMode = New-M365DSCConnection -Platform 'SecurityComplianceCenter' ` -InboundParameters $PSBoundParameters $CurrentTag = Get-TargetResource @PSBoundParameters if (('Present' -eq $Ensure) -and ('Absent' -eq $CurrentTag.Ensure)) { $CreationParams = $PSBoundParameters $CreationParams.Remove("GlobalAdminAccount") $CreationParams.Remove("Ensure") #Convert File plan to JSON before Set if ($FilePlanProperty) { Write-Verbose -Message "Converting FilePlan to JSON" $FilePlanPropertyJSON = ConvertTo-Json (Get-SCFilePlanPropertyObject $FilePlanProperty) $CreationParams.FilePlanProperty = $FilePlanPropertyJSON } Write-Verbose "Creating new Compliance Tag $Name calling the New-ComplianceTag cmdlet." New-ComplianceTag @CreationParams } elseif (('Present' -eq $Ensure) -and ('Present' -eq $CurrentTag.Ensure)) { $SetParams = $PSBoundParameters #Remove unused parameters for Set-ComplianceTag cmdlet $SetParams.Remove("GlobalAdminAccount") $SetParams.Remove("Ensure") $SetParams.Remove("Name") $SetParams.Remove("IsRecordLabel") $SetParams.Remove("Regulatory") $SetParams.Remove("RetentionAction") $SetParams.Remove("RetentionType") # Once set, a label can't be removed; if ($SetParams.IsRecordLabel -eq $false -and $CurrentTag.IsRecordLabel -eq $true) { throw "Can't remove label on the existing Compliance Tag {$Name}. " + ` "You will need to delete the tag and recreate it." } if ($null -ne $PsBoundParameters["Regulatory"] -and $Regulatory -ne $CurrentTag.Regulatory) { throw "SPComplianceTag can't change the Regulatory property on " + ` "existing tags {$Name} from $Regulatory to $($CurrentTag.Regulatory)." + ` " You will need to delete the tag and recreate it." } if ($RetentionAction -ne $CurrentTag.RetentionAction) { throw "SPComplianceTag can't change the RetentionAction property on " + ` "existing tags {$Name} from $RetentionAction to $($CurrentTag.RetentionAction)." + ` " You will need to delete the tag and recreate it." } if ($RetentionType -ne $CurrentTag.RetentionType) { throw "SPComplianceTag can't change the RetentionType property on " + ` "existing tags {$Name} from $RetentionType to $($CurrentTag.RetentionType)." + ` " You will need to delete the tag and recreate it." } #Convert File plan to JSON before Set if ($FilePlanProperty) { Write-Verbose -Message "Converting FilePlan properties to JSON" $FilePlanPropertyJSON = ConvertTo-Json (Get-SCFilePlanPropertyObject $FilePlanProperty) $SetParams["FilePlanProperty"] = $FilePlanPropertyJSON } Set-ComplianceTag @SetParams -Identity $Name } elseif (('Absent' -eq $Ensure) -and ('Present' -eq $CurrentTag.Ensure)) { # If the Rule exists and it shouldn't, simply remove it; Remove-ComplianceTag -Identity $Name -Confirm:$false } } function Test-TargetResource { [CmdletBinding()] [OutputType([System.Boolean])] param ( [Parameter(Mandatory = $true)] [System.String] $Name, [Parameter()] [System.String] $Comment, [Parameter()] [Microsoft.Management.Infrastructure.CimInstance] $FilePlanProperty, [Parameter()] [System.String] $RetentionDuration, [Parameter()] [System.Boolean] $IsRecordLabel, [Parameter()] [System.Boolean] $Regulatory, [Parameter()] [System.String] $Notes, [Parameter()] [System.String[]] $ReviewerEmail, [Parameter()] [ValidateSet("Delete", "Keep", "KeepAndDelete")] [System.String] $RetentionAction, [Parameter()] [System.String] $EventType, [Parameter()] [ValidateSet("CreationAgeInDays", "EventAgeInDays", "ModificationAgeInDays", "TaggedAgeInDays")] [System.String] $RetentionType, [Parameter()] [ValidateSet('Present', 'Absent')] [System.String] $Ensure = 'Present', [Parameter(Mandatory = $true)] [System.Management.Automation.PSCredential] $GlobalAdminAccount ) #region Telemetry $ResourceName = $MyInvocation.MyCommand.ModuleName.Replace("MSFT_", "") $data = [System.Collections.Generic.Dictionary[[String], [String]]]::new() $data.Add("Resource", $ResourceName) $data.Add("Method", $MyInvocation.MyCommand) $data.Add("Principal", $GlobalAdminAccount.UserName) $data.Add("TenantId", $TenantId) Add-M365DSCTelemetryEvent -Data $data #endregion Write-Verbose -Message "Testing configuration of ComplianceTag for $Name" $CurrentValues = Get-TargetResource @PSBoundParameters Write-Verbose -Message "Current Values: $(Convert-M365DscHashtableToString -Hashtable $CurrentValues)" Write-Verbose -Message "Target Values: $(Convert-M365DscHashtableToString -Hashtable $PSBoundParameters)" $ValuesToCheck = $PSBoundParameters $ValuesToCheck.Remove('GlobalAdminAccount') | Out-Null $ValuesToCheck.Remove("FilePlanProperty") | Out-Null $TestFilePlanProperties = Test-SCFilePlanProperties -CurrentProperty $CurrentValues ` -DesiredProperty $PSBoundParameters if ($false -eq $TestFilePlanProperties) { return $false } $TestResult = Test-M365DSCParameterState -CurrentValues $CurrentValues ` -Source $($MyInvocation.MyCommand.Source) ` -DesiredValues $PSBoundParameters ` -ValuesToCheck $ValuesToCheck.Keys Write-Verbose -Message "Test-TargetResource returned $TestResult" return $TestResult } function Export-TargetResource { [CmdletBinding()] [OutputType([System.String])] param ( [Parameter(Mandatory = $true)] [System.Management.Automation.PSCredential] $GlobalAdminAccount ) $ConnectionMode = New-M365DSCConnection -Platform 'SecurityComplianceCenter' ` -InboundParameters $PSBoundParameters ` -SkipModuleReload $true #region Telemetry $ResourceName = $MyInvocation.MyCommand.ModuleName.Replace("MSFT_", "") $data = [System.Collections.Generic.Dictionary[[String], [String]]]::new() $data.Add("Resource", $ResourceName) $data.Add("Method", $MyInvocation.MyCommand) $data.Add("Principal", $GlobalAdminAccount.UserName) $data.Add("TenantId", $TenantId) $data.Add("ConnectionMode", $ConnectionMode) Add-M365DSCTelemetryEvent -Data $data #endregion try { $tags = Get-ComplianceTag -ErrorAction Stop $totalTags = $tags.Length if ($null -eq $totalTags) { $totalTags = 1 } $i = 1 Write-Host "`r`n" -NoNewline $dscContent = '' foreach ($tag in $tags) { Write-Host " |---[$i/$($totalTags)] $($tag.Name)" -NoNewline $Params = @{ Name = $tag.Name GlobalAdminAccount = $GlobalAdminAccount } $Results = Get-TargetResource @Params $Results.FilePlanProperty = Get-SCFilePlanPropertyAsString $Results.FilePlanProperty $Results = Update-M365DSCExportAuthenticationResults -ConnectionMode $ConnectionMode ` -Results $Results $currentDSCBlock = Get-M365DSCExportContentForResource -ResourceName $ResourceName ` -ConnectionMode $ConnectionMode ` -ModulePath $PSScriptRoot ` -Results $Results ` -GlobalAdminAccount $GlobalAdminAccount if ($null -ne $Results.FilePlanProperty) { $currentDSCBlock = Convert-DSCStringParamToVariable -DSCBlock $currentDSCBlock -ParameterName "FilePlanProperty" } $dscContent += $currentDSCBlock Save-M365DSCPartialExport -Content $currentDSCBlock ` -FileName $Global:PartialExportFileName Write-Host $Global:M365DSCEmojiGreenCheckMark $i++ } return $dscContent } catch { try { Write-Verbose -Message $_ $tenantIdValue = "" if (-not [System.String]::IsNullOrEmpty($TenantId)) { $tenantIdValue = $TenantId } elseif ($null -ne $GlobalAdminAccount) { $tenantIdValue = $GlobalAdminAccount.UserName.Split('@')[1] } Add-M365DSCEvent -Message $_ -EntryType 'Error' ` -EventID 1 -Source $($MyInvocation.MyCommand.Source) ` -TenantId $tenantIdValue } catch { Write-Verbose -Message $_ } return "" } } function Get-SCFilePlanPropertyObject { [CmdletBinding()] [OutputType([PSCustomObject])] param( [Parameter()] $Properties ) if ($null -eq $Properties) { return $null } $result = [PSCustomObject]@{ Settings = @( @{Key = "FilePlanPropertyDepartment"; Value = $properties.FilePlanPropertyDepartment }, @{Key = "FilePlanPropertyCategory"; Value = $properties.FilePlanPropertyCategory }, @{Key = "FilePlanPropertySubcategory"; Value = $properties.FilePlanPropertySubcategory }, @{Key = "FilePlanPropertyCitation"; Value = $properties.FilePlanPropertyCitation }, @{Key = "FilePlanPropertyReferenceId"; Value = $properties.FilePlanPropertyReferenceId }, @{Key = "FilePlanPropertyAuthority"; Value = $properties.FilePlanPropertyAuthority } ) } return $result } function Get-SCFilePlanProperty { [CmdletBinding()] [OutputType([System.Collections.Hashtable])] param( [Parameter(Mandatory = $true)] [System.String] $Metadata ) if ($null -eq $Metadata) { return $null } $JSONObject = ConvertFrom-Json $Metadata $result = @{} foreach ($item in $JSONObject.Settings) { $result.Add($item.Key, $item.Value) } return $result } function Get-SCFilePlanPropertyAsString($params) { if ($null -eq $params) { return $null } $currentProperty = "MSFT_SCFilePlanProperty{`r`n" foreach ($key in $params.Keys) { $currentProperty += " " + $key + " = '" + $params[$key] + "'`r`n" } $currentProperty += " }" return $currentProperty } function Test-SCFilePlanProperties { [CmdletBinding()] [OutputType([System.Boolean])] param( [Parameter(Mandatory = $true)] $CurrentProperty, [Parameter(Mandatory = $true)] $DesiredProperty ) if ($CurrentProperty.FilePlanPropertyDepartment -ne $DesiredProperty.FilePlanPropertyDepartment -or ` $CurrentProperty.FilePlanPropertyCategory -ne $DesiredProperty.FilePlanPropertyCategory -or ` $CurrentProperty.FilePlanPropertySubcategory -ne $DesiredProperty.FilePlanPropertySubcategory -or ` $CurrentProperty.FilePlanPropertyCitation -ne $DesiredProperty.FilePlanPropertyCitation -or ` $CurrentProperty.FilePlanPropertyReferenceId -ne $DesiredProperty.FilePlanPropertyReferenceId -or ` $CurrentProperty.FilePlanPropertyAuthority -ne $DesiredProperty.FilePlanPropertyAuthority) { return $false } return $true } Export-ModuleMember -Function *-TargetResource |