TeamsComplianceRecordingPolicy¶
Parameters¶
| Parameter | Attribute | DataType | Description | Allowed Values |
|---|---|---|---|---|
| Identity | Key | String | Unique identifier of the application instance of a policy-based recording application to be retrieved. | |
| ComplianceRecordingApplications | Write | MSFT_TeamsComplianceRecordingApplication[] | 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. | |
| Description | Write | String | 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. | |
| DisableComplianceRecordingAudioNotificationForCalls | Write | Boolean | Setting this attribute to true disables recording audio notifications for 1:1 calls that are under compliance recording. | |
| Enabled | Write | Boolean | Controls whether this Teams recording policy is active or not. | |
| RecordReroutedCalls | Write | Boolean | Setting this attribute to true enables compliance recording for calls that have been re-routed from a compliance recording-enabled user. Supported call scenarios include forward, transfer, delegation, call groups, and simultaneous ring. | |
| WarnUserOnRemoval | Write | Boolean | This parameter is reserved for future use. | |
| Ensure | Write | String | Present ensures the instance exists, absent ensures it is removed. | Present, Absent |
| Credential | Write | PSCredential | Credentials of the workload's Admin | |
| ApplicationId | Write | String | Id of the Azure Active Directory application to authenticate with. | |
| TenantId | Write | String | Id of the Azure Active Directory tenant used for authentication. | |
| CertificateThumbprint | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. | |
| CertificatePassword | Write | PSCredential | Username can be made up to anything but password will be used for CertificatePassword | |
| CertificatePath | Write | String | Path to certificate used in service principal usually a PFX file. | |
| ManagedIdentity | Write | Boolean | Managed ID being used for authentication. | |
| AccessTokens | Write | String[] | Access token used for authentication. |
Embedded Instances¶
MSFT_TeamsComplianceRecordingApplication¶
Parameters¶
| Parameter | Attribute | DataType | Description | Allowed Values |
|---|---|---|---|---|
| Id | Required | String | A name that uniquely identifies the application instance of the policy-based recording application. | |
| ComplianceRecordingPairedApplications | Write | String[] | Determines the other policy-based recording applications to pair with this application to achieve application resiliency. Can only have one paired application. | |
| RequiredBeforeMeetingJoin | Write | Boolean | Indicates whether the policy-based recording application must be in the meeting before the user is allowed to join the meeting. | |
| RequiredBeforeCallEstablishment | Write | Boolean | Indicates whether the policy-based recording application must be in the call before the call is allowed to establish. | |
| RequiredDuringMeeting | Write | Boolean | Indicates whether the policy-based recording application must be in the meeting while the user is in the meeting. | |
| RequiredDuringCall | Write | Boolean | Indicates whether the policy-based recording application must be in the call while the call is active. | |
| ConcurrentInvitationCount | Write | String | 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. |
Description¶
Creates a new Teams recording policy for governing automatic policy-based recording in your tenant. Automatic policy-based recording is only applicable to Microsoft Teams users.
Permissions¶
Microsoft Entra ID roles¶
This resource requires the following Microsoft Entra ID roles:
- Read
- Teams Reader
- Update
- Teams Administrator
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()]
[System.String]
$ApplicationId,
[Parameter()]
[System.String]
$TenantId,
[Parameter()]
[System.String]
$CertificateThumbprint
)
Import-DscResource -ModuleName Microsoft365DSC
Node localhost
{
TeamsComplianceRecordingPolicy "TeamsComplianceRecordingPolicy-Example"
{
ComplianceRecordingApplications = @(
MSFT_TeamsComplianceRecordingApplication{
Id = "<compliance-recording-application-id>"
ComplianceRecordingPairedApplications = @("<compliance-recording-paired-application-id>")
ConcurrentInvitationCount = 1
RequiredDuringCall = $True
RequiredBeforeMeetingJoin = $True
RequiredBeforeCallEstablishment = $True
RequiredDuringMeeting = $True
}
);
Description = "Records calls and meetings of the trading floor staff";
DisableComplianceRecordingAudioNotificationForCalls = $False;
Enabled = $True;
Ensure = "Present";
Identity = "Tag:Trading Floor Recording";
WarnUserOnRemoval = $True;
ApplicationId = $ApplicationId;
TenantId = $TenantId;
CertificateThumbprint = $CertificateThumbprint;
}
}
}
Example 2¶
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()]
[System.String]
$ApplicationId,
[Parameter()]
[System.String]
$TenantId,
[Parameter()]
[System.String]
$CertificateThumbprint
)
Import-DscResource -ModuleName Microsoft365DSC
Node localhost
{
TeamsComplianceRecordingPolicy "TeamsComplianceRecordingPolicy-Example"
{
ComplianceRecordingApplications = @(
MSFT_TeamsComplianceRecordingApplication{
Id = "<compliance-recording-application-id>"
ComplianceRecordingPairedApplications = @("<compliance-recording-paired-application-id>")
ConcurrentInvitationCount = 1
RequiredDuringCall = $True
RequiredBeforeMeetingJoin = $True
RequiredBeforeCallEstablishment = $True
RequiredDuringMeeting = $True
}
);
Description = "Records calls and meetings of the trading floor and sales desk staff"; # Updated Property
DisableComplianceRecordingAudioNotificationForCalls = $False;
Enabled = $True;
Ensure = "Present";
Identity = "Tag:Trading Floor Recording";
WarnUserOnRemoval = $True;
ApplicationId = $ApplicationId;
TenantId = $TenantId;
CertificateThumbprint = $CertificateThumbprint;
}
}
}
Example 3¶
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()]
[System.String]
$ApplicationId,
[Parameter()]
[System.String]
$TenantId,
[Parameter()]
[System.String]
$CertificateThumbprint
)
Import-DscResource -ModuleName Microsoft365DSC
Node localhost
{
TeamsComplianceRecordingPolicy "TeamsComplianceRecordingPolicy-Example"
{
Ensure = "Absent";
Identity = "Tag:Trading Floor Recording";
ApplicationId = $ApplicationId;
TenantId = $TenantId;
CertificateThumbprint = $CertificateThumbprint;
}
}
}