Skip to content

Commit 5ab0f78

Browse files
michbrown-pngmichbrown-png
authored
Create Teams Shifts App Policy Documentation
Cmdlets are already existing. Need documentation to be live.
1 parent 460b820 commit 5ab0f78

File tree

2 files changed

+238
-0
lines changed

2 files changed

+238
-0
lines changed

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

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
---
2+
external help file: MicrosoftTeams-help.xml
3+
Module Name: MicrosoftTeams
4+
online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsapppolicy
5+
schema: 2.0.0
6+
---
7+
8+
# Get-CsTeamsShiftsAppPolicy
9+
10+
## SYNOPSIS
11+
12+
Returns information about the Teams Shifts App policies that have been configured for use in your organization.
13+
14+
## SYNTAX
15+
16+
### Identity (Default)
17+
18+
```powershell
19+
Get-CsTeamsShiftsAppPolicy [[-Identity] <String>] [-MsftInternalProcessingMode <String>] [<CommonParameters>]
20+
```
21+
22+
### Filter
23+
24+
```powershell
25+
Get-CsTeamsShiftsAppPolicy [-MsftInternalProcessingMode <String>] [-Filter <String>] [<CommonParameters>]
26+
```
27+
28+
## DESCRIPTION
29+
30+
The Teams Shifts app is designed to help frontline workers and their managers manage schedules and communicate effectively.
31+
32+
## EXAMPLES
33+
34+
### Example 1
35+
36+
```powershell
37+
PS C:\> Get-CsTeamsShiftsAppPolicy
38+
```
39+
40+
Lists any available Teams Shifts Apps Policies.
41+
42+
## PARAMETERS
43+
44+
### -Filter
45+
46+
This parameter accepts a wildcard string and returns all policies with identities matching that string. For example, a Filter value of tag:* will return all policies defined at the per-user level.
47+
48+
```yaml
49+
Type: String
50+
Parameter Sets: Filter
51+
Aliases:
52+
53+
Required: False
54+
Position: Named
55+
Default value: None
56+
Accept pipeline input: False
57+
Accept wildcard characters: False
58+
```
59+
60+
### -Identity
61+
62+
Unique Identity assigned to the policy when it was created.
63+
64+
```yaml
65+
Type: String
66+
Parameter Sets: Identity
67+
Aliases:
68+
69+
Required: False
70+
Position: 1
71+
Default value: None
72+
Accept pipeline input: False
73+
Accept wildcard characters: False
74+
```
75+
76+
### -MsftInternalProcessingMode
77+
78+
{{ Fill MsftInternalProcessingMode Description }}
79+
80+
```yaml
81+
Type: String
82+
Parameter Sets: (All)
83+
Aliases:
84+
85+
Required: False
86+
Position: Named
87+
Default value: None
88+
Accept pipeline input: False
89+
Accept wildcard characters: False
90+
```
91+
92+
### CommonParameters
93+
94+
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).
95+
96+
## INPUTS
97+
98+
### None
99+
100+
## OUTPUTS
101+
102+
### System.Object
103+
104+
## NOTES
105+
106+
## RELATED LINKS

‎teams/teams-ps/teams/Set-CsTeamsShiftsAppPolicy.md

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
---
2+
external help file: MicrosoftTeams-help.xml
3+
Module Name: MicrosoftTeams
4+
online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsapppolicy
5+
schema: 2.0.0
6+
---
7+
8+
# Set-CsTeamsShiftsAppPolicy
9+
10+
## SYNOPSIS
11+
12+
Allows you to set or update properties of a Teams Shifts App Policy instance.
13+
14+
## SYNTAX
15+
16+
```powershell
17+
Set-CsTeamsShiftsAppPolicy [-AllowTimeClockLocationDetection <Boolean>] [[-Identity] <String>]
18+
[-MsftInternalProcessingMode <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
19+
```
20+
21+
## DESCRIPTION
22+
23+
The Teams Shifts app is designed to help frontline workers and their managers manage schedules and communicate effectively.
24+
25+
## EXAMPLES
26+
27+
### Example 1
28+
29+
```powershell
30+
PS C:\> Set-CsTeamsShiftsAppPolicy 'Default' -AllowTimeClockLocationDetection $False
31+
```
32+
33+
Change Settings on a Teams Shift App Policy (only works on Global policy)
34+
35+
## PARAMETERS
36+
37+
### -AllowTimeClockLocationDetection
38+
39+
Turns on the location detection. The time report will indicate whether workers are "on location" when they clocked in and out. Workers are considered as "on location" if they clock in or out within a 200-meter radius of the set location.
40+
41+
```yaml
42+
Type: Boolean
43+
Parameter Sets: (All)
44+
Aliases:
45+
46+
Required: False
47+
Position: Named
48+
Default value: None
49+
Accept pipeline input: False
50+
Accept wildcard characters: False
51+
```
52+
53+
### -Confirm
54+
55+
Prompts you for confirmation before running the cmdlet.
56+
57+
```yaml
58+
Type: SwitchParameter
59+
Parameter Sets: (All)
60+
Aliases: cf
61+
62+
Required: False
63+
Position: Named
64+
Default value: None
65+
Accept pipeline input: False
66+
Accept wildcard characters: False
67+
```
68+
69+
### -Identity
70+
71+
Policy instance name.
72+
73+
```yaml
74+
Type: String
75+
Parameter Sets: (All)
76+
Aliases:
77+
78+
Required: False
79+
Position: 1
80+
Default value: None
81+
Accept pipeline input: False
82+
Accept wildcard characters: False
83+
```
84+
85+
### -MsftInternalProcessingMode
86+
87+
For internal use only.
88+
89+
```yaml
90+
Type: String
91+
Parameter Sets: (All)
92+
Aliases:
93+
94+
Required: False
95+
Position: Named
96+
Default value: None
97+
Accept pipeline input: False
98+
Accept wildcard characters: False
99+
```
100+
101+
### -WhatIf
102+
103+
Shows what would happen if the cmdlet runs.
104+
The cmdlet is not run.
105+
106+
```yaml
107+
Type: SwitchParameter
108+
Parameter Sets: (All)
109+
Aliases: wi
110+
111+
Required: False
112+
Position: Named
113+
Default value: None
114+
Accept pipeline input: False
115+
Accept wildcard characters: False
116+
```
117+
118+
### CommonParameters
119+
120+
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).
121+
122+
## INPUTS
123+
124+
### None
125+
126+
## OUTPUTS
127+
128+
### System.Object
129+
130+
## NOTES
131+
132+
## RELATED LINKS

0 commit comments

Comments
 (0)