Skip to content

Commit 7a2e691

Browse files
tiburdtiburd
authored
Merge pull request #10893 from t-alqawlaqa/t-alqawlaqa/cmdletStates
Updating Official Docs to Reflect New Field in Connection and Connection Instance: State
2 parents 4bdff11 + 9530148 commit 7a2e691

8 files changed

+129
-20
lines changed

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ Etag : "5b00dd1b-0000-0400-0000-641d2df00000
5858
Id : 4dae9db0-0841-412c-8d6b-f5684bfebdd7
5959
LastModifiedDateTime : 24/03/2023 04:58:23
6060
Name : My connection 1
61+
State : Active
6162
TenantId : dfd24b34-ccb0-47e1-bdb7-000000000000
6263
6364
ConnectorId : 95BF2848-2DDA-4425-B0EE-D62AEED4C0A0
@@ -76,6 +77,7 @@ Etag : "3100fd6e-0000-0400-0000-642ea7840000
7677
Id : a2d1b091-5140-4dd2-987a-98a8b5338744
7778
LastModifiedDateTime : 06/04/2023 11:05:39
7879
Name : My connection 2
80+
State : Active
7981
TenantId : dfd24b34-ccb0-47e1-bdb7-000000000000
8082
```
8183

@@ -100,7 +102,8 @@ PS C:\> $connection.ToJsonString()
100102
"name": "My connection 2",
101103
"etag": "\"3100fd6e-0000-0400-0000-642ea7840000\"",
102104
"createdDateTime": "2023-04-06T11:05:39.8790000Z",
103-
"lastModifiedDateTime": "2023-04-06T11:05:39.8790000Z"
105+
"lastModifiedDateTime": "2023-04-06T11:05:39.8790000Z",
106+
"state": "Active"
104107
}
105108
```
106109
Returns the connection with the specified -ConnectionId.

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ Etag : "4f00c221-0000-0400-0000-642ff6480000"
5858
Id : WCI-b58d7a98-ab2c-473f-99a5-e0627d54c062
5959
LastModifiedDateTime : 07/04/2023 10:53:59
6060
Name : My connection instance 1
61+
State : Active
6162
SyncFrequencyInMin : 10
6263
SyncScenarioOfferShiftRequest : FromWfmToShifts
6364
SyncScenarioOpenShift : FromWfmToShifts
@@ -80,6 +81,7 @@ Etag : "4f005d22-0000-0400-0000-642ff64a0000"
8081
Id : WCI-eba2865f-6cac-46f9-8733-e0631a4536e1
8182
LastModifiedDateTime : 07/04/2023 10:54:01
8283
Name : My connection instance 2
84+
State : Active
8385
SyncFrequencyInMin : 30
8486
SyncScenarioOfferShiftRequest : FromWfmToShifts
8587
SyncScenarioOpenShift : FromWfmToShifts
@@ -126,7 +128,8 @@ PS C:\> $ci.ToJsonString()
126128
"workforceIntegrationId": "WFI_6b225907-b476-4d40-9773-08b86db7b11b",
127129
"etag": "\"4f005d22-0000-0400-0000-642ff64a0000\"",
128130
"createdDateTime": "2023-04-07T10:54:01.8170000Z",
129-
"lastModifiedDateTime": "2023-04-07T10:54:01.8170000Z"
131+
"lastModifiedDateTime": "2023-04-07T10:54:01.8170000Z",
132+
"state": "Active"
130133
}
131134
```
132135
Returns the connection instance with the specified -ConnectorInstanceId.

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

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ New-CsTeamsShiftsConnection -Body <IWfmConnectionRequest> [-Authorization <strin
2323

2424
### NewExpanded
2525
```
26-
New-CsTeamsShiftsConnection -ConnectorId <string> -ConnectorSpecificSettings <IWfmConnectionRequestConnectorSpecificSettings> -Name <string> [-Authorization <string>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <uri>] [-ProxyCredential <pscredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>]
26+
New-CsTeamsShiftsConnection -ConnectorId <string> -ConnectorSpecificSettings <IWfmConnectionRequestConnectorSpecificSettings> -Name <string> -State <string> [-Authorization <string>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <uri>] [-ProxyCredential <pscredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>]
2727
```
2828

2929
## DESCRIPTION
@@ -47,7 +47,8 @@ PS C:\> $result = New-CsTeamsShiftsConnection `
4747
federatedAuthUrl = "https://contoso.com/retail/data/login"
4848
LoginUserName = "PlaceholderForUsername"
4949
LoginPwd = "PlaceholderForPassword"
50-
})
50+
}) `
51+
-state "Active"
5152
PS C:\> $result | Format-List
5253
```
5354

