Skip to content

Commit d5c945f

Browse files
v-dihansv-dihans
authored
Merge pull request MicrosoftDocs#7961 from gucsun/master
Adding docs for Shifts Connector
2 parents 9356354 + e098b0a commit d5c945f

12 files changed

+1674
-0
lines changed

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

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml
3+
Module Name: MicrosoftTeams
4+
title: Get-CsTeamsShiftsConnectionConnector
5+
author: gucsun
6+
ms.author: gucsun
7+
manager: navinth
8+
online version: https://docs.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionconnector
9+
schema: 2.0.0
10+
---
11+
12+
# Get-CsTeamsShiftsConnectionConnector
13+
14+
## SYNOPSIS
15+
16+
**Note:** This cmdlet is currently in private preview.
17+
18+
This cmdlet supports retrieving the available Shifts Connectors.
19+
20+
## SYNTAX
21+
22+
```
23+
Get-CsTeamsShiftsConnectionConnector [<CommonParameters>]
24+
```
25+
26+
## DESCRIPTION
27+
28+
This cmdlet shows the available list of Shifts Connectors that can be used to synchronize a third-party workforce management system with Teams and the types of data that can be synchronized.
29+
30+
## EXAMPLES
31+
32+
### Example 1
33+
```powershell
34+
PS C:\> Get-CsTeamsShiftsConnectionConnector
35+
```
36+
```
37+
Id Name SupportedScenario Version WfiSupportedScenario
38+
-- ---- ----------------- ------- --------------------
39+
6A51B888-FF44-4FEA-82E1-839401E9CD74 Blue Yonder V1 {Shift, SwapRequest, UserShiftPreferences, OpenShift…} 2020.3 - 2021.1 {SwapRequest, OpenShiftRequest, TimeOffRequest}
40+
```
41+
Get the list of Shifts Connectors available on the tenant.
42+
43+
## PARAMETERS
44+
45+
### CommonParameters
46+
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).
47+
48+
## INPUTS
49+
50+
## OUTPUTS
51+
52+
## NOTES
53+
54+
## RELATED LINKS
55+
56+
[New-CsTeamsShiftsConnectionInstance](New-CsTeamsShiftsConnectionInstance.md)
57+
58+
[Set-CsTeamsShiftsConnectionInstance](Set-CsTeamsShiftsConnectionInstance.md)
59+
60+
[Test-CsTeamsShiftsConnectionValidate](Test-CsTeamsShiftsConnectionValidate.md)

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

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
---
2+
external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml
3+
Module Name: MicrosoftTeams
4+
title: Get-CsTeamsShiftsConnectionInstance
5+
author: gucsun
6+
ms.author: gucsun
7+
manager: navinth
8+
online version: https://docs.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance
9+
schema: 2.0.0
10+
---
11+
12+
# Get-CsTeamsShiftsConnectionInstance
13+
14+
## SYNOPSIS
15+
16+
**Note:** This cmdlet is currently in private preview.
17+
18+
This cmdlet returns the list of existing connection instances. It can also return the configuration details for a given connection instance.
19+
20+
## SYNTAX
21+
22+
```
23+
Get-CsTeamsShiftsConnectionInstance [[-ConnectorInstanceId] <String>] [<CommonParameters>]
24+
```
25+
26+
## DESCRIPTION
27+
28+
This cmdlet returns the list of existing connections. It can also return the configuration details for a given connection instance.
29+
30+
## EXAMPLES
31+
32+
### Example 1
33+
```powershell
34+
PS C:\> Get-CsTeamsShiftsConnectionInstance
35+
```
36+
```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…
44+
```
45+
46+
Returns the list of connection instances.
47+
48+
### Example 2
49+
```powershell
50+
PS C:\> Get-CsTeamsShiftsConnectionInstance -ConnectorInstanceId "WCI-01c84e59-9a03-4e56-82f1-6b224132cad8"
51+
```
52+
```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…
56+
```
57+
58+
Returns the connection instance with ID `WCI-01c84e59-9a03-4e56-82f1-6b224132cad8`.
59+
60+
## PARAMETERS
61+
62+
### -ConnectorInstanceId
63+
64+
The ID of the connection instance.
65+
66+
```yaml
67+
Type: String
68+
Parameter Sets: (All)
69+
Aliases:
70+
Applicable: Microsoft Teams
71+
Required: False
72+
Position: Named
73+
Default value: None
74+
Accept pipeline input: False
75+
Accept wildcard characters: False
76+
```
77+
78+
### CommonParameters
79+
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).
80+
81+
## INPUTS
82+
83+
## OUTPUTS
84+
85+
## NOTES
86+
87+
## RELATED LINKS
88+
89+
[New-CsTeamsShiftsConnectionInstance](New-CsTeamsShiftsConnectionInstance.md)
90+
91+
[Set-CsTeamsShiftsConnectionInstance](Set-CsTeamsShiftsConnectionInstance.md)
92+
93+
[Test-CsTeamsShiftsConnectionValidate](Test-CsTeamsShiftsConnectionValidate.md)
94+
95+
[Remove-CsTeamsShiftsConnectionInstance](Remove-CsTeamsShiftsConnectionInstance.md)

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

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
---
2+
external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml
3+
Module Name: MicrosoftTeams
4+
title: Get-CsTeamsShiftsConnectionSyncResult
5+
author: gucsun
6+
ms.author: gucsun
7+
manager: navinth
8+
online version: https://docs.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionsyncresult
9+
schema: 2.0.0
10+
---
11+
12+
# Get-CsTeamsShiftsConnectionSyncResult
13+
14+
## SYNOPSIS
15+
16+
**Note:** This cmdlet is currently in private preview.
17+
18+
This cmdlet supports retrieving the list of user details in the mapped teams.
19+
20+
## SYNTAX
21+
22+
```
23+
Get-CsTeamsShiftsConnectionSyncResult -ConnectorInstanceId <string> -TeamId <string> [<CommonParameters>]
24+
```
25+
26+
## DESCRIPTION
27+
28+
This cmdlet supports retrieving the list of successful and failed users in the mapped teams.
29+
30+
## EXAMPLES
31+
32+
### Example 1
33+
```powershell
34+
PS C:\> Get-CsTeamsShiftsConnectionSyncResult -ConnectorInstanceId "WCI-d1addd70-2684-4723-b8f2-7fa2230648c9" -TeamId "70f49d29-7ee1-4259-8999-946953feb79e"
35+
```
36+
```output
37+
FailedAadUser FailedWfmUser SuccessfulUser
38+
------------- ------------- --------------
39+
{} {FRPET, WAROS, LABRO, JOREE…} {[email protected], [email protected], [email protected]}
40+
```
41+
42+
Returns the successful and failed users in the team mapping of Teams `70f49d29-7ee1-4259-8999-946953feb79e` in the instance with ID `WCI-d1addd70-2684-4723-b8f2-7fa2230648c9`.
43+
44+
## PARAMETERS
45+
46+
### -ConnectorInstanceId
47+
48+
The ID of the connection instance. It can be retrieved by running [Get-CsTeamsShiftsConnectionInstance](Get-CsTeamsShiftsConnectionInstance.md).
49+
50+
```yaml
51+
Type: String
52+
Parameter Sets: (All)
53+
Aliases:
54+
Applicable: Microsoft Teams
55+
Required: True
56+
Position: Named
57+
Default value: None
58+
Accept pipeline input: False
59+
Accept wildcard characters: False
60+
```
61+
62+
### -TeamId
63+
64+
The Teams team ID. It can be retrieved by visiting [AzureAAD](https://portal.azure.com/#blade/Microsoft_AAD_IAM/GroupsManagementMenuBlade/AllGroups).
65+
66+
```yaml
67+
Type: String
68+
Parameter Sets: (All)
69+
Aliases:
70+
Applicable: Microsoft Teams
71+
Required: True
72+
Position: Named
73+
Default value: None
74+
Accept pipeline input: False
75+
Accept wildcard characters: False
76+
```
77+
78+
### CommonParameters
79+
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).
80+
81+
## INPUTS
82+
83+
## OUTPUTS
84+
85+
## NOTES
86+
87+
## RELATED LINKS
88+
89+
[Get-CsTeamsShiftsConnectionInstance](Get-CsTeamsShiftsConnectionInstance.md)

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

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
---
2+
external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml
3+
Module Name: MicrosoftTeams
4+
title: Get-CsTeamsShiftsConnectionTeamMap
5+
author: gucsun
6+
ms.author: gucsun
7+
manager: navinth
8+
online version: https://docs.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionteammap
9+
schema: 2.0.0
10+
---
11+
12+
# Get-CsTeamsShiftsConnectionTeamMap
13+
14+
## SYNOPSIS
15+
16+
**Note:** This cmdlet is currently in private preview.
17+
18+
This cmdlet supports retrieving the list of team mappings.
19+
20+
## SYNTAX
21+
22+
```
23+
Get-CsTeamsShiftsConnectionTeamMap -ConnectorInstanceId <String> [<CommonParameters>]
24+
```
25+
26+
## DESCRIPTION
27+
28+
Workforce management (WFM) systems have locations / sites that are mapped to a Microsoft Teams team for synchronization of shifts data. This cmdlet shows the list of mapped teams inside the connection instance. Intance IDs can be found by running [Get-CsTeamsShiftsConnectionInstance](Get-CsTeamsShiftsConnectionInstance.md).
29+
30+
## EXAMPLES
31+
32+
### Example 1
33+
```powershell
34+
PS C:\> Get-CsTeamsShiftsConnectionTeamMap -ConnectorInstanceId "WCI-d1addd70-2684-4723-b8f2-7fa2230648c9"
35+
```
36+
```output
37+
TeamId TeamName WfmTeamId WfmTeamName
38+
------ -------- --------- -----------
39+
89ef4689-758c-4598-9206-3e23416da8c2 1000107
40+
```
41+
42+
Returns the list of team mappings in the instance with ID `WCI-d1addd70-2684-4723-b8f2-7fa2230648c9`.
43+
44+
## PARAMETERS
45+
46+
### -ConnectorInstanceId
47+
48+
The ID of the connection instance.
49+
50+
```yaml
51+
Type: String
52+
Parameter Sets: (All)
53+
Aliases:
54+
Applicable: Microsoft Teams
55+
Required: True
56+
Position: Named
57+
Default value: None
58+
Accept pipeline input: False
59+
Accept wildcard characters: False
60+
```
61+
62+
### CommonParameters
63+
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).
64+
65+
## INPUTS
66+
67+
## OUTPUTS
68+
69+
## NOTES
70+
71+
## RELATED LINKS
72+
73+
[New-CsTeamsShiftsConnectionTeamMap](New-CsTeamsShiftsConnectionTeamMap.md)
74+
75+
[Remove-CsTeamsShiftsConnectionTeamMap](Remove-CsTeamsShiftsConnectionTeamMap.md)
76+
77+
[Get-CsTeamsShiftsConnectionInstance](Get-CsTeamsShiftsConnectionInstance.md)

0 commit comments

Comments
 (0)