Skip to content

Commit 91e9500

Browse files
author
Artemii Kozlov
committed
Update Get-CsTeamsWorkLocationDetectionPolicy documentation
1 parent b618a91 commit 91e9500

File tree

1 file changed

+50
-9
lines changed

1 file changed

+50
-9
lines changed

teams/teams-ps/teams/Get-CsTeamsWorkLocationDetectionPolicy.md

Lines changed: 50 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
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/get-csteamsworklocationdetectionpolicy
55
schema: 2.0.0
6+
ms.author: arkozlov
7+
manager: prashibadkur
8+
author: artemiykozlov
69
---
710

811
# Get-CsTeamsWorkLocationDetectionPolicy
912

1013
## SYNOPSIS
11-
{{ Fill in the Synopsis }}
14+
This cmdlet is used to fetch policy instances of TeamsWorkLocationDetectionPolicy.
1215

1316
## SYNTAX
1417

@@ -23,21 +26,52 @@ Get-CsTeamsWorkLocationDetectionPolicy [-Filter <String>] [<CommonParameters>]
2326
```
2427

2528
## DESCRIPTION
26-
{{ Fill in the Description }}
29+
Fetches instances of TeamsWorkLocationDetectionPolicy. Each policy object contains a property called `EnableWorkLocationDetection`. This property lets organizations collect the work location information of users using users plugging into hotdesks (unassigned desks) or rooms using tenant admin managed devices, using M365 in proximity of tenant managed device as MTRs, and sharing geographic geo location of mobile phone. The users can consent to use this information to set their workplace location.  The location information will be stored in the cloud and will be used for M365 hybrid work location scenarios. This information will also be used by M365 to drive analytics on workplace utilization and enhance the hybrid work experience.
2730

2831
## EXAMPLES
2932

3033
### Example 1
3134
```powershell
32-
PS C:\> {{ Add example code here }}
35+
PS C:\> Get-CsTeamsWorkLocationDetectionPolicy
3336
```
37+
```output
38+
Identity EnableWorkLocationDetection
39+
-------- ----------------------
40+
Global False
41+
Tag:wld-enabled True
42+
Tag:wld-disabled False
43+
```
44+
Fetches all the policy instances currently available.
45+
46+
### Example 2
47+
```powershell
48+
PS C:\> Get-CsTeamsWorkLocationDetectionPolicy -Identity wld-enabled
49+
```
50+
```output
51+
Identity EnableWorkLocationDetection
52+
-------- ----------------------
53+
Tag:wld-enabled True
54+
```
55+
Fetches an instance of a policy with a known identity.
56+
57+
### Example 3
58+
```powershell
59+
PS C:\> Get-CsTeamsWorkLocationDetectionPolicy -Filter *wld*
60+
```
61+
```output
62+
Identity EnableWorkLocationDetection
63+
-------- ----------------------
64+
Tag:wld-enabled True
65+
Tag:wld-disabled False
66+
```
67+
The `Filter` parameter can be used to fetch policy instances based on partial matches on Identity.
3468

35-
{{ Add example description here }}
69+
Note: _The "Tag:" prefix can be ignored when specifying the identity._
3670

3771
## PARAMETERS
3872

3973
### -Filter
40-
{{ Fill Filter Description }}
74+
This parameter can be used to fetch policy instances based on partial matches on the Identity field.
4175

4276
```yaml
4377
Type: String
@@ -52,7 +86,7 @@ Accept wildcard characters: False
5286
```
5387
5488
### -Identity
55-
{{ Fill Identity Description }}
89+
This parameter can be used to fetch a specific instance of the policy.
5690
5791
```yaml
5892
Type: String
@@ -71,7 +105,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
71105
72106
## INPUTS
73107
74-
### None
108+
### System.String
75109
76110
## OUTPUTS
77111
@@ -80,3 +114,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
80114
## NOTES
81115
82116
## RELATED LINKS
117+
[New-CsTeamsWorkLocationDetectionPolicy](New-CsTeamsWorkLocationDetectionPolicy.md)
118+
119+
[Remove-CsTeamsWorkLocationDetectionPolicy](Remove-CsTeamsWorkLocationDetectionPolicy.md)
120+
121+
[Set-CsTeamsWorkLocationDetectionPolicy](Set-CsTeamsWorkLocationDetectionPolicy.md)
122+
123+
[Grant-CsTeamsWorkLocationDetectionPolicy](Grant-CsTeamsWorkLocationDetectionPolicy.md)

0 commit comments

Comments
 (0)