Set-CsTeamsShiftsConnection

Reference

Module:: MicrosoftTeamsPowerShell

This cmdlet sets an existing workforce management (WFM) connection.

Syntax

Set-CsTeamsShiftsConnection
   -ConnectionId <string>
   -Body <IUpdateWfmConnectionRequest>
   [-Authorization <string>]
   [-IfMatch <string>]
   [-Break]
   [-HttpPipelineAppend <SendAsyncStep[]>]
   [-HttpPipelinePrepend <SendAsyncStep[]>]
   [-Proxy <uri>]
   [-ProxyCredential <pscredential>]
   [-ProxyUseDefaultCredentials]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

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>]

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>]

Set-CsTeamsShiftsConnection
   -InputObject <IConfigApiBasedCmdletsIdentity>
   -Body <IUpdateWfmConnectionRequest>
   [-Authorization <string>]
   [-IfMatch <string>]
   [-Break]
   [-HttpPipelineAppend <SendAsyncStep[]>]
   [-HttpPipelinePrepend <SendAsyncStep[]>]
   [-Proxy <uri>]
   [-ProxyCredential <pscredential>]
   [-ProxyUseDefaultCredentials]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

This cmdlet updates a Shifts WFM connection. It allows the admin to make changes to the settings such as the name and WFM URLs. Note that the update allows for, but does not require, the -ConnectorSpecificSettings.LoginPwd and ConnectorSpecificSettings.LoginUserName to be included. This cmdlet can update every input field except -ConnectorId and -ConnectionId.

Examples

Example 1

PS C:\> $connection = Get-CsTeamsShiftsConnection -ConnectionId 4dae9db0-0841-412c-8d6b-f5684bfebdd7
PS C:\> $result =  Set-CsTeamsShiftsConnection `
   -connectionId $connection.Id `
   -IfMatch $connection.Etag `
   -connectorId "6A51B888-FF44-4FEA-82E1-839401E00000" `
   -name "Cmdlet test connection - updated" `
   -connectorSpecificSettings (New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificBlueYonderSettingsRequest `
        -Property @{
            adminApiUrl = "https://contoso.com/retail/data/wfmadmin/api/v1-beta2"
            siteManagerUrl = "https://contoso.com/retail/data/wfmsm/api/v1-beta2"
            essApiUrl = "https://contoso.com/retail/data/wfmess/api/v1-beta1"
            retailWebApiUrl = "https://contoso.com/retail/data/retailwebapi/api/v1"
            cookieAuthUrl = "https://contoso.com/retail/data/login"
            federatedAuthUrl = "https://contoso.com/retail/data/login"
            LoginUserName = "PlaceholderForUsername"
            LoginPwd = "PlaceholderForPassword"
    }) `
    -state "Active"

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 instance with the specified -ConnectionId. Returns the object of the updated connection.

In case of an error, you can capture the error response as follows:

Hold the cmdlet output in a variable: $result=<CMDLET>
To get the entire error message in Json: $result.ToJsonString()
To get the error object and object details: $result, $result.Detail

Example 2

PS C:\> $connection = Get-CsTeamsShiftsConnection -ConnectionId 79964000-286a-4216-ac60-c795a426d61a
PS C:\> $result =  Set-CsTeamsShiftsConnection `
   -connectionId $connection.Id `
   -IfMatch $connection.Etag `
   -connectorId "95BF2848-2DDA-4425-B0EE-D62AEED4C0A0" `
   -name "Cmdlet test connection - updated" `
   -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"
            LoginUserName = "PlaceholderForUsername"
            LoginPwd = "PlaceholderForPassword"
    }) `
    -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                                       : a2d1b091-5140-4dd2-987a-98a8b5338744
LastModifiedDateTime                     : 06/04/2023 11:05:39
Name                                     : Cmdlet test connection - updated
State                                    : Active
TenantId                                 : 3FDCAAF2-863A-4520-97BA-DFA211595876

Updates the instance with the specified -ConnectionId. Returns the object of the updated connection.

In case of an error, you can capture the error response as follows:

Hold the cmdlet output in a variable: $result=<CMDLET>
To get the entire error message in Json: $result.ToJsonString()
To get the error object and object details: $result, $result.Detail

Parameters

-Body

The request body.

Type:	IUpdateWfmConnectionRequest
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Break

Wait for .NET debugger to attach.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

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

-ConnectionId

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

-ConnectorSpecificSettings

The connector-specific settings.

Type:	IUpdateWfmConnectionRequestConnectorSpecificSettings
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-HttpPipelineAppend

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

-HttpPipelinePrepend

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

-IfMatch

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

-InputObject

Identity Parameter.

Type:	IConfigApiBasedCmdletsIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

The connection name.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Proxy

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

-ProxyCredential

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

-ProxyUseDefaultCredentials

Use the default credentials for the proxy.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-State

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

-WhatIf

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

Inputs

Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity

Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IUpdateWfmConnectionRequest

Outputs

Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IWfmConnectionResponse

Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorDetailsResponse

Set-CsTeamsShiftsConnection

Syntax

Description

Examples

Example 1

Example 2

Parameters

-Body

-Break

-Confirm

-ConnectionId

-ConnectorSpecificSettings

-HttpPipelineAppend

-HttpPipelinePrepend

-IfMatch

-InputObject

-Name

-Proxy

-ProxyCredential

-ProxyUseDefaultCredentials

-State

-WhatIf

Inputs

Outputs

Feedback

Feedback

Additional resources

Set-CsTeamsShiftsConnection

Syntax

Description

Examples

Example 1

Example 2

Parameters

-Body

-Break

-Confirm

-ConnectionId

-ConnectorSpecificSettings

-HttpPipelineAppend

-HttpPipelinePrepend

-IfMatch

-InputObject

-Name

-Proxy

-ProxyCredential

-ProxyUseDefaultCredentials

-State

-WhatIf

Inputs

Outputs

Related Links

Feedback

Feedback

Additional resources