Skip to content

Commit 635feef

Browse files
American-DipperAmerican-Dipper
authored
Merge pull request MicrosoftDocs#11668 from wattlebird/users/ronwa/recordingrolloutpolicy
doc: add doc for TeamsRecordingRollOutPolicy
2 parents 14d42c2 + 31cdd6d commit 635feef

6 files changed

+570
-0
lines changed

‎teams/teams-ps/teams/Get-CsTeamsRecordingRollOutPolicy.md

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
---
2+
external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml
3+
Module Name: Microsoft.Teams.Policy.Administration.Cmdlets.Core
4+
online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsrecordingrolloutpolicy
5+
schema: 2.0.0
6+
applicable: Microsoft Teams
7+
title: Get-CsTeamsRecordingRollOutPolicy
8+
manager: yujin1
9+
author: ronwa
10+
ms.author: ronwa
11+
---
12+
13+
# Get-CsTeamsRecordingRollOutPolicy
14+
15+
## SYNOPSIS
16+
17+
The CsTeamsRecordingRollOutPolicy controls roll out of the change that governs the storage for meeting recordings.
18+
19+
## SYNTAX
20+
21+
### Identity (Default)
22+
```
23+
Get-CsTeamsRecordingRollOutPolicy [[-Identity] <String>] [<CommonParameters>]
24+
```
25+
26+
### Filter
27+
```
28+
Get-CsTeamsRecordingRollOutPolicy [-Filter <String>] [<CommonParameters>]
29+
```
30+
31+
## DESCRIPTION
32+
33+
The CsTeamsRecordingRollOutPolicy controls roll out of the change that governs the storage for meeting recordings. This policy would be deprecated over time as this is only to allow IT admins to phase the roll out of this breaking change.
34+
35+
The Get-CsTeamsRecordingRollOutPolicy cmdlet enables you to return information about all the CsTeamsRecordingRollOutPolicy that have been configured for use in your organization.
36+
37+
This command is available from Teams powershell module 6.1.1-preview and above.
38+
39+
## EXAMPLES
40+
41+
### Example 1
42+
```powershell
43+
PS C:\> Get-CsTeamsRecordingRollOutPolicy
44+
```
45+
46+
In Example 1, Get-CsTeamsRecordingRollOutPolicy is called without any additional parameters; this returns a collection of all the CsTeamsRecordingRollOutPolicy configured for use in your organization.
47+
48+
## PARAMETERS
49+
50+
### -Filter
51+
Enables you to use wildcard characters when indicating the policy (or policies) to be returned.
52+
53+
```yaml
54+
Type: String
55+
Parameter Sets: Filter
56+
Aliases:
57+
58+
Required: False
59+
Position: Named
60+
Default value: None
61+
Accept pipeline input: False
62+
Accept wildcard characters: False
63+
```
64+
65+
### -Identity
66+
Unique identifier of the policy to be returned. To refer to the global policy, use this syntax: -Identity global. To refer to a per-user policy, use syntax similar to this: -Identity SalesDepartmentPolicy.
67+
If this parameter is omitted, then all the meeting policies configured for use in your organization will be returned.
68+
69+
```yaml
70+
Type: String
71+
Parameter Sets: Identity
72+
Aliases:
73+
74+
Required: False
75+
Position: 1
76+
Default value: None
77+
Accept pipeline input: False
78+
Accept wildcard characters: False
79+
```
80+
81+
### CommonParameters
82+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
83+
84+
## INPUTS
85+
86+
### None
87+
88+
## OUTPUTS
89+
90+
### TeamsRecordingRollOutPolicy.Cmdlets.TeamsRecordingRollOutPolicy
91+
92+
## NOTES
93+
94+
## RELATED LINKS

‎teams/teams-ps/teams/Grant-CsTeamsRecordingRollOutPolicy.md

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
---
2+
external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml
3+
Module Name: Microsoft.Teams.Policy.Administration.Cmdlets.Core
4+
online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsrecordingrolloutpolicy
5+
schema: 2.0.0
6+
applicable: Microsoft Teams
7+
title: Grant-CsTeamsRecordingRollOutPolicy
8+
manager: yujin1
9+
author: ronwa
10+
ms.author: ronwa
11+
---
12+
13+
# Grant-CsTeamsRecordingRollOutPolicy
14+
15+
## SYNOPSIS
16+
The CsTeamsRecordingRollOutPolicy controls roll out of the change that governs the storage for meeting recordings.
17+
18+
## SYNTAX
19+
20+
```
21+
Grant-CsTeamsRecordingRollOutPolicy -Identity <String> -PolicyName <String> [<CommonParameters>]
22+
```
23+
24+
## DESCRIPTION
25+
The CsTeamsRecordingRollOutPolicy controls roll out of the change that governs the storage for meeting recordings. This policy would be deprecated over time as this is only to allow IT admins to phase the roll out of this breaking change.
26+
27+
The Grant-CsTeamsRecordingRollOutPolicy cmdlet allows administrators to assign a CsTeamsRecordingRollOutPolicy at the per-user scope.
28+
29+
This command is available from Teams powershell module 6.1.1-preview and above.
30+
31+
## EXAMPLES
32+
33+
### Example 1
34+
```powershell
35+
PS C:\> Grant-CsTeamsMeetingPolicy -identity "Ken Myer" -PolicyName OrganizerPolicy
36+
```
37+
38+
In this example, a user with identity "Ken Myer" is being assigned the OrganizerPolicy
39+
40+
## PARAMETERS
41+
42+
### -Identity
43+
Indicates the Identity of the user account the policy should be assigned to. User Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). User Identities can also be referenced by using the user's Active Directory distinguished name.
44+
45+
```yaml
46+
Type: String
47+
Parameter Sets: (All)
48+
Aliases:
49+
50+
Required: True
51+
Position: Named
52+
Default value: None
53+
Accept pipeline input: False
54+
Accept wildcard characters: False
55+
```
56+
57+
### -PolicyName
58+
The name of the custom policy that is being assigned to the user. To remove a specific assignment and fall back to the default tenant policy, you can assign to $Null.
59+
60+
```yaml
61+
Type: String
62+
Parameter Sets: (All)
63+
Aliases:
64+
65+
Required: True
66+
Position: Named
67+
Default value: None
68+
Accept pipeline input: False
69+
Accept wildcard characters: False
70+
```
71+
72+
### CommonParameters
73+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
74+
75+
## INPUTS
76+
77+
### None
78+
79+
## OUTPUTS
80+
81+
### System.Object
82+
## NOTES
83+
84+
## RELATED LINKS

