Skip to content

Commit 51978b1

Browse files
aditisrivastava07aditisrivastava07
authored
Merge pull request #13203 from dlb233/patch-1
Update policy documents
2 parents 0dc438b + 905a730 commit 51978b1

10 files changed

+649
-0
lines changed

‎teams/teams-ps/MicrosoftTeams/Get-CsTeamsRecordingAndTranscriptionCustomMessage.md‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
author: dlb233
3+
Locale: en-US
4+
Module Name: MicrosoftTeams
5+
ms.author: lingbodu
6+
online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-CsTeamsRecordingAndTranscriptionCustomMessage
7+
schema: 2.0.0
8+
title: Get-CsTeamsRecordingAndTranscriptionCustomMessage
9+
---
10+
11+
# Get-CsTeamsRecordingAndTranscriptionCustomMessage
12+
13+
> [!NOTE]
14+
> This feature has not been fully released yet, so the setting will have no effect.
15+
16+
## SYNOPSIS
17+
Return information about the instance of TeamsRecordingAndTranscriptionCustomMessage that have been configured for recording and transcription customized message.
18+
19+
## SYNTAX
20+
21+
### Identity (Default)
22+
```
23+
Get-CsTeamsRecordingAndTranscriptionCustomMessage [-Id <Guid>]
24+
```
25+
26+
## DESCRIPTION
27+
28+
The strings defined in TeamsRecordingAndTranscriptionCustomMessage is used for display after recording or transcription is started in a meeting.
29+
Based on the different scenarios when recording or transcription is enabled, we provide different keys for customization, as detailed below.
30+
These strings will not take effect immediately after being created; they need to be associated with other configurations and policies.
31+
32+
This command will return existing TeamsRecordingAndTranscriptionCustomMessage by your input condition that have been configured before with New-CsTeamsRecordingAndTranscriptionCustomMessage.
33+
34+
## EXAMPLES
35+
36+
### Example 1
37+
```
38+
PS C:\> Get-CsTeamsRecordingAndTranscriptionCustomMessage
39+
```
40+
The command shown in Example 1 returns information for all the instances of TeamsRecordingAndTranscriptionCustomMessage that have been created.
41+
42+
### Example 2
43+
```
44+
PS C:\> Get-CsTeamsRecordingAndTranscriptionCustomMessage -Id '39dc3ede-c80e-4f19-9153-417a65a1f144'
45+
```
46+
In Example 2, information is returned for a single instance of a TeamsRecordingAndTranscriptionCustomMessage with the Id 39dc3ede-c80e-4f19-9153-417a65a1f144.
47+
48+
## RELATED LINKS
49+
50+
[New-CsTeamsRecordingAndTranscriptionCustomMessage](https://learn.microsoft.com/powershell/module/microsoftteams/new-CsTeamsRecordingAndTranscriptionCustomMessage)
51+
52+
[Set-CsTeamsRecordingAndTranscriptionCustomMessage](https://learn.microsoft.com/powershell/module/microsoftteams/set-CsTeamsRecordingAndTranscriptionCustomMessage)
53+
54+
[Remove-CsTeamsRecordingAndTranscriptionCustomMessage](https://learn.microsoft.com/powershell/module/microsoftteams/remove-CsTeamsRecordingAndTranscriptionCustomMessage)
55+
56+
[New-CsTeamsRecordingAndTranscriptionLocalizationCustomMessage](https://learn.microsoft.com/powershell/module/microsoftteams/new-CsTeamsRecordingAndTranscriptionLocalizationCustomMessage)

‎teams/teams-ps/MicrosoftTeams/MicrosoftTeams.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -329,6 +329,9 @@ The CsTeamsCortanaPolicy cmdlets enable administrators to control settings for C
329329
### [Get-CsTeamsCustomBannerText](Get-CsTeamsCustomBannerText.md)
330330
Enables administrators to configure a custom text on the banner displayed when compliance recording bots start recording the call.
331331

332+
### [Get-CsTeamsRecordingAndTranscriptionCustomMessage](Get-CsTeamsRecordingAndTranscriptionCustomMessage.md)
333+
This cmdlet allows IT admins to retrieve information about the instance of TeamsRecordingAndTranscriptionCustomMessage that have been configured for recording and transcription customized message.
334+
332335
### [Get-CsTeamsEducationAssignmentsAppPolicy](Get-CsTeamsEducationAssignmentsAppPolicy.md)
333336
This cmdlet allows you to retrieve the current values of your Education Assignments App Policy.
334337

@@ -956,6 +959,12 @@ The CsTeamsCortanaPolicy cmdlets enable administrators to control settings for C
956959
### [New-CsTeamsCustomBannerText](New-CsTeamsCustomBannerText.md)
957960
Enables administrators to configure a custom text on the banner displayed when compliance recording bots start recording the call.
958961

962+
### [New-CsTeamsRecordingAndTranscriptionCustomMessage](New-CsTeamsRecordingAndTranscriptionCustomMessage.md)
963+
Create a concrete prompt message setting in multiple languages and multiple scenarios to be displayed to participants after recording or transcription has started.
964+
965+
### [New-CsTeamsRecordingAndTranscriptionLocalizationCustomMessage](New-CsTeamsRecordingAndTranscriptionLocalizationCustomMessage.md)
966+
Create a set of language-specific prompt messages to be displayed to participants after recording or transcription has started.
967+
959968
### [New-CsTeamsEmergencyCallingExtendedNotification](New-CsTeamsEmergencyCallingExtendedNotification.md)
960969
{{Placeholder}}
961970

@@ -1250,6 +1259,9 @@ The CsTeamsCortanaPolicy cmdlets enable administrators to control settings for C
12501259
### [Remove-CsTeamsCustomBannerText](Remove-CsTeamsCustomBannerText.md)
12511260
Enables administrators to remove a custom banner text configuration that is displayed when compliance recording bots start recording the call.
12521261

1262+
### [Remove-CsTeamsRecordingAndTranscriptionCustomMessage](Remove-CsTeamsRecordingAndTranscriptionCustomMessage.md)
1263+
Remove information about the instance of TeamsRecordingAndTranscriptionCustomMessage that have been configured for recording and transcription customized message.
1264+
12531265
### [Remove-CsTeamsEmergencyCallingPolicy](Remove-CsTeamsEmergencyCallingPolicy.md)
12541266
{{Placeholder}}
12551267

@@ -1574,6 +1586,9 @@ The CsTeamsCortanaPolicy cmdlets enable administrators to control settings for C
15741586
### [Set-CsTeamsCustomBannerText](Set-CsTeamsCustomBannerText.md)
15751587
Enables administrators to update a configured custom text on the banner displayed when compliance recording bots start recording the call.
15761588

1589+
### [Set-CsTeamsRecordingAndTranscriptionCustomMessage](Set-CsTeamsRecordingAndTranscriptionCustomMessage.md)
1590+
Change an existing TeamsRecordingAndTranscriptionCustomMessage settings in your tenant
1591+
15771592
### [Set-CsTeamsEducationAssignmentsAppPolicy](Set-CsTeamsEducationAssignmentsAppPolicy.md)
15781593
This policy is controlled by Global and Teams Service Administrators, and is used to turn on/off certain features only related to the Assignments Service, which runs for tenants with EDU licenses.
15791594

‎teams/teams-ps/MicrosoftTeams/New-CsTeamsCallingPolicy.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,8 @@ New-CsTeamsCallingPolicy [-Identity] <string>
5656
[-RealTimeText <string>]
5757
[-ExplicitRecordingConsent <string>]
5858
[-WhatIf]
59+
[-EnableRecordingAndTranscriptionCustomMessage <Boolean>]
60+
[-RecordingAndTranscriptionCustomMessageIdentifier <Guid>]
5961
[<CommonParameters>]
6062
```
6163

@@ -798,6 +800,40 @@ Accept pipeline input: False
798800
Accept wildcard characters: False
799801
```
800802

803+
### -EnableRecordingAndTranscriptionCustomMessage
804+
> [!NOTE]
805+
> This feature has not been fully released yet, so the setting will have no effect.
806+
This policy controls whether custom strings can be shown for recording and transcription in user's Teams calls. It need to work with RecordingAndTranscriptionCustomMessageIdentifier.
807+
808+
```yaml
809+
Type: Boolean
810+
Parameter Sets: (All)
811+
Aliases:
812+
813+
Required: False
814+
Position: Named
815+
Default value: None
816+
Accept pipeline input: False
817+
Accept wildcard characters: False
818+
```
819+
820+
### -RecordingAndTranscriptionCustomMessageIdentifier
821+
> [!NOTE]
822+
> This feature has not been fully released yet, so the setting will have no effect.
823+
This attribute holds the unique identifier for the custom recording and transcription calling message. It stores a GUID that points to the CustomMessage in TeamsCustomMessageConfiguration.
824+
825+
```yaml
826+
Type: Guid
827+
Parameter Sets: (All)
828+
Aliases:
829+
830+
Required: False
831+
Position: Named
832+
Default value: None
833+
Accept pipeline input: False
834+
Accept wildcard characters: False
835+
```
836+
801837
### CommonParameters
802838
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
803839

‎teams/teams-ps/MicrosoftTeams/New-CsTeamsMeetingPolicy.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,8 @@ New-CsTeamsMeetingPolicy [-Identity] <XdsIdentity>
125125
[-ParticipantSlideControl <string>]
126126
[-WhatIf]
127127
[-WhoCanRegister <Object>]
128+
[-EnableRecordingAndTranscriptionCustomMessage <Boolean>]
129+
[-RecordingAndTranscriptionCustomMessageIdentifier <Guid>]
128130
[<CommonParameters>]
129131
```
130132

@@ -1981,6 +1983,40 @@ Accept pipeline input: False
19811983
Accept wildcard characters: False
19821984
```
19831985

1986+
### -EnableRecordingAndTranscriptionCustomMessage
1987+
> [!NOTE]
1988+
> This feature has not been fully released yet, so the setting will have no effect.
1989+
This policy controls whether custom strings can be shown for recording and transcription in user's Teams meetings. It need to work with RecordingAndTranscriptionCustomMessageIdentifier.
1990+
1991+
```yaml
1992+
Type: Boolean
1993+
Parameter Sets: (All)
1994+
Aliases:
1995+
1996+
Required: False
1997+
Position: Named
1998+
Default value: None
1999+
Accept pipeline input: False
2000+
Accept wildcard characters: False
2001+
```
2002+
2003+
### -RecordingAndTranscriptionCustomMessageIdentifier
2004+
> [!NOTE]
2005+
> This feature has not been fully released yet, so the setting will have no effect.
2006+
This attribute holds the unique identifier for the custom recording and transcription meeting message. It stores a GUID that points to the CustomMessage in TeamsCustomMessageConfiguration.
2007+
2008+
```yaml
2009+
Type: Guid
2010+
Parameter Sets: (All)
2011+
Aliases:
2012+
2013+
Required: False
2014+
Position: Named
2015+
Default value: None
2016+
Accept pipeline input: False
2017+
Accept wildcard characters: False
2018+
```
2019+
19842020
### CommonParameters
19852021
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216).
19862022

‎teams/teams-ps/MicrosoftTeams/New-CsTeamsRecordingAndTranscriptionCustomMessage.md‎

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
---
2+
author: dlb233
3+
Locale: en-US
4+
Module Name: MicrosoftTeams
5+
ms.author: lingbodu
6+
online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-CsTeamsRecordingAndTranscriptionCustomMessage
7+
schema: 2.0.0
8+
title: New-CsTeamsRecordingAndTranscriptionCustomMessage
9+
---
10+
11+
# New-CsTeamsRecordingAndTranscriptionCustomMessage
12+
13+
> [!NOTE]
14+
> This feature has not been fully released yet, so the setting will have no effect.
15+
16+
## SYNOPSIS
17+
18+
Create a concrete prompt message setting in multiple languages and multiple scenarios to be displayed to participants after recording or transcription has started.
19+
20+
## SYNTAX
21+
22+
```
23+
New-CsTeamsRecordingAndTranscriptionCustomMessage
24+
[-Id <System.Guid>]
25+
[-Description <String>]
26+
[-RecordingAndTranscriptionLocalizationCustomMessage <RecordingAndTranscriptionLocalizationCustomMessage>]
27+
[<CommonParameters>]
28+
```
29+
30+
## DESCRIPTION
31+
32+
The strings defined by this command is used for display after recording or transcription is started in a meeting.
33+
Based on the different scenarios when recording or transcription is enabled, we provide different keys for customization, as detailed below.
34+
These strings will not take effect immediately after being created; they need to be associated with other configurations and policies.
35+
36+
This command will define a complete custom message override policy that can be directly assigned to users.
37+
It specifies the In-meeting notification(UFD) prompt content that users with different roles will see in six different scenarios when starting recording and transcription, across various language environments.
38+
After this configuration is successfully completed, you can assign the generated Id to the user’s RecordingAndTranscriptionCustomMessageIdentifier field to apply the policy to that user. Afterwards, in meetings hosted by this user, once the language and scenario match, participants will see the new In-meeting notification(UFD) message customized by this command.
39+
40+
## EXAMPLES
41+
42+
### Example 1
43+
44+
```powershell
45+
PS C:\> New-CsTeamsRecordingAndTranscriptionCustomMessage -Id '39dc3ede-c80e-4f19-9153-417a65a1f144'
46+
```
47+
48+
The command shown in Example 1 creates an in-memory instance of a CsTeamsRecordingAndTranscriptionCustomMessage with no content. It can be set to RecordingAndTranscriptionCustomMessageIdentifier but nothing will change.
49+
50+
### Example 2
51+
52+
```
53+
$en = New-CsTeamsRecordingAndTranscriptionLocalizationCustomMessage -Language "en-US" -InitiatorImplicit "This call is being recorded." -ParticipantImplicit "This call is being recorded."
54+
>> $zh = New-CsTeamsRecordingAndTranscriptionLocalizationCustomMessage -Language "zh-CN" -InitiatorExplicit "请注意，此通话正在录音。" -ParticipantExplicitRequested "此通话正在录音，我们将在得到您同意后再录制你的声音。"
55+
>> New-CsTeamsRecordingAndTranscriptionCustomMessage -Description "Multi languages record custom message" -RecordingAndTranscriptionLocalizationCustomMessage @($en, $zh)
56+
```
57+
58+
Example 2 demonstrates a complete case, defining the recording and transcription prompt messages that users see in English and Chinese under different scenarios.
59+
60+
If such policy applied to the meeting organizer, then:
61+
62+
- Current user is recording/transcription intiator, Teams language is English US", the meeting organizer doesn't enable consent recording/transcription, when current user start recording or transcript, he/she will see "This call is being recorded.".
63+
64+
- Current user is normal participant, Teams language is English US, the meeting organizer doesn't enable consent recording/transcription, when recording or transcript started, current user will see "This call is being recorded."
65+
66+
- Current user is recording/transcription intiator, Teams language is Chinese simplify, the meeting organizer enable the consent recording/transcription, when current user start recording or transcript, he/she will see "请注意，此通话正在录音。"
67+
68+
- Current user is normal participant, Teams language is Chinese simplify, the meeting organizer enable the consent recording/transcription，after someone started recording or transcription, he will see "此通话正在录音，我们将在得到您同意后再录制你的声音。"
69+
70+
## Parameters
71+
72+
### -Id
73+
74+
The ObjectId of the CsTeamsRecordingAndTranscriptionCustomMessage setting, By assigning the ID to the **RecordingAndTranscriptionCustomMessageIdentifier** field in the meeting policy or calling policy, you can associate the current custom prompt message configuration with a user group or individual users.
75+
76+
At the same time, when creating CsTeamsRecordingAndTranscriptionCustomMessage, it is not necessary to explicitly specify the ID; a GUID will be automatically generated and stored as the Id.
77+
78+
### -DESCRIPTION
79+
80+
Add a description for CsTeamsRecordingAndTranscriptionCustomMessage.
81+
82+
### -RecordingAndTranscriptionLocalizationCustomMessage
83+
84+
Set the specific recording and transcription prompt messages to be customized. The type is a list of TeamsRecordingAndTranscriptionLocalizationCustomMessage, with each element in the list representing a custom message for a particular language. For more information, please refer to New-CsTeamsRecordingAndTranscriptionLocalizationCustomMessage.
85+
86+
```yaml
87+
Type: TeamsRecordingAndTranscriptionLocalizationCustomMessage[]
88+
Parameter Sets: (All)
89+
Aliases:
90+
91+
Required: False
92+
Position: Named
93+
Default value: None
94+
Accept pipeline input: False
95+
Accept wildcard characters: False
96+
```
97+
98+
## RELATED LINKS
99+
100+
[Set-CsTeamsRecordingAndTranscriptionCustomMessage](https://learn.microsoft.com/powershell/module/microsoftteams/set-CsTeamsRecordingAndTranscriptionCustomMessage)
101+
102+
[Get-CsTeamsRecordingAndTranscriptionCustomMessage](https://learn.microsoft.com/powershell/module/microsoftteams/Get-CsTeamsRecordingAndTranscriptionCustomMessage)
103+
104+
[Remove-CsTeamsRecordingAndTranscriptionCustomMessage](https://learn.microsoft.com/powershell/module/microsoftteams/remove-CsTeamsRecordingAndTranscriptionCustomMessage)
105+
106+
[New-CsTeamsRecordingAndTranscriptionLocalizationCustomMessage](https://learn.microsoft.com/powershell/module/microsoftteams/new-CsTeamsRecordingAndTranscriptionLocalizationCustomMessage)

0 commit comments

Comments
 (0)