Skip to content

Commit 527084f

Browse files
author
Ronnie Wang
committed
doc: add doc for TeamsRecordingRollOutPolicy
1 parent 14d42c2 commit 527084f

6 files changed

+560
-0
lines changed

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

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
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+
## EXAMPLES
38+
39+
### Example 1
40+
```powershell
41+
PS C:\> Get-CsTeamsRecordingRollOutPolicy
42+
```
43+
44+
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.
45+
46+
## PARAMETERS
47+
48+
### -Filter
49+
Enables you to use wildcard characters when indicating the policy (or policies) to be returned.
50+
51+
```yaml
52+
Type: String
53+
Parameter Sets: Filter
54+
Aliases:
55+
56+
Required: False
57+
Position: Named
58+
Default value: None
59+
Accept pipeline input: False
60+
Accept wildcard characters: False
61+
```
62+
63+
### -Identity
64+
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.
65+
If this parameter is omitted, then all the meeting policies configured for use in your organization will be returned.
66+
67+
```yaml
68+
Type: String
69+
Parameter Sets: Identity
70+
Aliases:
71+
72+
Required: False
73+
Position: 1
74+
Default value: None
75+
Accept pipeline input: False
76+
Accept wildcard characters: False
77+
```
78+
79+
### CommonParameters
80+
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).
81+
82+
## INPUTS
83+
84+
### None
85+
86+
## OUTPUTS
87+
88+
### TeamsRecordingRollOutPolicy.Cmdlets.TeamsRecordingRollOutPolicy
89+
90+
## NOTES
91+
92+
## RELATED LINKS

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

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
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+
## EXAMPLES
30+
31+
### Example 1
32+
```powershell
33+
PS C:\> Grant-CsTeamsMeetingPolicy -identity "Ken Myer" -PolicyName OrganizerPolicy
34+
```
35+
36+
In this example, a user with identity "Ken Myer" is being assigned the OrganizerPolicy
37+
38+
## PARAMETERS
39+
40+
### -Identity
41+
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.
42+
43+
```yaml
44+
Type: String
45+
Parameter Sets: (All)
46+
Aliases:
47+
48+
Required: True
49+
Position: Named
50+
Default value: None
51+
Accept pipeline input: False
52+
Accept wildcard characters: False
53+
```
54+
55+
### -PolicyName
56+
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.
57+
58+
```yaml
59+
Type: String
60+
Parameter Sets: (All)
61+
Aliases:
62+
63+
Required: True
64+
Position: Named
65+
Default value: None
66+
Accept pipeline input: False
67+
Accept wildcard characters: False
68+
```
69+
70+
### CommonParameters
71+
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).
72+
73+
## INPUTS
74+
75+
### None
76+
77+
## OUTPUTS
78+
79+
### System.Object
80+
## NOTES
81+
82+
## RELATED LINKS

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

Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
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+
## EXAMPLES
33+
34+
### Example 1
35+
```powershell
36+
PS C:\> New-CsTeamsRecordingRollOutPolicy -Identity OrganizerPolicy -MeetingRecordingOwnership MeetingOrganizer
37+
```
38+
39+
The command shown in Example 1 uses the New-CsTeamsRecordingRollOutPolicy cmdlet to create a new TeamsRecordingRollOutPolicy with the Identity OrganizerPolicy.
40+
This policy will set MeetingRecordingOwnership to MeetingOrganizer. Recordings for this policy group's users as organizer would get saved to organizers' own OneDrive.
41+
42+
## PARAMETERS
43+
44+
### -Confirm
45+
Prompts you for confirmation before running the cmdlet.
46+
47+
```yaml
48+
Type: SwitchParameter
49+
Parameter Sets: (All)
50+
Aliases: cf
51+
52+
Required: False
53+
Position: Named
54+
Default value: None
55+
Accept pipeline input: False
56+
Accept wildcard characters: False
57+
```
58+
59+
### -Force
60+
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.
61+
62+
```yaml
63+
Type: SwitchParameter
64+
Parameter Sets: (All)
65+
Aliases:
66+
67+
Required: False
68+
Position: Named
69+
Default value: None
70+
Accept pipeline input: False
71+
Accept wildcard characters: False
72+
```
73+
74+
### -Identity
75+
Specify the name of the policy being created.
76+
77+
```yaml
78+
Type: String
79+
Parameter Sets: (All)
80+
Aliases:
81+
82+
Required: True
83+
Position: 1
84+
Default value: None
85+
Accept pipeline input: False
86+
Accept wildcard characters: False
87+
```
88+
89+
### -MeetingRecordingOwnership
90+
Specifies where the meeting recording get stored. Possible values are:
91+
- MeetingOrganizer
92+
- RecordingInitiator
93+
94+
```yaml
95+
Type: String
96+
Parameter Sets: (All)
97+
Aliases:
98+
99+
Required: False
100+
Position: Named
101+
Default value: None
102+
Accept pipeline input: False
103+
Accept wildcard characters: False
104+
```
105+
106+
### -WhatIf
107+
Shows what would happen if the cmdlet runs.
108+
The cmdlet is not run.
109+
110+
```yaml
111+
Type: SwitchParameter
112+
Parameter Sets: (All)
113+
Aliases: wi
114+
115+
Required: False
116+
Position: Named
117+
Default value: None
118+
Accept pipeline input: False
119+
Accept wildcard characters: False
120+
```
121+
122+
### CommonParameters
123+
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).
124+
125+
## INPUTS
126+
127+
### None
128+
129+
## OUTPUTS
130+
131+
### TeamsRecordingRollOutPolicy.Cmdlets.TeamsRecordingRollOutPolicy
132+
133+
## NOTES
134+
135+
## RELATED LINKS

0 commit comments

Comments
 (0)