Fix/teams compliance recording policy

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 # UNRELEASED
 
+* TeamsComplianceREcordingPolicy
+  * FIXES [[#3712](https://github.com/microsoft/Microsoft365DSC/issues/3712)]
 * EXODistributionGroup
   * Fixes the export of group membership to use Identity.
 

Modules/Microsoft365DSC/DSCResources/MSFT_TeamsComplianceRecordingPolicy/MSFT_TeamsComplianceRecordingPolicy.psm1

@@ -9,7 +9,7 @@ function Get-TargetResource
         $Identity,
 
         [Parameter()]
-        [System.String[]]
+        [Microsoft.Management.Infrastructure.CimInstance[]]
         $ComplianceRecordingApplications,
 
         [Parameter()]
@@ -75,10 +75,34 @@ function Get-TargetResource
             return $nullResult
         }
 
+        if($instance.ComplianceRecordingApplications.Count -gt 0){
+            $ComplexComplianceRecordingApplications = @()
+            foreach($CurrentComplianceRecordingApplications in $instance.ComplianceRecordingApplications){
+                $MyComplianceRecordingApplications = @{}
+                $ComplianceRecordingPairedApplications = @()
+                if($CurrentComplianceRecordingApplications.ComplianceRecordingPairedApplications.Count -gt 0){
+                    foreach($CurrentComplianceRecordingPairedApplications in $CurrentComplianceRecordingApplications.ComplianceRecordingPairedApplications){
+                        $ComplianceRecordingPairedApplications += $CurrentComplianceRecordingApplications.ComplianceRecordingPairedApplications.Id
+                    }
+                }
+                $MyComplianceRecordingApplications.Add('ComplianceRecordingPairedApplications', $ComplianceRecordingPairedApplications)
+                $MyComplianceRecordingApplications.Add('Id', $CurrentComplianceRecordingApplications.Id)
+                $MyComplianceRecordingApplications.Add('RequiredBeforeMeetingJoin', $CurrentComplianceRecordingApplications.RequiredBeforeMeetingJoin)
+                $MyComplianceRecordingApplications.Add('RequiredBeforeCallEstablishment', $CurrentComplianceRecordingApplications.RequiredBeforeCallEstablishment)
+                $MyComplianceRecordingApplications.Add('RequiredDuringMeeting', $CurrentComplianceRecordingApplications.RequiredDuringMeeting)
+                $MyComplianceRecordingApplications.Add('RequiredDuringCall', $CurrentComplianceRecordingApplications.RequiredDuringCall)
+                $MyComplianceRecordingApplications.Add('ConcurrentInvitationCount', $CurrentComplianceRecordingApplications.ConcurrentInvitationCount)
+
+                if ($MyComplianceRecordingApplications.values.Where({$null -ne $_}).count -gt 0){
+                    $ComplexComplianceRecordingApplications += $MyComplianceRecordingApplications
+                }
+            }
+        }
+
         Write-Verbose -Message "Found an instance with Identity {$Identity}"
         $results = @{
             Identity                                            = $instance.Identity
-            ComplianceRecordingApplications                     = $instance.ComplianceRecordingApplications
+            ComplianceRecordingApplications                     = $ComplexComplianceRecordingApplications
             Description                                         = $instance.Description
             DisableComplianceRecordingAudioNotificationForCalls = $instance.DisableComplianceRecordingAudioNotificationForCalls
             Enabled                                             = $instance.Enabled
@@ -113,7 +137,7 @@ function Set-TargetResource
         $Identity,
 
         [Parameter()]
-        [System.String[]]
+        [Microsoft.Management.Infrastructure.CimInstance[]]
         $ComplianceRecordingApplications,
 
         [Parameter()]
@@ -190,13 +214,55 @@ function Set-TargetResource
         {
             if ($null -ne $CreateParameters.$key -and $CreateParameters.$key.GetType().Name -like '*cimInstance*')
             {
+                $keyName = $key.substring(0, 1).ToLower() + $key.substring(1, $key.length - 1)
                 $keyValue = Convert-M365DSCDRGComplexTypeToHashtable -ComplexObject $CreateParameters.$key
                 $CreateParameters.Remove($key) | Out-Null
                 $CreateParameters.Add($keyName, $keyValue)
             }
         }
         Write-Verbose -Message "Creating {$Identity} with Parameters:`r`n$(Convert-M365DscHashtableToString -Hashtable $CreateParameters)"
         New-CsTeamsComplianceRecordingPolicy @CreateParameters | Out-Null
+
+        if($ComplianceRecordingApplications.Count -gt 0){
+            foreach($CurrentComplianceRecordingApplications in $ComplianceRecordingApplications){
+                $Instance = $CurrentComplianceRecordingApplications.Id
+                $RequiredBeforeMeetingJoin = $CurrentComplianceRecordingApplications.RequiredBeforeMeetingJoin
+                $RequiredBeforeCallEstablishment = $CurrentComplianceRecordingApplications.RequiredBeforeCallEstablishment
+                $RequiredDuringMeeting = $CurrentComplianceRecordingApplications.RequiredDuringMeeting
+                $RequiredDuringCall = $CurrentComplianceRecordingApplications.RequiredDuringCall
+                $ConcurrentInvitationCount = $CurrentComplianceRecordingApplications.ConcurrentInvitationCount
+
+                $CsTeamsComplianceRecordingApplication = Get-CsTeamsComplianceRecordingApplication -Identity $CsTeamsComplianceRecordingApplicationIdentity -ErrorAction SilentlyContinue
+                if($null -eq $CsTeamsComplianceRecordingApplication){
+                    New-CsTeamsComplianceRecordingApplication `
+                        -RequiredBeforeMeetingJoin $RequiredBeforeMeetingJoin `
+                        -RequiredBeforeCallEstablishment $RequiredBeforeCallEstablishment `
+                        -RequiredDuringMeeting $RequiredDuringMeeting `
+                        -RequiredDuringCall $RequiredDuringCall `
+                        -ConcurrentInvitationCount $ConcurrentInvitationCount `
+                        -Parent $Identity -Id $Instance
+                }
+                else{
+                    Set-CsTeamsComplianceRecordingApplication `
+                    -Identity $CsTeamsComplianceRecordingApplicationIdentity `
+                        -RequiredBeforeMeetingJoin $RequiredBeforeMeetingJoin `
+                        -RequiredBeforeCallEstablishment $RequiredBeforeCallEstablishment `
+                        -RequiredDuringMeeting $RequiredDuringMeeting `
+                        -RequiredDuringCall $RequiredDuringCall `
+                        -ConcurrentInvitationCount $ConcurrentInvitationCount
+                }
+
+                if($CurrentComplianceRecordingApplications.ComplianceRecordingPairedApplications.Count -gt 0){
+                    Set-CsTeamsComplianceRecordingApplication `
+                        -Identity "$Identity + '/' + $Instance" `
+                        -ComplianceRecordingPairedApplications @(New-CsTeamsComplianceRecordingPairedApplication `
+                        -Id $CurrentComplianceRecordingApplications.ComplianceRecordingPairedApplications)
+                }
+            }
+            $NewCsTeamsComplianceRecordingApplication = Get-CsTeamsComplianceRecordingApplication | Where-Object{$_.Identity -match $Identity}
+            Set-CsTeamsComplianceRecordingPolicy -Identity $Identity -ComplianceRecordingApplications $NewCsTeamsComplianceRecordingApplication
+        }
+
     }
     elseif ($Ensure -eq 'Present' -and $currentInstance.Ensure -eq 'Present')
     {
@@ -217,6 +283,46 @@ function Set-TargetResource
         }
 
         Set-CsTeamsComplianceRecordingPolicy @UpdateParameters | Out-Null
+        if($ComplianceRecordingApplications.Count -gt 0){
+            foreach($CurrentComplianceRecordingApplications in $ComplianceRecordingApplications){
+                $Instance = $CurrentComplianceRecordingApplications.Id
+                $RequiredBeforeMeetingJoin = $CurrentComplianceRecordingApplications.RequiredBeforeMeetingJoin
+                $RequiredBeforeCallEstablishment = $CurrentComplianceRecordingApplications.RequiredBeforeCallEstablishment
+                $RequiredDuringMeeting = $CurrentComplianceRecordingApplications.RequiredDuringMeeting
+                $RequiredDuringCall = $CurrentComplianceRecordingApplications.RequiredDuringCall
+                $ConcurrentInvitationCount = $CurrentComplianceRecordingApplications.ConcurrentInvitationCount
+
+                $CsTeamsComplianceRecordingApplicationIdentity = $Identity + '/' + $Instance
+
+                $CsTeamsComplianceRecordingApplication = Get-CsTeamsComplianceRecordingApplication -Identity $CsTeamsComplianceRecordingApplicationIdentity -ErrorAction SilentlyContinue
+                if($null -eq $CsTeamsComplianceRecordingApplication){
+                    New-CsTeamsComplianceRecordingApplication `
+                        -RequiredBeforeMeetingJoin $RequiredBeforeMeetingJoin `
+                        -RequiredBeforeCallEstablishment $RequiredBeforeCallEstablishment `
+                        -RequiredDuringMeeting $RequiredDuringMeeting `
+                        -RequiredDuringCall $RequiredDuringCall `
+                        -ConcurrentInvitationCount $ConcurrentInvitationCount `
+                        -Parent $Identity -Id $Instance
+                }
+                else{
+                    Set-CsTeamsComplianceRecordingApplication `
+                    -Identity $CsTeamsComplianceRecordingApplicationIdentity `
+                        -RequiredBeforeMeetingJoin $RequiredBeforeMeetingJoin `
+                        -RequiredBeforeCallEstablishment $RequiredBeforeCallEstablishment `
+                        -RequiredDuringMeeting $RequiredDuringMeeting `
+                        -RequiredDuringCall $RequiredDuringCall `
+                        -ConcurrentInvitationCount $ConcurrentInvitationCount
+                }
+
+                if($CurrentComplianceRecordingApplications.ComplianceRecordingPairedApplications.Count -gt 0){
+                    [string]$CsTeamsComplianceRecordingApplicationIdentity = $Identity + '/' + $Instance
+                    [string]$ComplianceRecordingPairedApplications = $CurrentComplianceRecordingApplications.ComplianceRecordingPairedApplications
+                    Set-CsTeamsComplianceRecordingApplication -Identity $CsTeamsComplianceRecordingApplicationIdentity -ComplianceRecordingPairedApplications @(New-CsTeamsComplianceRecordingPairedApplication -Id $ComplianceRecordingPairedApplications)
+                }
+            }
+            $NewCsTeamsComplianceRecordingApplication = Get-CsTeamsComplianceRecordingApplication | Where-Object{$_.Identity -match $Identity}
+            Set-CsTeamsComplianceRecordingPolicy -Identity $Identity -ComplianceRecordingApplications $NewCsTeamsComplianceRecordingApplication
+        }
     }
     elseif ($Ensure -eq 'Absent' -and $currentInstance.Ensure -eq 'Present')
     {
@@ -236,7 +342,7 @@ function Test-TargetResource
         $Identity,
 
         [Parameter()]
-        [System.String[]]
+        [Microsoft.Management.Infrastructure.CimInstance[]]
         $ComplianceRecordingApplications,
 
         [Parameter()]
@@ -300,6 +406,30 @@ function Test-TargetResource
         Write-Verbose -Message "Test-TargetResource returned $false"
         return $false
     }
+    $testResult = $true
+
+    #Compare Cim instances
+    foreach ($key in $PSBoundParameters.Keys)
+    {
+        $source = $PSBoundParameters.$key
+        $target = $CurrentValues.$key
+        if ($source.getType().Name -like '*CimInstance*')
+        {
+            $source = Get-M365DSCDRGComplexTypeToHashtable -ComplexObject $source
+
+            $testResult = Compare-M365DSCComplexObject `
+                -Source ($source) `
+                -Target ($target)
+
+            if (-Not $testResult)
+            {
+                $testResult = $false
+                break
+            }
+
+            $ValuesToCheck.Remove($key) | Out-Null
+        }
+    }
 
     Write-Verbose -Message "Current Values: $(Convert-M365DscHashtableToString -Hashtable $CurrentValues)"
     Write-Verbose -Message "Target Values: $(Convert-M365DscHashtableToString -Hashtable $ValuesToCheck)"
@@ -314,10 +444,13 @@ function Test-TargetResource
         }
     }
 
-    $testResult = Test-M365DSCParameterState -CurrentValues $CurrentValues `
-        -Source $($MyInvocation.MyCommand.Source) `
-        -DesiredValues $PSBoundParameters `
-        -ValuesToCheck $ValuesToCheck.Keys
+    if ($testResult)
+    {
+        $testResult = Test-M365DSCParameterState -CurrentValues $CurrentValues `
+            -Source $($MyInvocation.MyCommand.Source) `
+            -DesiredValues $PSBoundParameters `
+            -ValuesToCheck $ValuesToCheck.Keys
+    }
 
     Write-Verbose -Message "Test-TargetResource returned $testResult"
 
@@ -406,11 +539,42 @@ function Export-TargetResource
             $Results = Update-M365DSCExportAuthenticationResults -ConnectionMode $ConnectionMode `
                 -Results $Results
 
+            if ($null -ne $Results.ComplianceRecordingApplications)
+            {
+                $complexMapping = @(
+                    @{
+                        Name            = 'ComplianceRecordingApplications'
+                        CimInstanceName = 'TeamsComplianceRecordingApplication'
+                        IsRequired      = $False
+                    }
+                )
+                $complexTypeStringResult = Get-M365DSCDRGComplexTypeToString `
+                    -ComplexObject $Results.ComplianceRecordingApplications `
+                    -CIMInstanceName 'TeamsComplianceRecordingApplication' `
+                    -ComplexTypeMapping $complexMapping
+
+                if (-Not [String]::IsNullOrWhiteSpace($complexTypeStringResult))
+                {
+                    $Results.ComplianceRecordingApplications = $complexTypeStringResult
+                }
+                else
+                {
+                    $Results.Remove('ComplianceRecordingApplications') | Out-Null
+                }
+            }
+
             $currentDSCBlock = Get-M365DSCExportContentForResource -ResourceName $ResourceName `
                 -ConnectionMode $ConnectionMode `
                 -ModulePath $PSScriptRoot `
                 -Results $Results `
                 -Credential $Credential
+            if ($Results.ComplianceRecordingApplications)
+            {
+                $currentDSCBlock = Convert-DSCStringParamToVariable -DSCBlock $currentDSCBlock -ParameterName 'ComplianceRecordingApplications' -IsCIMArray:$True
+                $currentDSCBlock = $currentDSCBlock.Replace('ComplianceRecordingApplications         = @("', 'ComplianceRecordingApplications         = @(')
+                $currentDSCBlock = $currentDSCBlock.Replace("            `",`"`r`n", '')
+
+            }
             $dscContent += $currentDSCBlock
             Save-M365DSCPartialExport -Content $currentDSCBlock `
                 -FileName $Global:PartialExportFileName

Modules/Microsoft365DSC/DSCResources/MSFT_TeamsComplianceRecordingPolicy/MSFT_TeamsComplianceRecordingPolicy.schema.mof

@@ -1,8 +1,20 @@
+[ClassVersion("1.0.0")]
+class MSFT_TeamsComplianceRecordingApplication
+{
+    [Write, Description("A name that uniquely identifies the application instance of the policy-based recording application.")] String Id;
+    [Write, Description("Determines the other policy-based recording applications to pair with this application to achieve application resiliency. Can only have one paired application.")] String ComplianceRecordingPairedApplications[];
+    [Write, Description("Indicates whether the policy-based recording application must be in the meeting before the user is allowed to join the meeting.")] Boolean RequiredBeforeMeetingJoin;
+    [Write, Description("Indicates whether the policy-based recording application must be in the call before the call is allowed to establish.")] Boolean RequiredBeforeCallEstablishment;
+    [Write, Description("Indicates whether the policy-based recording application must be in the meeting while the user is in the meeting.")] Boolean RequiredDuringMeeting;
+    [Write, Description("Indicates whether the policy-based recording application must be in the call while the call is active.")] Boolean RequiredDuringCall;
+    [Write, Description("Determines the number of invites to send out to the application instance of the policy-based recording application. Can be set to 1 or 2 only.")] String ConcurrentInvitationCount;
+};
+
 [ClassVersion("1.0.0.0"), FriendlyName("TeamsComplianceRecordingPolicy")]
 class MSFT_TeamsComplianceRecordingPolicy : OMI_BaseResource
 {
     [Key, Description("Unique identifier of the application instance of a policy-based recording application to be retrieved.")] String Identity;
-    [Write, Description("A list of application instances of policy-based recording applications to assign to this policy. The Id of each of these application instances must be the ObjectId of the application instance as obtained by the Get-CsOnlineApplicationInstance cmdlet.")] String ComplianceRecordingApplications[];
+    [Write, Description("A list of application instances of policy-based recording applications to assign to this policy. The Id of each of these application instances must be the ObjectId of the application instance as obtained by the Get-CsOnlineApplicationInstance cmdlet."), EmbeddedInstance("MSFT_TeamsComplianceRecordingApplication")] String ComplianceRecordingApplications[];
     [Write, Description("Enables administrators to provide explanatory text to accompany a Teams recording policy. For example, the Description might include information about the users the policy should be assigned to.")] String Description;
     [Write, Description("Setting this attribute to true disables recording audio notifications for 1:1 calls that are under compliance recording.")] Boolean DisableComplianceRecordingAudioNotificationForCalls;
     [Write, Description("Controls whether this Teams recording policy is active or not.")] Boolean Enabled;

Modules/Microsoft365DSC/Examples/Resources/TeamsComplianceRecordingPolicy/1-TeamsComplianceRecordingPolicy-Example.ps1

@@ -14,15 +14,34 @@ Configuration Example
 
     node localhost
     {
-        TeamsComplianceRecordingPolicy 'Example'
+        TeamsComplianceRecordingPolicy "TeamsComplianceRecordingPolicy-Tag:MyTeamsComplianceRecordingPolicy"
         {
-            ComplianceRecordingApplications                     = @();
-            Credential                                          = $Credscredential;
+            Credential                                          = $credsCredential;
+            ComplianceRecordingApplications                     = @(
+                MSFT_TeamsComplianceRecordingApplication{
+                    Id = '00000000-0000-0000-0000-000000000000'
+                    ComplianceRecordingPairedApplications = @('00000000-0000-0000-0000-000000000000')
+                    ConcurrentInvitationCount = 1
+                    RequiredDuringCall = $True
+                    RequiredBeforeMeetingJoin = $True
+                    RequiredBeforeCallEstablishment = $True
+                    RequiredDuringMeeting = $True
+                }
+                MSFT_TeamsComplianceRecordingApplication{
+                    Id = '12345678-0000-0000-0000-000000000000'
+                    ComplianceRecordingPairedApplications = @('87654321-0000-0000-0000-000000000000')
+                    ConcurrentInvitationCount = 1
+                    RequiredDuringCall = $True
+                    RequiredBeforeMeetingJoin = $True
+                    RequiredBeforeCallEstablishment = $True
+                    RequiredDuringMeeting = $True
+                }
+            );
+            Description                                         = "MyTeamsComplianceRecordingPolicy";
             DisableComplianceRecordingAudioNotificationForCalls = $False;
-            Enabled                                             = $False;
+            Enabled                                             = $True;
             Ensure                                              = "Present";
-            Identity                                            = "Global";
+            Identity                                            = "Tag:MyTeamsComplianceRecordingPolicy";
             WarnUserOnRemoval                                   = $True;
         }
-    }
 }