@@ -69,6 +70,7 @@ Etag : "5b00dd1b-0000-0400-0000-641d2df00000
6970
Id : 4dae9db0-0841-412c-8d6b-f5684bfebdd7
7071
LastModifiedDateTime : 24/03/2023 04:58:23
7172
Name : Cmdlet test connection
73+
State : Active
7274
TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876
7375
}
7476
```
@@ -98,7 +100,8 @@ PS C:\> $result = New-CsTeamsShiftsConnection `
98100
clientSecret = "PlaceholderForClientSecret"
99101
LoginUserName = "PlaceholderForUsername"
100102
LoginPwd = "PlaceholderForPassword"
101-
})
103+
}) `
104+
-state "Active"
102105
PS C:\> $result | Format-List
103106
```
104107

@@ -119,6 +122,7 @@ Etag : "3100fd6e-0000-0400-0000-642ea7840000
119122
Id : a2d1b091-5140-4dd2-987a-98a8b5338744
120123
LastModifiedDateTime : 06/04/2023 11:05:39
121124
Name : Cmdlet test connection
125+
State : Active
122126
TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876
123127
```
124128

@@ -289,6 +293,21 @@ Accept pipeline input: False
289293
Accept wildcard characters: False
290294
```
291295
296+
### -State
297+
The state of the connection. Valid values are "Active" and "Disabled". A third value, "ErrorDisabled", signifies an error in the connection.
298+
299+
```yaml
300+
Type: String
301+
Parameter Sets: NewExpanded
302+
Aliases:
303+
304+
Required: True
305+
Position: Named
306+
Default value: None
307+
Accept pipeline input: False
308+
Accept wildcard characters: False
309+
```
310+
292311
### -WhatIf
293312
Shows what would happen if the cmdlet runs.
294313
The cmdlet is not run.

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

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ New-CsTeamsShiftsConnectionInstance -Body <IConnectorInstanceRequest> [-Break] [
2323

2424
### NewExpanded
2525
```
26-
New-CsTeamsShiftsConnectionInstance [-ConnectionId <string>] [-ConnectorAdminEmail <string[]>] [-DesignatedActorId <string>] [-Name <string>] [-SyncFrequencyInMin <int>] [-SyncScenarioOfferShiftRequest <string>][-SyncScenarioOpenShift <string>] [-SyncScenarioOpenShiftRequest <string>] [-SyncScenarioShift <string>] [-SyncScenarioSwapRequest <string>] [-SyncScenarioTimeCard <string>] [-SyncScenarioTimeOff <string>][-SyncScenarioTimeOffRequest <string>] [-SyncScenarioUserShiftPreference <string>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <uri>] [-ProxyCredential <pscredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>]
26+
New-CsTeamsShiftsConnectionInstance [-ConnectionId <string>] [-ConnectorAdminEmail <string[]>] [-DesignatedActorId <string>] [-Name <string>] [-State <string>] [-SyncFrequencyInMin <int>] [-SyncScenarioOfferShiftRequest <string>][-SyncScenarioOpenShift <string>] [-SyncScenarioOpenShiftRequest <string>] [-SyncScenarioShift <string>] [-SyncScenarioSwapRequest <string>] [-SyncScenarioTimeCard <string>] [-SyncScenarioTimeOff <string>][-SyncScenarioTimeOffRequest <string>] [-SyncScenarioUserShiftPreference <string>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <uri>] [-ProxyCredential <pscredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>]
2727
```
2828

2929
## DESCRIPTION
@@ -40,6 +40,7 @@ PS C:\> $result = New-CsTeamsShiftsConnectionInstance `
4040
-name "Cmdlet test instance" `
4141
-connectorAdminEmail @("[email protected]", "[email protected]") `
4242
-designatedActorId "93f85765-47db-412d-8f06-9844718762a1" `
43+
-State "Active" `
4344
-syncFrequencyInMin "10" `
4445
-SyncScenarioOfferShiftRequest "FromWfmToShifts" `
4546
-SyncScenarioOpenShift "FromWfmToShifts" `
@@ -77,7 +78,8 @@ PS C:\> $result.ToJsonString()
7778
"workforceIntegrationId": "WFI_6b225907-b476-4d40-9773-08b86db7b11b",
7879
"etag": "\"4f005d22-0000-0400-0000-642ff64a0000\"",
7980
"createdDateTime": "2023-04-07T10:54:01.8170000Z",
80-
"lastModifiedDateTime": "2023-04-07T10:54:01.8170000Z"
81+
"lastModifiedDateTime": "2023-04-07T10:54:01.8170000Z",
82+
"state": "Active"
8183
}
8284
```
8385

@@ -392,6 +394,20 @@ Accept pipeline input: False
392394
Accept wildcard characters: False
393395
```
394396
397+
### -State
398+
The state of the connection instance. Valid values are "Active" and "Disabled". A third value, "ErrorDisabled", signifies an error in the connection instance.
399+
400+
```yaml
401+
Type: String
402+
Parameter Sets: NewExpanded
403+
Aliases:
404+
Required: True
405+
Position: Named
406+
Default value: None
407+
Accept pipeline input: False
408+
Accept wildcard characters: False
409+
```
410+
395411
### -SyncFrequencyInMin
396412
The sync frequency in minutes.
397413

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

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,12 @@ Set-CsTeamsShiftsConnection -ConnectionId <string> -Body <IUpdateWfmConnectionRe
2323

