Skip to content

Commit d29d511

Browse files
author
Artemii Kozlov
committed
Update Grant-CsTeamsWorkLocationDetectionPolicy documentation
1 parent 91e9500 commit d29d511

File tree

1 file changed

+132
-13
lines changed

1 file changed

+132
-13
lines changed
Lines changed: 132 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,137 @@
11
---
22
external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml
3-
Module Name: Microsoft.Teams.Policy.Administration.Cmdlets.Core
4-
online version:
3+
Module Name: MicrosoftTeams
4+
online version: https://learn.microsoft.com/powershell/module/skype/grant-csteamsworklocationdetectionpolicy
55
schema: 2.0.0
6+
ms.author: arkozlov
7+
manager: prashibadkur
8+
author: artemiykozlov
69
---
710

811
# Grant-CsTeamsWorkLocationDetectionPolicy
912

1013
## SYNOPSIS
11-
{{ Fill in the Synopsis }}
14+
This cmdlet applies an instance of the TeamsWorkLocationDetectionPolicy to users or groups in a tenant.
1215

1316
## SYNTAX
1417

18+
### Identity (Default)
1519
```
16-
Grant-CsTeamsWorkLocationDetectionPolicy -Identity <String> -PolicyName <String> [<CommonParameters>]
20+
Grant-CsTeamsWorkLocationDetectionPolicy [<CommonParameters>]
21+
```
22+
23+
### GrantToUser
24+
```
25+
Grant-CsTeamsWorkLocationDetectionPolicy -Identity <String> [[-PolicyName] <String>] [<CommonParameters>]
26+
```
27+
28+
### GrantToGroup
29+
```
30+
Grant-CsTeamsWorkLocationDetectionPolicy [[-PolicyName] <String>] [-Group] <String> -Rank <Int32>
31+
[<CommonParameters>]
32+
```
33+
34+
### GrantToTenant
35+
```
36+
Grant-CsTeamsWorkLocationDetectionPolicy [[-PolicyName] <String>] [-Global] [-Force] [<CommonParameters>]
1737
```
1838

1939
## DESCRIPTION
20-
{{ Fill in the Description }}
40+
41+
This cmdlet applies an instance of the TeamsWorkLocationDetectionPolicy to users or groups in a tenant.
42+
43+
Passes in the `Identity` of the policy instance in the `PolicyName` parameter and the user identifier in the `Identity` parameter or the group name in the `Group` parameter. One of either `Identity` or `Group` needs to be passed.
2144

2245
## EXAMPLES
2346

2447
### Example 1
2548
```powershell
26-
PS C:\> {{ Add example code here }}
49+
PS C:\> Grant-CsTeamsWorkLocationDetectionPolicy -PolicyName sms-enabled -Identity [email protected]
50+
```
51+
52+
Assigns a given policy to a user.
53+
54+
### Example 2
55+
```powershell
56+
PS C:\> Grant-CsTeamsWorkLocationDetectionPolicy -Group f13d6c9d-ce76-422c-af78-b6018b4d9c80 -PolicyName wld-enabled
57+
```
58+
59+
Assigns a given policy to a group.
60+
61+
62+
### Example 3
63+
```powershell
64+
PS C:\> Grant-CsTeamsWorkLocationDetectionPolicy -Global -PolicyName wld-enabled
2765
```
2866

29-
{{ Add example description here }}
67+
Assigns a given policy to the tenant.
68+
69+
### Example 3
70+
```powershell
71+
PS C:\> Grant-CsTeamsWorkLocationDetectionPolicy -Global -PolicyName wld-enabled
72+
```
73+
74+
Note: _Using $null in place of a policy name can be used to unassigned a policy instance._
3075

3176
## PARAMETERS
3277

78+
### -Force
79+
Suppresses the display of any non-fatal error message that might arise when running the command.
80+
81+
```yaml
82+
Type: SwitchParameter
83+
Parameter Sets: GrantToTenant
84+
Aliases:
85+
86+
Required: False
87+
Position: Named
88+
Default value: None
89+
Accept pipeline input: False
90+
Accept wildcard characters: False
91+
```
92+
93+
### -Global
94+
This is the equivalent to `-Identity Global`.
95+
96+
```yaml
97+
Type: SwitchParameter
98+
Parameter Sets: GrantToTenant
99+
Aliases:
100+
101+
Required: True
102+
Position: 0
103+
Default value: None
104+
Accept pipeline input: False
105+
Accept wildcard characters: False
106+
```
107+
108+
### -Group
109+
This is the identifier of the group that the policy should be assigned to.
110+
111+
```yaml
112+
Type: String
113+
Parameter Sets: GrantToGroup
114+
Aliases:
115+
116+
Required: True
117+
Position: 0
118+
Default value: None
119+
Accept pipeline input: False
120+
Accept wildcard characters: False
121+
```
122+
33123
### -Identity
34-
{{ Fill Identity Description }}
124+
Specifies the identity of the target user.
125+
126+
127+
128+
Example: 98403f08-577c-46dd-851a-f0460a13b03d
129+
130+
Use the "Global" Identity if you wish to set the policy for the entire tenant.
35131

36132
```yaml
37133
Type: String
38-
Parameter Sets: (All)
134+
Parameter Sets: GrantToUser
39135
Aliases:
40136
41137
Required: True
@@ -46,11 +142,26 @@ Accept wildcard characters: False
46142
```
47143

48144
### -PolicyName
49-
{{ Fill PolicyName Description }}
145+
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".
50146

51147
```yaml
52148
Type: String
53-
Parameter Sets: (All)
149+
Parameter Sets: GrantToUser, GrantToGroup, GrantToTenant
150+
Aliases:
151+
152+
Required: False
153+
Position: 1
154+
Default value: None
155+
Accept pipeline input: False
156+
Accept wildcard characters: False
157+
```
158+
159+
### -Rank
160+
The rank of the policy assignment, relative to other group policy assignments for the same policy type.
161+
162+
```yaml
163+
Type: Int32
164+
Parameter Sets: GrantToGroup
54165
Aliases:
55166
56167
Required: True
@@ -65,11 +176,19 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
65176

66177
## INPUTS
67178

68-
### None
179+
### System.String
69180

70181
## OUTPUTS
71182

72-
### System.Object
183+
### System.Void
184+
73185
## NOTES
74186

75187
## RELATED LINKS
188+
[Get-CsTeamsWorkLocationDetectionPolicy](Get-CsTeamsWorkLocationDetectionPolicy.md)
189+
190+
[New-CsTeamsWorkLocationDetectionPolicy](New-CsTeamsWorkLocationDetectionPolicy.md)
191+
192+
[Set-CsTeamsWorkLocationDetectionPolicy](Set-CsTeamsWorkLocationDetectionPolicy.md)
193+
194+
[Remove-CsTeamsWorkLocationDetectionPolicy](Remove-CsTeamsWorkLocationDetectionPolicy.md)

0 commit comments

Comments
 (0)