Start-BTSync

NAME Start-BTSync



SYNOPSIS

Start Sync operations for Power365 Users.





SYNTAX

Start-BTSync -User <object> [-Project <object>] [-Session <Session>] [<CommonParameters>]



Start-BTSync -Wave <object> [-Project <object>] [-Session <Session>] [<CommonParameters>]



Start-BTSync [-InputObject] <object> [-Project <object>] [-Session <Session>] [<CommonParameters>]





DESCRIPTION

Start-BTSync -User starts a Sync operation for a User.



Start-BTSync -Wave starts a Sync operation for a Wave.



Start-BTSync -InputObject starts a Sync operation for a User or Wave.



The ApiKey role must be 'Writer' to run the Start-BTSync cmdlet.





PARAMETERS

-User <object>

User identity: UserId, Uid, SamAccountName, Mail, UserPrincipalName, DisplayName, or User object.



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Wave <object>

Wave identity: WaveId, WaveName, or Wave object.



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-InputObject <object>

The User or Wave object.



Required? true

Position? 0

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Project <object>

Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's

default Project, if any.



Required? false

Position? named

Default value System.Object

Accept pipeline input? false

Accept wildcard characters? false



-Session <Session>

The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

System.Object

The User or Wave object.





OUTPUTS



---------- EXAMPLE 1 ----------



Start-BTSync -User 356

Start-BTSync -User joe@contoso.com

Start-BTSync -User $user

Starts a Sync for a User by id, identity, or User object.



---------- EXAMPLE 2 ----------



Start-BTSync -Wave 356

Start-BTSync -Wave 'My Wave'

Start-BTSync -Wave $wave

Starts a Sync for a Wave by id, identity, or Wave object.



---------- EXAMPLE 3 ----------



$usersOrWaves | Start-BTSync

Starts a Sync for each input object, which can be a User or a Wave object.





RELATED LINKS