‎teams/teams-ps/teams/New-CsTeamsRecordingRollOutPolicy.md

Lines changed: 137 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
---
2+
external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml
3+
Module Name: Microsoft.Teams.Policy.Administration.Cmdlets.Core
4+
online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsrecordingrolloutpolicy
5+
schema: 2.0.0
6+
applicable: Microsoft Teams
7+
title: New-CsTeamsRecordingRollOutPolicy
8+
manager: yujin1
9+
author: ronwa
10+
ms.author: ronwa
11+
---
12+
13+
# New-CsTeamsRecordingRollOutPolicy
14+
15+
## SYNOPSIS
16+
17+
The CsTeamsRecordingRollOutPolicy controls roll out of the change that governs the storage for meeting recordings.
18+
19+
## SYNTAX
20+
21+
```
22+
New-CsTeamsRecordingRollOutPolicy [-MeetingRecordingOwnership <String>] [-Identity] <String> [-Force] [-WhatIf]
23+
[-Confirm] [<CommonParameters>]
24+
```
25+
26+
## DESCRIPTION
27+
28+
The CsTeamsRecordingRollOutPolicy controls roll out of the change that governs the storage for meeting recordings. This policy would be deprecated over time as this is only to allow IT admins to phase the roll out of this breaking change.
29+
30+
The New-CsTeamsRecordingRollOutPolicy cmdlet allows administrators to define new CsTeamsRecordingRollOutPolicy that can be assigned to particular users to control Teams features related to meetings.
31+
32+
This command is available from Teams powershell module 6.1.1-preview and above.
33+
34+
## EXAMPLES
35+
36+
### Example 1
37+
```powershell
38+
PS C:\> New-CsTeamsRecordingRollOutPolicy -Identity OrganizerPolicy -MeetingRecordingOwnership MeetingOrganizer
39+
```
40+
41+
The command shown in Example 1 uses the New-CsTeamsRecordingRollOutPolicy cmdlet to create a new TeamsRecordingRollOutPolicy with the Identity OrganizerPolicy.
42+
This policy will set MeetingRecordingOwnership to MeetingOrganizer. Recordings for this policy group's users as organizer would get saved to organizers' own OneDrive.
43+
44+
## PARAMETERS
45+
46+
### -Confirm
47+
Prompts you for confirmation before running the cmdlet.
48+
49+
```yaml
50+
Type: SwitchParameter
51+
Parameter Sets: (All)
52+
Aliases: cf
53+
54+
Required: False
55+
Position: Named
56+
Default value: None
57+
Accept pipeline input: False
58+
Accept wildcard characters: False
59+
```
60+
61+
### -Force
62+
Specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the switch isn't provided in the command, you're prompted for administrative input if required.
63+
64+
```yaml
65+
Type: SwitchParameter
66+
Parameter Sets: (All)
67+
Aliases:
68+
69+
Required: False
70+
Position: Named
71+
Default value: None
72+
Accept pipeline input: False
73+
Accept wildcard characters: False
74+
```
75+
76+
### -Identity
77+
Specify the name of the policy being created.
78+
79+
```yaml
80+
Type: String
81+
Parameter Sets: (All)
82+
Aliases:
83+
84+
Required: True
85+
Position: 1
86+
Default value: None
87+
Accept pipeline input: False
88+
Accept wildcard characters: False
89+
```
90+
91+
### -MeetingRecordingOwnership
92+
Specifies where the meeting recording get stored. Possible values are:
93+
- MeetingOrganizer
94+
- RecordingInitiator
95+
96+
```yaml
97+
Type: String
98+
Parameter Sets: (All)
99+
Aliases:
100+
101+
Required: False
102+
Position: Named
103+
Default value: None
104+
Accept pipeline input: False
105+
Accept wildcard characters: False
106+
```
107+
108+
### -WhatIf
109+
Shows what would happen if the cmdlet runs.
110+
The cmdlet is not run.
111+
112+
```yaml
113+
Type: SwitchParameter
114+
Parameter Sets: (All)
115+
Aliases: wi
116+
117+
Required: False
118+
Position: Named
119+
Default value: None
120+
Accept pipeline input: False
121+
Accept wildcard characters: False
122+
```
123+
124+
### CommonParameters
125+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
126+
127+
## INPUTS
128+
129+
### None
130+
131+
## OUTPUTS
132+
133+
### TeamsRecordingRollOutPolicy.Cmdlets.TeamsRecordingRollOutPolicy
134+
135+
## NOTES
136+
137+
## RELATED LINKS

0 commit comments

Comments
 (0)