Skip to content

Commit f8924db

Browse files
tiburdtiburd
authored
Merge pull request MicrosoftDocs#8686 from gucsun/master
Adding docs for new Shifts Connector cmdlets
2 parents 8cf23f6 + 2acd6f2 commit f8924db

8 files changed

+666
-16
lines changed

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

Lines changed: 266 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,266 @@
1+
---
2+
external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml
3+
Module Name: MicrosoftTeams
4+
title: Get-CsTeamsShiftsConnectionErrorReport
5+
author: gucsun
6+
ms.author: gucsun
7+
manager: navinth
8+
online version: https://docs.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionerrorreport
9+
schema: 2.0.0
10+
---
11+
12+
# Get-CsTeamsShiftsConnectionErrorReport
13+
14+
## SYNOPSIS
15+
16+
**Note:** This cmdlet is currently in private preview.
17+
18+
This cmdlet returns the list of all the team mapping error reports. It also can return the configuration details of one mapping error report with it ID provided or other filter parameters.
19+
20+
## SYNTAX
21+
22+
```
23+
Get-CsTeamsShiftsConnectionErrorReport [[-Activeness] <String>] [[-ConnectorInstanceId] <String>] [[-TeamId] <String>] [[-Operation] <String>] [[-Code] <String>] [[-Procedure] <String>] [[-Before] <String>] [[-After] <String>] [<CommonParameters>]
24+
```
25+
26+
```
27+
Get-CsTeamsShiftsConnectionErrorReport [[-ErrorReportId] <String>] [<CommonParameters>]
28+
```
29+
30+
## DESCRIPTION
31+
32+
This cmdlet returns the list of existing team mapping error reports. It can also return the configuration details for mapping result with given ID or other filters.
33+
34+
## EXAMPLES
35+
36+
### Example 1
37+
```powershell
38+
PS C:\> Get-CsTeamsShiftsConnectionErrorReport
39+
```
40+
```output
41+
Code CreatedAt Culture Id IntermediateIncident Message Operation Parameter Procedure ResolvedAt revisitIntervalInMinutes
42+
---- --------- ------- -- -------------------- ------- --------- --------- --------- ---------- --
43+
UserMappingError 11/30/2021 11:54:47 PM en-US ec58cf47-0bb3-4c89-b9a6-e724278b57c9 2215 WfmConnector_Report_UserMappingErrorMessageCode UserMappingHandler {9, 0, 39} MapUsers 15
44+
UserMappingError 11/30/2021 11:54:47 PM en-US 18b3e490-e6ed-4c2e-9925-47e36609dff3 938 WfmConnector_Report_UserMappingErrorMessageCode UserMappingHandler {5, 0, 19} MapUsers 15
45+
UserMappingError 11/30/2021 11:54:54 PM en-US 52f6e9bf-1258-4c2b-8af2-3aca159e98b3 740 WfmConnector_Report_UserMappingErrorMessageCode UserMappingHandler {1, 2, 24} MapUsers 15
46+
UserMappingError 11/30/2021 11:55:43 PM en-US d0b7311f-823d-44e0-9171-f30eb6869335 2219 WfmConnector_Report_UserMappingErrorMessageCode UserMappingHandler {7, 1, 37} MapUsers 15
47+
UserMappingError 11/30/2021 11:55:46 PM en-US e980e667-65b3-4b00-b756-fbf974537ee9 2218 WfmConnector_Report_UserMappingErrorMessageCode UserMappingHandler {11, 2, 1} MapUsers 15
48+
```
49+
50+
Returns the list of all the error reports.
51+
52+
### Example 2
53+
```powershell
54+
PS C:\> Get-CsTeamsShiftsConnectionErrorReport -ErrorReportId 18b3e490-e6ed-4c2e-9925-47e36609dff3
55+
```
56+
```output
57+
Code CreatedAt Culture Id IntermediateIncident Message Operation Parameter Procedure ResolvedAt RevisitIntervalInMinute Revisit
58+
edAt
59+
---- --------- ------- -- -------------------- ------- --------- --------- --------- ---------- ----------------------- -------
60+
UserMappingError 11/30/2021 11:54:47 PM en-US 18b3e490-e6ed-4c2e-9925-47e36609dff3 938 WfmConnector_Report_UserMappingErrorMessageCode UserMappingHandler {5, 0, 19} MapUsers 15
61+
```
62+
63+
Returns the error report with ID `18b3e490-e6ed-4c2e-9925-47e36609dff3`.
64+
65+
### Example 3
66+
```powershell
67+
PS C:\> Get-CsTeamsShiftsConnectionErrorReport -Code UserMappingError
68+
```
69+
```output
70+
Code CreatedAt Culture Id IntermediateIncident Message
71+
---- --------- ------- -- -------------------- -------
72+
UserMappingError 11/30/2021 11:54:47 PM en-US ec58cf47-0bb3-4c89-b9a6-e724278b57c9 2217 WfmConnector…
73+
UserMappingError 11/30/2021 11:54:47 PM en-US 18b3e490-e6ed-4c2e-9925-47e36609dff3 938 WfmConnector…
74+
UserMappingError 11/30/2021 11:54:54 PM en-US 52f6e9bf-1258-4c2b-8af2-3aca159e98b3 1776 WfmConnector…
75+
UserMappingError 11/30/2021 11:55:43 PM en-US d0b7311f-823d-44e0-9171-f30eb6869335 5319 WfmConnector…
76+
```
77+
78+
Returns the error report with error code `UserMappingError`.
79+
80+
### Example 4
81+
```powershell
82+
PS C:\> Get-CsTeamsShiftsConnectionErrorReport -Operation UserMappingHandler
83+
```
84+
```output
85+
Code CreatedAt Culture Id IntermediateIncident Message Operation Parameter Procedure ResolvedAt RevisitIntervalInMin
86+
ute
87+
---- --------- ------- -- -------------------- ------- --------- --------- --------- ---------- --------------------
88+
UserMappingError 11/30/2021 11:54:47 PM en-US ec58cf47-0bb3-4c89-b9a6-e724278b57c9 2217 WfmConnector_Report_UserMappingErrorMessageCode UserMappingHandler {9, 0, 39} MapUsers 12/3/2021 8:00:20 PM 15
89+
UserMappingError 11/30/2021 11:54:47 PM en-US 18b3e490-e6ed-4c2e-9925-47e36609dff3 938 WfmConnector_Report_UserMappingErrorMessageCode UserMappingHandler {5, 0, 19} MapUsers 15
90+
UserMappingError 11/30/2021 11:54:54 PM en-US 52f6e9bf-1258-4c2b-8af2-3aca159e98b3 1776 WfmConnector_Report_UserMappingErrorMessageCode UserMappingHandler {1, 2, 24} MapUsers 15
91+
```
92+
93+
Returns the error report with operation `UserMappingHandler`.
94+
95+
### Example 5
96+
```powershell
97+
PS C:\> Get-CsTeamsShiftsConnectionErrorReport -After 2021-12-01T19:11:39.073Z
98+
```
99+
```output
100+
Code CreatedAt Culture Id IntermediateIncident Message Operation Parameter Procedure ResolvedAt
101+
---- --------- ------- -- -------------------- ------- --------- --------- --------- ----
102+
UserMappingError 12/1/2021 3:47:55 PM en-US 82e59bc0-fb69-49f4-830b-19ac3b1f66d7 4796 WfmConnector_Report_UserMappingErrorMessageCode UserMappingHandler {4, 0, 20} MapUsers
103+
UserMappingError 12/1/2021 11:04:34 PM en-US f5423691-4fc7-46db-b962-fbcad322c56d 12 WfmConnector_Report_UserMappingErrorMessageCode UserMappingHandler {13, 2, 12} MapUsers
104+
UserMappingError 12/2/2021 4:33:06 AM en-US 595f7789-0254-4a11-841d-d9b062515d2f 4383 WfmConnector_Report_UserMappingErrorMessageCode UserMappingHandler {4, 0, 20} MapUsers
105+
```
106+
107+
Returns the error report created after `2021-12-01T19:11:39.073Z`.
108+
109+
## PARAMETERS
110+
111+
### -ErrorReportId
112+
113+
The ID of the error report.
114+
115+
```yaml
116+
Type: String
117+
Parameter Sets: (All)
118+
Aliases:
119+
Applicable: Microsoft Teams
120+
Required: False
121+
Position: Named
122+
Default value: None
123+
Accept pipeline input: False
124+
Accept wildcard characters: False
125+
```
126+
127+
### -Activeness
128+
129+
The flag indicating results should have which activeness.
130+
131+
```yaml
132+
Type: String
133+
Parameter Sets: (All)
134+
Aliases:
135+
Applicable: Microsoft Teams
136+
Required: False
137+
Position: Named
138+
Default value: None
139+
Accept pipeline input: False
140+
Accept wildcard characters: False
141+
```
142+
143+
### -ConnectorInstanceId
144+
145+
The UUID of a connector instance.
146+
147+
```yaml
148+
Type: String
149+
Parameter Sets: (All)
150+
Aliases:
151+
Applicable: Microsoft Teams
152+
Required: False
153+
Position: Named
154+
Default value: None
155+
Accept pipeline input: False
156+
Accept wildcard characters: False
157+
```
158+
159+
### -TeamId
160+
161+
The UUID of a team in Graph.
162+
163+
```yaml
164+
Type: String
165+
Parameter Sets: (All)
166+
Aliases:
167+
Applicable: Microsoft Teams
168+
Required: False
169+
Position: Named
170+
Default value: None
171+
Accept pipeline input: False
172+
Accept wildcard characters: False
173+
```
174+
175+
### -Operation
176+
177+
The name of the action of the controller or the name of the command.
178+
179+
```yaml
180+
Type: String
181+
Parameter Sets: (All)
182+
Aliases:
183+
Applicable: Microsoft Teams
184+
Required: False
185+
Position: Named
186+
Default value: None
187+
Accept pipeline input: False
188+
Accept wildcard characters: False
189+
```
190+
191+
### -Procedure
192+
193+
The name of the executing function or procedure.
194+
195+
```yaml
196+
Type: String
197+
Parameter Sets: (All)
198+
Aliases:
199+
Applicable: Microsoft Teams
200+
Required: False
201+
Position: Named
202+
Default value: None
203+
Accept pipeline input: False
204+
Accept wildcard characters: False
205+
```
206+
207+
### -Code
208+
209+
The enum value of error code, human readable string defined in codebase.
210+
211+
```yaml
212+
Type: String
213+
Parameter Sets: (All)
214+
Aliases:
215+
Applicable: Microsoft Teams
216+
Required: False
217+
Position: Named
218+
Default value: None
219+
Accept pipeline input: False
220+
Accept wildcard characters: False
221+
```
222+
223+
### -Before
224+
225+
The timestamp indicating results should be before which date and time.
226+
227+
```yaml
228+
Type: String
229+
Parameter Sets: (All)
230+
Aliases:
231+
Applicable: Microsoft Teams
232+
Required: False
233+
Position: Named
234+
Default value: None
235+
Accept pipeline input: False
236+
Accept wildcard characters: False
237+
```
238+
239+
### -After
240+
241+
The timestamp indicating results should be after which date and time.
242+
243+
```yaml
244+
Type: String
245+
Parameter Sets: (All)
246+
Aliases:
247+
Applicable: Microsoft Teams
248+
Required: False
249+
Position: Named
250+
Default value: None
251+
Accept pipeline input: False
252+
Accept wildcard characters: False
253+
```
254+
255+
### CommonParameters
256+
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).
257+
258+
## INPUTS
259+
260+
## OUTPUTS
261+
262+
## NOTES
263+
264+
## RELATED LINKS
265+
266+
[Remove-CsTeamsShiftsConnectionErrorReport](Remove-CsTeamsShiftsConnectionErrorReport.md)

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

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,13 @@ This cmdlet returns the list of existing connections. It can also return the con
3434
PS C:\> Get-CsTeamsShiftsConnectionInstance
3535
```
3636
```output
37-
DesignatedActorId EnabledConnectorScenario EnabledWfiScenario Etag Id Name SyncFrequencyInMin TenantId
38-
----------------- ------------------------ ------------------ ---- -- ---- ------------------ --------
39-
b75bbfa7-e92b-40fb-99a7-2d23b3404712 {Shift, SwapRequest, UserShiftPreferences, OpenShift…} {Shift, TimeOffRequest} "1d004f54-0000-0400-0000-60ce37120000" WCI-01c84e58-9a03-4e56-82f1-6b224132cad8 Vijay Connector Instance3 10 dfd24b34-ccb0-47e1-bdb…
40-
6dc2ffaf-fd37-4a4d-ab25-ba0b037cb567 {Shift, SwapRequest, OpenShift, OpenShiftRequest…} {Shift, SwapRequest, OpenShift, TimeOff…} "21007c43-0000-0400-0000-60d061300000" WCI-0e2af164-1dcf-4854-8551-631aeda3b437 Maosha test connector instance 10 dfd24b34-ccb0-47e1-bdb…
41-
928811a9-e74b-4ff0-afe8-ff9dbe824e7f {Shift, SwapRequest, OpenShift, OpenShiftRequest…} {Shift, SwapRequest, OpenShift, TimeOff…} "2100d271-0000-0400-0000-60d07d980000" WCI-8293ff48-f41a-4f00-8cb9-75ac7a01f6d5 xiaoxue test will delete soon 10 dfd24b34-ccb0-47e1-bdb…
42-
b75bbfa7-e92b-40fb-99a7-2d23b3404712 {Shift, SwapRequest, OpenShift, OpenShiftRequest…} {Shift, SwapRequest, OpenShift, TimeOff…} "23005736-0000-0400-0000-60d10a990000" WCI-922cb572-369d-42d2-969a-d4927cd3683b Vijay Test Connector PPE Instance DEMO 10 dfd24b34-ccb0-47e1-bdb…
43-
cbec0b9a-6161-4f6a-9067-9ec3eb881e56 {Shift, SwapRequest, UserShiftPreferences, OpenShift…} {Shift, SwapRequest, UserShiftPreferences, OpenShift…} "2300589a-0000-0400-0000-60d132270000" WCI-da788d04-1bd2-48b1-a261-1dd80bde86db Jingjing Connector Instance 10 dfd24b34-ccb0-47e1-bdb…
37+
ConnectorAdminEmail DesignatedActorId EnabledConnectorScenario EnabledWfiScenario Etag Id Name SyncFrequencyInMin TenantId
38+
------------------- ----------------- ------------------------ ------------------ ---- -- ---- ------------------ --------
39+
[email protected] b75bbfa7-e92b-40fb-99a7-2d23b3404712 {Shift, SwapRequest, UserShiftPreferences, OpenShift…} {Shift, TimeOffRequest} "1d004f54-0000-0400-0000-60ce37120000" WCI-01c84e58-9a03-4e56-82f1-6b224132cad8 Vijay Connector Instance3 10 dfd24b34-ccb0-47e1-bdb…
40+
[email protected] 6dc2ffaf-fd37-4a4d-ab25-ba0b037cb567 {Shift, SwapRequest, OpenShift, OpenShiftRequest…} {Shift, SwapRequest, OpenShift, TimeOff…} "21007c43-0000-0400-0000-60d061300000" WCI-0e2af164-1dcf-4854-8551-631aeda3b437 Maosha test connector instance 10 dfd24b34-ccb0-47e1-bdb…
41+
[email protected] 928811a9-e74b-4ff0-afe8-ff9dbe824e7f {Shift, SwapRequest, OpenShift, OpenShiftRequest…} {Shift, SwapRequest, OpenShift, TimeOff…} "2100d271-0000-0400-0000-60d07d980000" WCI-8293ff48-f41a-4f00-8cb9-75ac7a01f6d5 xiaoxue test will delete soon 10 dfd24b34-ccb0-47e1-bdb…
42+
[email protected] b75bbfa7-e92b-40fb-99a7-2d23b3404712 {Shift, SwapRequest, OpenShift, OpenShiftRequest…} {Shift, SwapRequest, OpenShift, TimeOff…} "23005736-0000-0400-0000-60d10a990000" WCI-922cb572-369d-42d2-969a-d4927cd3683b Vijay Test Connector PPE Instance DEMO 10 dfd24b34-ccb0-47e1-bdb…
43+
[email protected] cbec0b9a-6161-4f6a-9067-9ec3eb881e56 {Shift, SwapRequest, UserShiftPreferences, OpenShift…} {Shift, SwapRequest, UserShiftPreferences, OpenShift…} "2300589a-0000-0400-0000-60d132270000" WCI-da788d04-1bd2-48b1-a261-1dd80bde86db Jingjing Connector Instance 10 dfd24b34-ccb0-47e1-bdb…
4444
```
4545

4646
Returns the list of connection instances.
@@ -50,9 +50,9 @@ Returns the list of connection instances.
5050
PS C:\> Get-CsTeamsShiftsConnectionInstance -ConnectorInstanceId "WCI-01c84e59-9a03-4e56-82f1-6b224132cad8"
5151
```
5252
```output
53-
DesignatedActorId EnabledConnectorScenario EnabledWfiScenario Etag Id Name SyncFrequencyInMin TenantId WorkforceIntegrationId
54-
----------------- ------------------------ ------------------ ---- -- ---- ------------------ -------- ----------------------
55-
b75bbfa7-e92b-40fb-99a7-2d23b3404712 {Shift, SwapRequest, UserShiftPreferences, OpenShift…} {Shift, TimeOffRequest} "1d004f54-0000-0400-0000-60ce37120000" WCI-01c84e58-9a03-4e56-82f1-6b224132cad8 Vijay Connector Instance3 10 dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a WFI_3fd79702-15e4-4c97-9b0e-dd725e92c…
53+
ConnectorAdminEmail DesignatedActorId EnabledConnectorScenario EnabledWfiScenario Etag Id Name SyncFrequencyInMin TenantId WorkforceIntegrationId
54+
------------------- ----------------- ------------------------ ------------------ ---- -- ---- ------------------ -------- ----------------------
55+
[email protected] b75bbfa7-e92b-40fb-99a7-2d23b3404712 {Shift, SwapRequest, UserShiftPreferences, OpenShift…} {Shift, TimeOffRequest} "1d004f54-0000-0400-0000-60ce37120000" WCI-01c84e58-9a03-4e56-82f1-6b224132cad8 Vijay Connector Instance3 10 dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a WFI_3fd79702-15e4-4c97-9b0e-dd725e92c…
5656
```
5757

5858
Returns the connection instance with ID `WCI-01c84e59-9a03-4e56-82f1-6b224132cad8`.

0 commit comments

Comments
 (0)