2424
### SetExpanded
2525
```
26-
Set-CsTeamsShiftsConnection -ConnectionId <string> [-Authorization <string>] [-IfMatch <string>] [-ConnectorId <string>] [-ConnectorSpecificSettings <IUpdateWfmConnectionRequestConnectorSpecificSettings>] [-Etag <string>] [-Name <string>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <uri>] [-ProxyCredential <pscredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>]
26+
Set-CsTeamsShiftsConnection -ConnectionId <string> [-Authorization <string>] [-IfMatch <string>] [-ConnectorId <string>] [-ConnectorSpecificSettings <IUpdateWfmConnectionRequestConnectorSpecificSettings>] [-Etag <string>] [-Name <string>] [-State <string>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <uri>] [-ProxyCredential <pscredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>]
2727
```
2828

2929
### SetViaIdentityExpanded
3030
```
31-
Set-CsTeamsShiftsConnection -InputObject <IConfigApiBasedCmdletsIdentity> [-Authorization <string>] [-IfMatch <string>] [-ConnectorId <string>] [-ConnectorSpecificSettings <IUpdateWfmConnectionRequestConnectorSpecificSettings>] [-Etag <string>] [-Name <string>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <uri>] [-ProxyCredential <pscredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>]
31+
Set-CsTeamsShiftsConnection -InputObject <IConfigApiBasedCmdletsIdentity> [-Authorization <string>] [-IfMatch <string>] [-ConnectorId <string>] [-ConnectorSpecificSettings <IUpdateWfmConnectionRequestConnectorSpecificSettings>] [-Etag <string>] [-Name <string>] [-State <string>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <uri>] [-ProxyCredential <pscredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>]
3232
```
3333

