Update-CsTeamsShiftsConnectionInstance
This cmdlet updates Shifts connection instance fields.
Update-CsTeamsShiftsConnectionInstance
-ConnectorInstanceId <string>
-IfMatch <string>
-Body <IUpdateConnectorInstanceFieldsRequest>
[-Break][-HttpPipelineAppend <SendAsyncStep[]>]
[-HttpPipelinePrepend <SendAsyncStep[]>]
[-Proxy <uri>]
[-ProxyCredential <pscredential>][-ProxyUseDefaultCredentials]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-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>]
Update-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>]
Update-CsTeamsShiftsConnectionInstance
-InputObject <IConfigApiBasedCmdletsIdentity>
-IfMatch <string>
-Body <IUpdateConnectorInstanceFieldsRequest>
[-Break]
[-HttpPipelineAppend <SendAsyncStep[]>]
[-HttpPipelinePrepend <SendAsyncStep[]>]
[-Proxy <uri>]
[-ProxyCredential <pscredential>]
[-ProxyUseDefaultCredentials]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
This cmdlet updates a Shifts connection instance. Similar to the Set-CsTeamsShiftsConnectionInstance cmdlet, it allows the admin to make changes to the settings in the instance such as name, enabled scenarios, and sync frequency. The complete list of fields is not required allowing the user to update single fields of the instance.
PS C:\> $connectionInstance = Get-CsTeamsShiftsConnectionInstance -ConnectorInstanceId WCI-eba2865f-6cac-46f9-8733-e0631a4536e1
PS C:\> $result = Update-CsTeamsShiftsConnectionInstance `
-connectorInstanceId "WCI-eba2865f-6cac-46f9-8733-e0631a4536e1"
-IfMatch $connectionInstance.Etag `
-connectionId "79964000-286a-4216-ac60-c795a426d61a" `
-name "Cmdlet test instance - updated" `
-syncFrequencyInMin "30" `
PS C:\> $result.ToJsonString()
{
"syncScenarios": {
"offerShiftRequest": "FromWfmToShifts",
"openShift": "FromWfmToShifts",
"openShiftRequest": "FromWfmToShifts",
"shift": "FromWfmToShifts",
"swapRequest": "FromWfmToShifts",
"timeCard": "FromWfmToShifts",
"timeOff": "FromWfmToShifts",
"timeOffRequest": "FromWfmToShifts",
"userShiftPreferences": "Disabled"
},
"id": "WCI-eba2865f-6cac-46f9-8733-e0631a4536e1",
"tenantId": "dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a",
"connectionId": "a2d1b091-5140-4dd2-987a-98a8b5338744",
"connectorAdminEmails": [ ],
"connectorId": "95BF2848-2DDA-4425-B0EE-D62AEED4C0A0",
"designatedActorId": "ec1a4edb-1a5f-4b2d-b2a4-37aab6ebd231",
"name": "Cmdlet test instance - updated",
"syncFrequencyInMin": 30,
"workforceIntegrationId": "WFI_6b225907-b476-4d40-9773-08b86db7b11b",
"etag": "\"4f005d22-0000-0400-0000-642ff64a0000\"",
"createdDateTime": "2023-04-07T10:54:01.8170000Z",
"lastModifiedDateTime": "2023-04-07T10:54:01.8170000Z",
"state" : "Active"
}
Updates the instance with the specified -ConnectorInstanceId with the given name and sync frequency. Returns the object of the updated connector instance.
The request body.
Type: | IUpdateConnectorInstanceFieldsRequest |
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: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Gets or sets the list of connector admin email addresses.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The connector instance ID.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The designated actor ID that App acts as for Shifts Graph API calls.
Type: | String |
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 instance. Valid values are "Active" and "Disabled". A third value, "ErrorDisabled", signifies an error in the connection instance.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The sync frequency in minutes.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay".
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay".
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The sync state for the open shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay".
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay".
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The sync state for the shift swap request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay".
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay".
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay".
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay".
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The sync state for the user shift preferences scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay".
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.IUpdateConnectorInstanceFieldsRequest
Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConnectorInstanceResponse
Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorDetailsResponse