Skip to content

Commit 75903bb

Browse files
tiburdtiburd
authored
Merge pull request #10741 from Shane-Malone/shanemalone/connectorV2
Update Teams Shifts Connector Cmdlets to V2 APIs
2 parents b2b45b4 + 8b55276 commit 75903bb

16 files changed

+1932
-630
lines changed

‎.openpublishing.redirection.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6929,6 +6929,11 @@
69296929
"source_path": "exchange/virtual-folder/exchange/Set-DefaultTenantBriefingConfig.md",
69306930
"redirect_url": "/viva/insights/personal/reference/briefing-pause",
69316931
"redirect_document_id": false
6932+
},
6933+
{
6934+
"source_path": "teams/teams-ps/teams/New-CsTeamsShiftsConnectionTeamMap.yml",
6935+
"redirect_url": "https://review.learn.microsoft.com/en-us/powershell/module/teams/",
6936+
"redirect_document_id": false
69326937
}
69336938
]
69346939
}

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

Lines changed: 252 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,252 @@
1+
---
2+
external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml
3+
Module Name: MicrosoftTeams
4+
title: Get-CsTeamsShiftsConnection
5+
author: shane-malone
6+
ms.author: shanemalone
7+
manager: valk
8+
online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection
9+
schema: 2.0.0
10+
---
11+
12+
# Get-CsTeamsShiftsConnection
13+
14+
## SYNOPSIS
15+
This cmdlet returns the list of existing workforce management (WFM) connections. It can also return the configuration details for a given WFM connection.
16+
17+
## SYNTAX
18+
19+
### Get (Default)
20+
```
21+
Get-CsTeamsShiftsConnection [-Authorization <string>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <uri>] [-ProxyCredential <pscredential>] [-ProxyUseDefaultCredentials] [<CommonParameters>]
22+
```
23+
24+
### Get1
25+
```
26+
Get-CsTeamsShiftsConnection -ConnectionId <string> [-Authorization <string>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <uri>] [-ProxyCredential <pscredential>] [-ProxyUseDefaultCredentials] [<CommonParameters>]
27+
```
28+
29+
### GetViaIdentity
30+
```
31+
Get-CsTeamsShiftsConnection -InputObject <IConfigApiBasedCmdletsIdentity> [-Authorization <string>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <uri>] [-ProxyCredential <pscredential>] [-ProxyUseDefaultCredentials] [<CommonParameters>]
32+
```
33+
34+
## DESCRIPTION
35+
36+
This cmdlet returns the list of existing connections. It can also return the configuration details for a given connection.
37+
38+
## EXAMPLES
39+
40+
### Example 1
41+
```powershell
42+
PS C:\> Get-CsTeamsShiftsConnection | Format-List
43+
```
44+
```output
45+
ConnectorId : 6A51B888-FF44-4FEA-82E1-839401E00000
46+
ConnectorSpecificSettingAdminApiUrl : https://www.contoso.com/retail/data/wfmadmin/api/v1-beta3
47+
ConnectorSpecificSettingApiUrl :
48+
ConnectorSpecificSettingAppKey :
49+
ConnectorSpecificSettingClientId :
50+
ConnectorSpecificSettingCookieAuthUrl : https://www.contoso.com/retail/data/login
51+
ConnectorSpecificSettingEssApiUrl : https://www.contoso.com/retail/data/wfmess/api/v1-beta2
52+
ConnectorSpecificSettingFederatedAuthUrl : https://www.contoso.com/retail/data/login
53+
ConnectorSpecificSettingRetailWebApiUrl : https://www.contoso.com/retail/data/retailwebapi/api/v1
54+
ConnectorSpecificSettingSiteManagerUrl : https://www.contoso.com/retail/data/wfmsm/api/v1-beta4
55+
ConnectorSpecificSettingSsoUrl :
56+
CreatedDateTime : 24/03/2023 04:58:23
57+
Etag : "5b00dd1b-0000-0400-0000-641d2df00000"
58+
Id : 4dae9db0-0841-412c-8d6b-f5684bfebdd7
59+
LastModifiedDateTime : 24/03/2023 04:58:23
60+
Name : My connection 1
61+
TenantId : dfd24b34-ccb0-47e1-bdb7-000000000000
62+
63+
ConnectorId : 95BF2848-2DDA-4425-B0EE-D62AEED4C0A0
64+
ConnectorSpecificSettingAdminApiUrl :
65+
ConnectorSpecificSettingApiUrl : https://www.contoso.com/api
66+
ConnectorSpecificSettingAppKey :
67+
ConnectorSpecificSettingClientId : Es5Q2fB4PXweCyto6Ms6J2kRB7uwAc3W
68+
ConnectorSpecificSettingCookieAuthUrl :
69+
ConnectorSpecificSettingEssApiUrl :
70+
ConnectorSpecificSettingFederatedAuthUrl :
71+
ConnectorSpecificSettingRetailWebApiUrl :
72+
ConnectorSpecificSettingSiteManagerUrl :
73+
ConnectorSpecificSettingSsoUrl : https://www.contoso.com/sso
74+
CreatedDateTime : 06/04/2023 11:05:39
75+
Etag : "3100fd6e-0000-0400-0000-642ea7840000"
76+
Id : a2d1b091-5140-4dd2-987a-98a8b5338744
77+
LastModifiedDateTime : 06/04/2023 11:05:39
78+
Name : My connection 2
79+
TenantId : dfd24b34-ccb0-47e1-bdb7-000000000000
80+
```
81+
82+
83+
Returns the list of connections.
84+
85+
### Example 2
86+
```powershell
87+
PS C:\> $connection = Get-CsTeamsShiftsConnection -ConnectionId a2d1b091-5140-4dd2-987a-98a8b5338744
88+
PS C:\> $connection.ToJsonString()
89+
```
90+
```output
91+
{
92+
"connectorSpecificSettings": {
93+
"apiUrl": "https://www.contoso.com/api",
94+
"ssoUrl": "https://www.contoso.com/sso",
95+
"clientId": "Es5Q2fB4PXweCyto6Ms6J2kRB7uwAc3W"
96+
},
97+
"id": "a2d1b091-5140-4dd2-987a-98a8b5338744",
98+
"tenantId": "dfd24b34-ccb0-47e1-bdb7-000000000000",
99+
"connectorId": "95BF2848-2DDA-4425-B0EE-D62AEED4C0A0",
100+
"name": "My connection 2",
101+
"etag": "\"3100fd6e-0000-0400-0000-642ea7840000\"",
102+
"createdDateTime": "2023-04-06T11:05:39.8790000Z",
103+
"lastModifiedDateTime": "2023-04-06T11:05:39.8790000Z"
104+
}
105+
```
106+
Returns the connection with the specified -ConnectionId.
107+
108+
109+
## PARAMETERS
110+
111+
### -Break
112+
Wait for .NET debugger to attach.
113+
114+
```yaml
115+
Type: SwitchParameter
116+
Parameter Sets: (All)
117+
Aliases:
118+
119+
Required: False
120+
Position: Named
121+
Default value: None
122+
Accept pipeline input: False
123+
Accept wildcard characters: False
124+
```
125+
126+
### -ConnectionId
127+
The connection ID.
128+
129+
```yaml
130+
Type: String
131+
Parameter Sets: Get1
132+
Aliases:
133+
134+
Required: True
135+
Position: Named
136+
Default value: None
137+
Accept pipeline input: False
138+
Accept wildcard characters: False
139+
```
140+
141+
### -HttpPipelineAppend
142+
SendAsync Pipeline Steps to be appended to the front of the pipeline.
143+
144+
```yaml
145+
Type: SendAsyncStep[]
146+
Parameter Sets: (All)
147+
Aliases:
148+
149+
Required: False
150+
Position: Named
151+
Default value: None
152+
Accept pipeline input: False
153+
Accept wildcard characters: False
154+
```
155+
156+
### -HttpPipelinePrepend
157+
SendAsync Pipeline Steps to be prepended to the front of the pipeline.
158+
159+
```yaml
160+
Type: SendAsyncStep[]
161+
Parameter Sets: (All)
162+
Aliases:
163+
164+
Required: False
165+
Position: Named
166+
Default value: None
167+
Accept pipeline input: False
168+
Accept wildcard characters: False
169+
```
170+
171+
### -InputObject
172+
Identity Parameter.
173+
174+
```yaml
175+
Type: IConfigApiBasedCmdletsIdentity
176+
Parameter Sets: GetViaIdentity
177+
Aliases:
178+
179+
Required: True
180+
Position: Named
181+
Default value: None
182+
Accept pipeline input: True (ByValue)
183+
Accept wildcard characters: False
184+
```
185+
186+
### -Proxy
187+
The URI for the proxy server to use.
188+
189+
```yaml
190+
Type: Uri
191+
Parameter Sets: (All)
192+
Aliases:
193+
194+
Required: False
195+
Position: Named
196+
Default value: None
197+
Accept pipeline input: False
198+
Accept wildcard characters: False
199+
```
200+
201+
### -ProxyCredential
202+
Credentials for a proxy server to use for the remote call.
203+
204+
```yaml
205+
Type: PSCredential
206+
Parameter Sets: (All)
207+
Aliases:
208+
209+
Required: False
210+
Position: Named
211+
Default value: None
212+
Accept pipeline input: False
213+
Accept wildcard characters: False
214+
```
215+
216+
### -ProxyUseDefaultCredentials
217+
Use the default credentials for the proxy.
218+
219+
```yaml
220+
Type: SwitchParameter
221+
Parameter Sets: (All)
222+
Aliases:
223+
224+
Required: False
225+
Position: Named
226+
Default value: None
227+
Accept pipeline input: False
228+
Accept wildcard characters: False
229+
```
230+
231+
### CommonParameters
232+
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).
233+
234+
## INPUTS
235+
236+
### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity
237+
238+
## OUTPUTS
239+
240+
### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IWfmConnectionResponse
241+
242+
### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorDetailsResponse
243+
244+
## NOTES
245+
246+
## RELATED LINKS
247+
248+
[New-CsTeamsShiftsConnection](New-CsTeamsShiftsConnection.md)
249+
250+
[Set-CsTeamsShiftsConnection](Set-CsTeamsShiftsConnection.md)
251+
252+
[Update-CsTeamsShiftsConnection](Update-CsTeamsShiftsConnection.md)

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

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,21 @@ This cmdlet shows the available list of Shifts Connectors that can be used to sy
2929

3030
### Example 1
3131
```powershell
32-
PS C:\> Get-CsTeamsShiftsConnectionConnector
32+
PS C:\> Get-CsTeamsShiftsConnectionConnector | Format-List
3333
```
3434
```
35-
Id Name SupportedScenario Version WfiSupportedScenario
36-
-- ---- ----------------- ------- --------------------
37-
6A51B888-FF44-4FEA-82E1-839401E9CD74 Contoso V1 {Shift, SwapRequest, UserShiftPreferences, OpenShift...} 2020.3 - 2021.1 {SwapRequest, OpenShiftRequest, TimeOffRequest}
35+
Id : 6A51B888-FF44-4FEA-82E1-839401E9CD74
36+
Name : Contoso V1
37+
SupportedSyncScenarioOfferShiftRequest : {Disabled, FromWfmToShifts, TwoWay}
38+
SupportedSyncScenarioOpenShift : {Disabled, FromWfmToShifts}
39+
SupportedSyncScenarioOpenShiftRequest : {Disabled, FromWfmToShifts, TwoWay}
40+
SupportedSyncScenarioShift : {Disabled, FromWfmToShifts}
41+
SupportedSyncScenarioSwapRequest : {Disabled, FromWfmToShifts, TwoWay}
42+
SupportedSyncScenarioTimeCard : {Disabled, FromWfmToShifts, TwoWay}
43+
SupportedSyncScenarioTimeOff : {Disabled, FromWfmToShifts}
44+
SupportedSyncScenarioTimeOffRequest : {Disabled, FromWfmToShifts, TwoWay}
45+
SupportedSyncScenarioUserShiftPreference : {Disabled, FromWfmToShifts, TwoWay}
46+
Version : 2020.3 - 2021.1
3847
```
3948
Get the list of Shifts Connectors available on the tenant.
4049

@@ -51,6 +60,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
5160

5261
## RELATED LINKS
5362

63+
[New-CsTeamsShiftsConnection](New-CsTeamsShiftsConnection.md)
64+
5465
[New-CsTeamsShiftsConnectionInstance](New-CsTeamsShiftsConnectionInstance.md)
5566

5667
[Set-CsTeamsShiftsConnectionInstance](Set-CsTeamsShiftsConnectionInstance.md)

0 commit comments

Comments
 (0)