Skip to content

Commit 499a942

Browse files
michbrown-pngmichbrown-png
authored
Adding missing cmdlet documentation
1 parent f788db2 commit 499a942

File tree

1 file changed

+206
-131
lines changed

1 file changed

+206
-131
lines changed

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

Lines changed: 206 additions & 131 deletions
Original file line numberDiff line numberDiff line change
@@ -1,131 +1,206 @@
1-
---
2-
external help file: MicrosoftTeams-help.xml
3-
Module Name: MicrosoftTeams
4-
online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsfilespolicy
5-
schema: 2.0.0
6-
---
7-
8-
# Grant-CsTeamsFilesPolicy
9-
10-
## SYNOPSIS
11-
Assigns an online teams files policy to a user account, to a group of users, or set the tenant Global instance.
12-
Online teams files policies manage usages of files-related features.
13-
14-
## SYNTAX
15-
16-
### GrantToTenant (Default)
17-
```
18-
Grant-CsTeamsFilesPolicy [-Global] [[-PolicyName] <String>] [<CommonParameters>]
19-
20-
```
21-
22-
### GrantToGroup
23-
```
24-
Grant-CsTeamsFilesPolicy [[-PolicyName] <String>] [-Group] <String> [<CommonParameters>]
25-
```
26-
27-
### Identity
28-
```
29-
Grant-CsTeamsFilesPolicy [[-PolicyName] <String>] [-Identity <String>] [<CommonParameters>]
30-
```
31-
32-
## DESCRIPTION
33-
This cmdlet assigns an existing user-specific online teams files policy to a user, a group of users, or the Global policy instance.
34-
35-
## EXAMPLES
36-
37-
### Example 1
38-
```
39-
Grant-CsTeamsFilesPolicy -Identity "[email protected]" -PolicyName NativeEntrypointDisabled
40-
```
41-
42-
The command shown in Example 1 assigns the per-user online teams files policy NativeEntrypointDisabled to a single user [email protected].
43-
44-
### Example 2
45-
```
46-
Grant-CsTeamsFilesPolicy -Group [email protected] -PolicyName NativeEntrypointDisabled
47-
```
48-
49-
The command shown in Example 2 assigns the online teams files policy NativeEntrypointDisabled to the members of the group [email protected].
50-
51-
## PARAMETERS
52-
53-
### -Global
54-
Sets the parameters of the Global policy instance to the values in the specified policy instance.
55-
56-
```yaml
57-
Type: SwitchParameter
58-
Parameter Sets: GrantToTenant
59-
Aliases:
60-
61-
Required: False
62-
Position: Named
63-
Default value: None
64-
Accept pipeline input: False
65-
Accept wildcard characters: False
66-
```
67-
68-
### -PolicyName
69-
A unique identifier(name) of the policy.
70-
71-
```yaml
72-
Type: String
73-
Parameter Sets: (All)
74-
Aliases:
75-
76-
Required: False
77-
Position: 1
78-
Default value: None
79-
Accept pipeline input: False
80-
Accept wildcard characters: False
81-
```
82-
83-
### -Group
84-
Specifies the group used for the group policy assignment.
85-
86-
```yaml
87-
Type: String
88-
Parameter Sets: GrantToGroup
89-
Aliases:
90-
91-
Required: True
92-
Position: 0
93-
Default value: None
94-
Accept pipeline input: False
95-
Accept wildcard characters: False
96-
```
97-
98-
### -Identity
99-
The Identity parameter represents the ID of the specific user in your organization; this can be either a SIP address or an Object ID.
100-
101-
```yaml
102-
Type: String
103-
Parameter Sets: Identity
104-
Aliases:
105-
106-
Required: False
107-
Position: Named
108-
Default value: None
109-
Accept pipeline input: True (ByPropertyName, ByValue)
110-
Accept wildcard characters: False
111-
```
112-
113-
### CommonParameters
114-
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).
115-
116-
## INPUTS
117-
118-
## OUTPUTS
119-
120-
## NOTES
121-
The GrantToGroup syntax is supported in Teams PowerShell Module 4.5.1-preview or later.
122-
123-
## RELATED LINKS
124-
125-
[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsfilespolicy)
126-
127-
[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsfilespolicy)
128-
129-
[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsfilespolicy)
130-
131-
[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsfilespolicy)
1+
---
2+
external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml
3+
Module Name: MicrosoftTeams
4+
online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsfilespolicy
5+
schema: 2.0.0
6+
---
7+
8+
# Grant-CsTeamsFilesPolicy
9+
10+
## SYNOPSIS
11+
12+
This cmdlet applies an instance of the Teams AI policy to users or groups in a tenant.
13+
14+
## SYNTAX
15+
16+
### Identity (Default)
17+
18+
```powershell
19+
Grant-CsTeamsFilesPolicy [<CommonParameters>]
20+
```
21+
22+
### GrantToUser
23+
24+
```powershell
25+
Grant-CsTeamsFilesPolicy -Identity <String> [[-PolicyName] <String>] [<CommonParameters>]
26+
```
27+
28+
### GrantToGroup
29+
30+
```powershell
31+
Grant-CsTeamsFilesPolicy [[-PolicyName] <String>] [-Group] <String> -Rank <Int32> [<CommonParameters>]
32+
```
33+
34+
### GrantToTenant
35+
36+
```powershell
37+
Grant-CsTeamsFilesPolicy [[-PolicyName] <String>] [-Global] [-Force] [<CommonParameters>]
38+
```
39+
40+
## DESCRIPTION
41+
42+
The Teams Files Policy is used to modify files related settings in Microsoft teams.
43+
44+
## EXAMPLES
45+
46+
### Example 1
47+
48+
```powershell
49+
PS C:\> Grant-CsTeamsFilesPolicy -PolicyName Test -Identity [email protected]
50+
```
51+
52+
Assigns a given policy to a user.
53+
54+
### Example 2
55+
56+
```powershell
57+
PS C:\> Grant-CsTeamsFilesPolicy -Group f13d6c9d-ce76-422c-af78-b6018b4d9c80 -PolicyName Test
58+
```
59+
60+
Assigns a given policy to a group.
61+
62+
### Example 3
63+
64+
```powershell
65+
PS C:\> Grant-CsTeamsFilesPolicy -Global -PolicyName Test
66+
```
67+
68+
Assigns a given policy to the tenant.
69+
70+
### Example 4
71+
72+
```powershell
73+
PS C:\> Grant-CsTeamsFilesPolicy -Global -PolicyName Test
74+
```
75+
76+
Note: _Using $null in place of a policy name can be used to unassigned a policy instance._
77+
78+
## PARAMETERS
79+
80+
### -Force
81+
82+
Suppresses the display of any non-fatal error message that might arise when running the command.
83+
84+
```yaml
85+
Type: SwitchParameter
86+
Parameter Sets: GrantToTenant
87+
Aliases:
88+
89+
Required: False
90+
Position: Named
91+
Default value: None
92+
Accept pipeline input: False
93+
Accept wildcard characters: False
94+
```
95+
96+
### -Global
97+
98+
This is the equivalent to `-Identity Global`.
99+
100+
```yaml
101+
Type: SwitchParameter
102+
Parameter Sets: GrantToTenant
103+
Aliases:
104+
105+
Required: True
106+
Position: 0
107+
Default value: None
108+
Accept pipeline input: False
109+
Accept wildcard characters: False
110+
```
111+
112+
### -Group
113+
114+
This is the identifier of the group that the policy should be assigned to.
115+
116+
```yaml
117+
Type: String
118+
Parameter Sets: GrantToGroup
119+
Aliases:
120+
121+
Required: True
122+
Position: 0
123+
Default value: None
124+
Accept pipeline input: False
125+
Accept wildcard characters: False
126+
```
127+
128+
### -Identity
129+
130+
Specifies the identity of the target user.
131+
132+
Example: <[email protected]>
133+
134+
Example: 98403f08-577c-46dd-851a-f0460a13b03d
135+
136+
Use the "Global" Identity if you wish to set the policy for the entire tenant.
137+
138+
```yaml
139+
Type: String
140+
Parameter Sets: GrantToUser
141+
Aliases:
142+
143+
Required: True
144+
Position: Named
145+
Default value: None
146+
Accept pipeline input: True (ByPropertyName, ByValue)
147+
Accept wildcard characters: False
148+
```
149+
150+
### -PolicyName
151+
152+
Specifies the name of the policy to be assigned. The PolicyName is the policy identity minus the policy scope ("tag:"), for example, a policy that has an identity of "Tag:Enabled" has a PolicyName of "Enabled".
153+
154+
```yaml
155+
Type: String
156+
Parameter Sets: GrantToUser, GrantToGroup, GrantToTenant
157+
Aliases:
158+
159+
Required: False
160+
Position: 1
161+
Default value: None
162+
Accept pipeline input: False
163+
Accept wildcard characters: False
164+
```
165+
166+
### -Rank
167+
168+
The rank of the policy assignment, relative to other group policy assignments for the same policy type.
169+
170+
```yaml
171+
Type: Int32
172+
Parameter Sets: GrantToGroup
173+
Aliases:
174+
175+
Required: True
176+
Position: Named
177+
Default value: None
178+
Accept pipeline input: False
179+
Accept wildcard characters: False
180+
```
181+
182+
### CommonParameters
183+
184+
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).
185+
186+
## INPUTS
187+
188+
### System.String
189+
190+
## OUTPUTS
191+
192+
### System.Object
193+
194+
## NOTES
195+
196+
## RELATED LINKS
197+
198+
[Grant-CsTeamsFilesPolicy](Grant-CsTeamsFilesPolicy.md)
199+
200+
[Remove-CsTeamsFilesPolicy](Remove-CsTeamsFilesPolicy.md)
201+
202+
[Get-CsTeamsFilesPolicy](Get-CsTeamsFilesPolicy.md)
203+
204+
[Set-CsTeamsFilesPolicy](Set-CsTeamsFilesPolicy.md)
205+
206+
[New-CsTeamsFilesPolicy](New-CsTeamsFilesPolicy.md)

0 commit comments

Comments
 (0)