3434
### SetViaIdentity
@@ -61,7 +61,8 @@ PS C:\> $result = Set-CsTeamsShiftsConnection `
6161
federatedAuthUrl = "https://contoso.com/retail/data/login"
6262
LoginUserName = "PlaceholderForUsername"
6363
LoginPwd = "PlaceholderForPassword"
64-
})
64+
}) `
65+
-state "Active"
6566
6667
PS C:\> $result | Format-List
6768
```
@@ -84,6 +85,7 @@ Etag : "5b00dd1b-0000-0400-0000-641d2df00000
8485
Id : 4dae9db0-0841-412c-8d6b-f5684bfebdd7
8586
LastModifiedDateTime : 24/03/2023 04:58:23
8687
Name : Cmdlet test connection - updated
88+
State : Active
8789
TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876
8890
8991
```
@@ -116,7 +118,8 @@ PS C:\> $result = Set-CsTeamsShiftsConnection `
116118
clientSecret = "PlaceholderForClientSecret"
117119
LoginUserName = "PlaceholderForUsername"
118120
LoginPwd = "PlaceholderForPassword"
119-
})
121+
}) `
122+
-state "Active"
120123
PS C:\> $result | Format-List
121124
```
122125

@@ -138,6 +141,7 @@ Etag : "3100fd6e-0000-0400-0000-642ea7840000
138141
Id : a2d1b091-5140-4dd2-987a-98a8b5338744
139142
LastModifiedDateTime : 06/04/2023 11:05:39
140143
Name : Cmdlet test connection - updated
144+
State : Active
141145
TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876
142146
143147
```
@@ -349,6 +353,21 @@ Accept pipeline input: False
349353
Accept wildcard characters: False
350354
```
351355
356+
### -State
357+
The state of the connection. Valid values are "Active" and "Disabled". A third value, "ErrorDisabled", signifies an error in the connection.
358+
359+
```yaml
360+
Type: String
361+
Parameter Sets: SetExpanded, SetViaIdentityExpanded
362+
Aliases:
363+
364+
Required: True
365+
Position: Named
366+
Default value: None
367+
Accept pipeline input: False
368+
Accept wildcard characters: False
369+
```
370+
352371
### -WhatIf
353372
Shows what would happen if the cmdlet runs.
354373
The cmdlet is not run.

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

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,12 @@ Set-CsTeamsShiftsConnectionInstance -ConnectorInstanceId <string> -IfMatch <stri
2323

2424
### SetExpanded
2525
```
26-
Set-CsTeamsShiftsConnectionInstance -ConnectorInstanceId <string> -IfMatch <string> [-ConnectionId <string>] [-ConnectorAdminEmail <string[]>] [-DesignatedActorId <string>] [-Etag <string>] [-Name <string>] [-SyncFrequencyInMin <int>] [-SyncScenarioOfferShiftRequest <string>] [-SyncScenarioOpenShift <string>] [-SyncScenarioOpenShiftRequest <string>] [-SyncScenarioShift <string>] [-SyncScenarioSwapRequest <string>] [-SyncScenarioTimeCard <string>] [-SyncScenarioTimeOff <string>] [-SyncScenarioTimeOffRequest <string>] [-SyncScenarioUserShiftPreference <string>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <uri>] [-ProxyCredential <pscredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>]
26+
Set-CsTeamsShiftsConnectionInstance -ConnectorInstanceId <string> -IfMatch <string> [-ConnectionId <string>] [-ConnectorAdminEmail <string[]>] [-DesignatedActorId <string>] [-Etag <string>] [-Name <string>] [-State <string>] [-SyncFrequencyInMin <int>] [-SyncScenarioOfferShiftRequest <string>] [-SyncScenarioOpenShift <string>] [-SyncScenarioOpenShiftRequest <string>] [-SyncScenarioShift <string>] [-SyncScenarioSwapRequest <string>] [-SyncScenarioTimeCard <string>] [-SyncScenarioTimeOff <string>] [-SyncScenarioTimeOffRequest <string>] [-SyncScenarioUserShiftPreference <string>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <uri>] [-ProxyCredential <pscredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>]
2727
```
2828

2929
### SetViaIdentityExpanded
3030
```
31-
Set-CsTeamsShiftsConnectionInstance -InputObject <IConfigApiBasedCmdletsIdentity> -IfMatch <string> [-ConnectionId <string>] [-ConnectorAdminEmail <string[]>] [-DesignatedActorId <string>] [-Etag <string>] [-Name <string>] [-SyncFrequencyInMin <int>] [-SyncScenarioOfferShiftRequest <string>] [-SyncScenarioOpenShift <string>] [-SyncScenarioOpenShiftRequest <string>] [-SyncScenarioShift <string>] [-SyncScenarioSwapRequest <string>] [-SyncScenarioTimeCard <string>] [-SyncScenarioTimeOff <string>] [-SyncScenarioTimeOffRequest <string>] [-SyncScenarioUserShiftPreference <string>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <uri>] [-ProxyCredential <pscredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>]
31+
Set-CsTeamsShiftsConnectionInstance -InputObject <IConfigApiBasedCmdletsIdentity> -IfMatch <string> [-ConnectionId <string>] [-ConnectorAdminEmail <string[]>] [-DesignatedActorId <string>] [-Etag <string>] [-Name <string>] [-State <string>] [-SyncFrequencyInMin <int>] [-SyncScenarioOfferShiftRequest <string>] [-SyncScenarioOpenShift <string>] [-SyncScenarioOpenShiftRequest <string>] [-SyncScenarioShift <string>] [-SyncScenarioSwapRequest <string>] [-SyncScenarioTimeCard <string>] [-SyncScenarioTimeOff <string>] [-SyncScenarioTimeOffRequest <string>] [-SyncScenarioUserShiftPreference <string>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <uri>] [-ProxyCredential <pscredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>]
3232
```
3333

3434
### SetViaIdentity
@@ -53,6 +53,7 @@ PS C:\> $result = Set-CsTeamsShiftsConnectionInstance `
5353
-name "Cmdlet test instance - updated" `
5454
-connectorAdminEmail @() `
5555
-designatedActorId "93f85765-47db-412d-8f06-9844718762a1" `
56+
-State "Active" `
5657
-syncFrequencyInMin "10" `
5758
-SyncScenarioOfferShiftRequest "FromWfmToShifts" `
5859
-SyncScenarioOpenShift "FromWfmToShifts" `
@@ -92,7 +93,8 @@ PS C:\> $result.ToJsonString()
9293
"workforceIntegrationId": "WFI_6b225907-b476-4d40-9773-08b86db7b11b",
9394
"etag": "\"4f005d22-0000-0400-0000-642ff64a0000\"",
9495
"createdDateTime": "2023-04-07T10:54:01.8170000Z",
95-
"lastModifiedDateTime": "2023-04-07T10:54:01.8170000Z"
96+
"lastModifiedDateTime": "2023-04-07T10:54:01.8170000Z",
97+
"state": "Active"
9698
}
9799
98100
```
@@ -445,6 +447,20 @@ Accept pipeline input: False
445447
Accept wildcard characters: False
446448
```
447449
450+
### -State
451+
The state of the connection instance. Valid values are "Active" and "Disabled". A third value, "ErrorDisabled", signifies an error in the connection instance.
452+
453+
```yaml
454+
Type: String
455+
Parameter Sets: SetExpanded, SetViaIdentityExpanded
456+
Aliases:
457+
Required: True
458+
Position: Named
459+
Default value: None
460+
Accept pipeline input: False
461+
Accept wildcard characters: False
462+
```
463+
448464
### -SyncFrequencyInMin
449465
The sync frequency in minutes.
450466

0 commit comments

Comments
 (0)