Modifier

Partager via

Test-CsTeamsShiftsConnectionValidate

  • Reference
Module:
MicrosoftTeamsPowerShell

This cmdlet validates workforce management (WFM) connection settings.

Syntax

Test-CsTeamsShiftsConnectionValidate
    -ConnectorId <string>
    -ConnectorSpecificSettings <IConnectorInstanceRequestConnectorSpecificSettings>
    -Name <string>
    [<CommonParameters>]

Description

This cmdlet validates Workforce management (WFM) connection settings. It validates that the provided WFM account/password and required endpoints are set correctly.

Examples

Example 1

PS C:\> $InstanceName = "test instance name"
PS C:\> $WfmUserName = "WfmUserName"
PS C:\> $plainPwd = "plainPwd"
PS C:\> Test-CsTeamsShiftsConnectionValidate -ConnectorId "6A51B888-FF44-4FEA-82E1-839401E00000" -ConnectorSpecificSettings (New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificBlueYonderSettingsRequest -Property @{ AdminApiUrl = "https://contoso.com/retail/data/wfmadmin/api/v1-beta3"; SiteManagerUrl = "https://contoso.com/retail/data/wfmsm/api/v1-beta4"; EssApiUrl = "https://contoso.com/retail/data/wfmess/api/v1-beta2"; 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" }) -Name $InstanceName

Returns the list of conflicts if there are any. Empty result means there's no conflict.

Example 2

PS C:\> $InstanceName = "test instance name"
PS C:\> $WfmUserName = "WfmUserName"
PS C:\> $plainPwd = "plainPwd"
PS C:\> Test-CsTeamsShiftsConnectionValidate -ConnectorId "6A51B888-FF44-4FEA-82E1-839401E00000" -ConnectorSpecificSettings (New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificUkgDimensionsSettingsRequest -Property @{ apiUrl = "https://contoso.com/api"; ssoUrl = "https://contoso.com/sso"; appKey = "myAppKey"; clientId = "myClientId"; clientSecret = "PlaceholderForClientSecret"; LoginUserName = "PlaceholderForUsername"; LoginPwd = "PlaceholderForPassword" }) -Name $InstanceName

Returns the list of conflicts if there are any. Empty result means there's no conflict.

Parameters

-ConnectorId

The ID of the shifts connector.

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

-ConnectorSpecificSettings

The connector specific settings.

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

-Name

The connector's instance name.

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