Get-BTPrepare

NAME Get-BTPrepare



SYNOPSIS

Returns the statuses of Power365 Prepare operations.





SYNTAX

Get-BTPrepare [-Identity] <object> [-Project <object>] [-Session <Session>] [<CommonParameters>]



Get-BTPrepare [-Filter <string>] [-Limit <int>] [-Project <object>] [-Session <Session>] [-User <object>] [-Wave

<object>] [<CommonParameters>]





DESCRIPTION

Get-BTPrepare -Identity returns the Prepare identified by its PrepareJobId, or a Prepare object.



Get-BTPrepare [-Project] [-Wave] [-User] [-Filter] [-Limit] returns Prepares matching selection criteria.



The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTProject cmdlet.





PARAMETERS

-Identity <object>

Prepare identity: PrepareJobId, or Prepare 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



-Wave <object>

Filter by Wave, specified by WaveId, WaveName, or Wave object.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-User <object>

Filter by User, specified by UserId, UPN, Email, or User object.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Filter <string>

Filter expression. The filter is in OPath syntax, such as "PercentComplete -eq 100". The supported properties

are PrepareJobId, UserId, IsComplete, Started, Completed, PercentComplete, and TotalTimeSeconds.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Limit <int>

Limit the number of returned items.



Required? false

Position? named

Default value 0

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

Prepare identity: PrepareJobId, or Prepare object.





OUTPUTS

BinaryTree.Power365.SDK.PrepareJob





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



Get-BTPrepare -Identity 986

Get-BTPrepare -Identity $prepare

Returns a Prepare by PrepareJobId, or a Prepare object.



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



Get-BTPrepare

Returns all Prepares.



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



Get-BTPrepare -User joe@contoso.com -Filter "IsComplete -eq true" -Limit 10

Returns the most recent 10 Prepares for the specified User where IsComplete is true.





RELATED LINKS