Update-CsTeamsShiftsConnection
This cmdlet updates an existing workforce management (WFM) connection.
Update-CsTeamsShiftsConnection
-ConnectionId <string>
-Body <IUpdateWfmConnectionFieldsRequest>
[-Authorization <string>]
[-IfMatch <string>]
[-Break]
[-HttpPipelineAppend <SendAsyncStep[]>]
[-HttpPipelinePrepend <SendAsyncStep[]>]
[-Proxy <uri>]
[-ProxyCredential <pscredential>]
[-ProxyUseDefaultCredentials]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-CsTeamsShiftsConnection
-ConnectionId <string>
[-Authorization <string>]
[-IfMatch <string>]
[-ConnectorId <string>]
[-ConnectorSpecificSettings <IUpdateWfmConnectionFieldsRequestConnectorSpecificSettings>]
[-Etag <string>]
[-Name <string>]
[-State <string>]
[-Break]
[-HttpPipelineAppend <SendAsyncStep[]>]
[-HttpPipelinePrepend <SendAsyncStep[]>]
[-Proxy <uri>][-ProxyCredential <pscredential>]
[-ProxyUseDefaultCredentials]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-CsTeamsShiftsConnection
-InputObject <IConfigApiBasedCmdletsIdentity>
[-Authorization <string>]
[-IfMatch <string>]
[-ConnectorId <string>]
[-ConnectorSpecificSettings <IUpdateWfmConnectionFieldsRequestConnectorSpecificSettings>]
[-Etag <string>]
[-Name <string>]
[-State <string>]
[-Break]
[-HttpPipelineAppend <SendAsyncStep[]>]
[-HttpPipelinePrepend <SendAsyncStep[]>]
[-Proxy <uri>]
[-ProxyCredential <pscredential>]
[-ProxyUseDefaultCredentials]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-CsTeamsShiftsConnection
-InputObject <IConfigApiBasedCmdletsIdentity>
-Body <IUpdateWfmConnectionFieldsRequest>
[-Authorization <string>]
[-IfMatch <string>]
[-Break]
[-HttpPipelineAppend <SendAsyncStep[]>]
[-HttpPipelinePrepend <SendAsyncStep[]>]
[-Proxy <uri>]
[-ProxyCredential <pscredential>]
[-ProxyUseDefaultCredentials]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
This cmdlet updates a Shifts WFM connection. Similar to the Set-CsTeamsShiftsConnection cmdlet, it allows the admin to make changes to the settings in the connection. The complete list of fields is not required allowing the user to update single fields of the connection.
PS C:\> $connection = Get-CsTeamsShiftsConnection -ConnectionId 4dae9db0-0841-412c-8d6b-f5684bfebdd7
PS C:\> $result = Update-CsTeamsShiftsConnection `
-connectionId $connection.Id `
-IfMatch $connection.Etag `
-name "Cmdlet test connection - updated" `
PS C:\> $result | Format-List
ConnectorId : 6A51B888-FF44-4FEA-82E1-839401E00000
ConnectorSpecificSettingAdminApiUrl : https://www.contoso.com/retail/data/wfmadmin/api/v1-beta2
ConnectorSpecificSettingApiUrl :
ConnectorSpecificSettingAppKey :
ConnectorSpecificSettingClientId :
ConnectorSpecificSettingCookieAuthUrl : https://www.contoso.com/retail/data/login
ConnectorSpecificSettingEssApiUrl : https://www.contoso.com/retail/data/wfmess/api/v1-beta2
ConnectorSpecificSettingFederatedAuthUrl : https://www.contoso.com/retail/data/login
ConnectorSpecificSettingRetailWebApiUrl : https://www.contoso.com/retail/data/retailwebapi/api/v1
ConnectorSpecificSettingSiteManagerUrl : https://www.contoso.com/retail/data/wfmsm/api/v1-beta2
ConnectorSpecificSettingSsoUrl :
CreatedDateTime : 24/03/2023 04:58:23
Etag : "5b00dd1b-0000-0400-0000-641d2df00000"
Id : 4dae9db0-0841-412c-8d6b-f5684bfebdd7
LastModifiedDateTime : 24/03/2023 04:58:23
Name : Cmdlet test connection - updated
State : Active
TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876
Updates the connection with the specified -ConnectionId with the given name. Returns the object of the updated connection.
PS C:\> $connection = Get-CsTeamsShiftsConnection -ConnectionId 79964000-286a-4216-ac60-c795a426d61a
PS C:\> $result = Update-CsTeamsShiftsConnection `
-connectionId $connection.Id `
-IfMatch $connection.Etag `
-connectorId "95BF2848-2DDA-4425-B0EE-D62AEED4C0A0" `
-connectorSpecificSettings (New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificUkgDimensionsSettingsRequest `
-Property @{
apiUrl = "https://www.contoso.com/api"
ssoUrl = "https://www.contoso.com/sso"
appKey = "PlaceholderForAppKey"
clientId = "Es5Q2fB4PXweCyto6Ms6J2kRB7uwAc3W"
clientSecret = "PlaceholderForClientSecret"
}) `
-state "Active"
PS C:\> $result | Format-List
ConnectorId : 95BF2848-2DDA-4425-B0EE-D62AEED4C0A0
ConnectorSpecificSettingAdminApiUrl :
ConnectorSpecificSettingApiUrl : https://www.contoso.com/api
ConnectorSpecificSettingAppKey :
ConnectorSpecificSettingClientId : Es5Q2fB4PXweCyto6Ms6J2kRB7uwAc3W
ConnectorSpecificSettingCookieAuthUrl :
ConnectorSpecificSettingEssApiUrl :
ConnectorSpecificSettingFederatedAuthUrl :
ConnectorSpecificSettingRetailWebApiUrl :
ConnectorSpecificSettingSiteManagerUrl :
ConnectorSpecificSettingSsoUrl : https://www.contoso.com/sso
CreatedDateTime : 06/04/2023 11:05:39
Etag : "3100fd6e-0000-0400-0000-642ea7840000"
Id : 79964000-286a-4216-ac60-c795a426d61a
LastModifiedDateTime : 06/04/2023 11:05:39
Name : Cmdlet test connection
State : Active
TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876
Updates the connection with the specified -ConnectionId with the given settings. Returns the object of the updated connection.
Used to provide the necessary credentials for authenticating and authorizing the connection to the workforce management (WFM) system. This parameter ensures that the connection has the appropriate permissions to access and manage the data within the WFM system.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The request body.
Type: | IUpdateWfmConnectionFieldsRequest |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Wait for the .NET debugger to attach.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The WFM connection ID for the instance. This can be retrieved by running Get-CsTeamsShiftsConnection.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Used to specify the unique identifier of the connector being used for the connection.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Used to specify settings that are unique to the connector being used. This parameter allows administrators to configure various properties specific to the workforce management (WFM) system they are integrating with Teams Shifts.
Type: | IUpdateWfmConnectionFieldsRequestConnectorSpecificSettings |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Used to manage concurrency control. It helps ensure that updates to a Shifts connection instance are only applied if the instance has not been modified since it was last retrieved. This is particularly useful in preventing conflicts when multiple administrators might be making changes simultaneously.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
SendAsync Pipeline Steps to be appended to the front of the pipeline.
Type: | SendAsyncStep[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
SendAsync Pipeline Steps to be prepended to the front of the pipeline.
Type: | SendAsyncStep[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The value of the ETag field as returned by the cmdlets.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Identity Parameter
Type: | IConfigApiBasedCmdletsIdentity |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
The connector instance name.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The URI for the proxy server to use.
Type: | Uri |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Credentials for a proxy server to use for the remote call.
Type: | PSCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Use the default credentials for the proxy.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The state of the connection. Valid values are "Active" and "Disabled". A third value, "ErrorDisabled", signifies an error in the connection.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity
Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IUpdateWfmConnectionFieldsRequest
Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IWfmConnectionResponse
Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorDetailsResponse