Commands › Microsoft Teams

Set-CsTeamsComplianceRecordingApplication

Microsoft Teams MicrosoftTeams Set-*

Modifies an existing association between an application instance of a policy-based recording application and a Teams recording policy for administering automatic policy-based recording in your tenant. Automatic policy-based recording is only applicable to Microsoft Teams users.

Quick start script

# Set-CsTeamsComplianceRecordingApplication — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-MicrosoftTeams -CertificateThumbprint $thumb -ApplicationId $appId -TenantId $tenantId

# 2. Capture the current state first — you cannot roll back what you never recorded
$before = Get-CsTeamsComplianceRecordingApplication
$before | Format-List

# 3. Make the change (dry run first)
Set-CsTeamsComplianceRecordingApplication -Id <Guid> -Parent <String> -WhatIf
Set-CsTeamsComplianceRecordingApplication -Id <Guid> -Parent <String>

# 4. Verify and diff
$after = Get-CsTeamsComplianceRecordingApplication
Compare-Object ($before | Out-String) ($after | Out-String)

Syntax — 2 parameter sets

Identity (Default)

Set-CsTeamsComplianceRecordingApplication [-Tenant <System.Guid>] [-Identity <XdsIdentity>]
 [-RequiredBeforeMeetingJoin <Boolean>] [-RequiredDuringMeeting <Boolean>]
 [-RequiredBeforeCallEstablishment <Boolean>] [-RequiredDuringCall <Boolean>]
 [-ConcurrentInvitationCount <UInt32>] [-ComplianceRecordingPairedApplications <ComplianceRecordingPairedApplication[]>]
 [-Priority <Int32>] [-Id <Guid>] [-Parent <String>][-Force] [-WhatIf] [-Confirm] [<CommonParameters>]

Instance

Set-CsTeamsComplianceRecordingApplication [-Tenant <System.Guid>] [-Instance <PSObject>]
 [-RequiredBeforeMeetingJoin <Boolean>] [-RequiredDuringMeeting <Boolean>]
 [-RequiredBeforeCallEstablishment <Boolean>] [-RequiredDuringCall <Boolean>]
 [-ConcurrentInvitationCount <UInt32>] [-ComplianceRecordingPairedApplications <ComplianceRecordingPairedApplication[]>]
 [-Priority <Int32>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]

Parameters (15)

ParameterTypeRequiredWhat it controls
-ComplianceRecordingPairedApplications ComplianceRecordingPairedApplication[] Determines the other policy-based recording applications to pair with this application to achieve application resiliency. Can only have one paired application.
-ConcurrentInvitationCount UInt32 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.
-Confirm SwitchParameter Prompts you for confirmation before running the cmdlet.
-Force SwitchParameter Suppresses the display of any non-fatal error message that might arise when running the command.
-Identity XdsIdentity A name that uniquely identifies the application instance of the policy-based recording application.
-Instance PSObject Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values.
-Priority Int32 This priority determines the order in which the policy-based recording applications are displayed in the output of the Get-CsTeamsComplianceRecordingPolicy cmdlet.
-RequiredBeforeCallEstablishment Boolean Indicates whether the policy-based recording application must be in the call before the call is allowed to establish.
-RequiredBeforeMeetingJoin Boolean Indicates whether the policy-based recording application must be in the meeting before the user is allowed to join the meeting.
-RequiredDuringCall Boolean Indicates whether the policy-based recording application must be in the call while the call is active.
-RequiredDuringMeeting Boolean Indicates whether the policy-based recording application must be in the meeting while the user is in the meeting.
-Id Guid yes The object ID of the compliance recording application (bot) in Microsoft Entra ID (Azure Active Directory).
-Parent String yes The identity of the parent Teams Compliance Recording Policy that contains this compliance recording application.
-Tenant Guid Globally unique identifier (GUID) of the tenant account whose Teams recording policies are being queried. For example:
-WhatIf SwitchParameter Shows what would happen if the cmdlet runs. The cmdlet is not run.

Reference facts derived from Microsoft documentation, © Microsoft, licensed CC BY 4.0; restructured with original guidance by serv365.ai.