BinaryTree.Power365.Cmdlet.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <!-- Cmdlet: Get-BTCutover --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-BTCutover</command:name> <command:verb>Get</command:verb> <command:noun>BTCutover</command:noun> <maml:description> <maml:para>Returns the statuses of Power365 Cutover operations.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-BTCutover -Identity returns the Cutover identified by its CutoverJobId, or a Cutover object.</maml:para> <maml:para>Get-BTCutover [-Project] [-Wave] [-User] [-Filter] [-Limit] returns Cutovers matching selection criteria.</maml:para> <maml:para>The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTProject cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Get-BTCutover</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Cutover identity: CutoverJobId, or Cutover object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByFilter --> <command:syntaxItem> <maml:name>Get-BTCutover</maml:name> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "PercentComplete -eq 100". The supported properties are CutoverJobId, UserId, CutoverState, DSCutoverState, IsComplete, Started, Completed, PercentComplete, and TotalTimeSeconds.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: User --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>Filter by User, specified by UserId, UPN, Email, or User object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Wave --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Wave</maml:name> <maml:description> <maml:para>Filter by Wave, specified by WaveId, WaveName, or Wave object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Cutover identity: CutoverJobId, or Cutover object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Wave --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Wave</maml:name> <maml:description> <maml:para>Filter by Wave, specified by WaveId, WaveName, or Wave object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: User --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>Filter by User, specified by UserId, UPN, Email, or User object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "PercentComplete -eq 100". The supported properties are CutoverJobId, UserId, CutoverState, DSCutoverState, IsComplete, Started, Completed, PercentComplete, and TotalTimeSeconds.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Cutover identity: CutoverJobId, or Cutover object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: CutoverJob --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.CutoverJob</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Get-BTCutover -Identity 986</maml:para> <maml:para>Get-BTCutover -Identity $cutover</maml:para> <maml:para>Returns a Cutover by CutoverJobId, or a Cutover object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get-BTCutover</maml:para> <maml:para>Returns all Cutovers.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Get-BTCutover -User joe@contoso.com -Filter "IsComplete -eq true" -Limit 10</maml:para> <maml:para>Returns the most recent 10 Cutovers for the specified User where IsComplete is true.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Start-BTCutover --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Start-BTCutover</command:name> <command:verb>Start</command:verb> <command:noun>BTCutover</command:noun> <maml:description> <maml:para>Start Cutover operations for Power365 Users.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Start-BTCutover -User starts a Cutover operation for a User.</maml:para> <maml:para>Start-BTCutover -Wave starts a Cutover operation for a Wave.</maml:para> <maml:para>Start-BTCutover -InputObject starts a Cutover operation for a User or Wave.</maml:para> <maml:para>The ApiKey role must be 'Writer' to run the Start-BTCutover cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByUser --> <command:syntaxItem> <maml:name>Start-BTCutover</maml:name> <!-- Parameter: User --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>User identity: UserId, Uid, SamAccountName, Mail, UserPrincipalName, DisplayName, or User object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByWave --> <command:syntaxItem> <maml:name>Start-BTCutover</maml:name> <!-- Parameter: Wave --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Wave</maml:name> <maml:description> <maml:para>Wave identity: WaveId, WaveName, or Wave object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByInputObject --> <command:syntaxItem> <maml:name>Start-BTCutover</maml:name> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The User or Wave object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: User --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>User identity: UserId, Uid, SamAccountName, Mail, UserPrincipalName, DisplayName, or User object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Wave --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Wave</maml:name> <maml:description> <maml:para>Wave identity: WaveId, WaveName, or Wave object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The User or Wave object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The User or Wave object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Start-BTCutover -User 356</maml:para> <maml:para>Start-BTCutover -User joe@contoso.com</maml:para> <maml:para>Start-BTCutover -User $user</maml:para> <maml:para>Starts a Cutover for a User by id, identity, or User object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Start-BTCutover -Wave 356</maml:para> <maml:para>Start-BTCutover -Wave 'My Wave'</maml:para> <maml:para>Start-BTCutover -Wave $wave</maml:para> <maml:para>Starts a Cutover for a Wave by id, identity, or Wave object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>$usersOrWaves | Start-BTCutover</maml:para> <maml:para>Starts a Cutover for each input object, which can be a User or a Wave object.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Submit-BTCutoverMessage --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Submit-BTCutoverMessage</command:name> <command:verb>Submit</command:verb> <command:noun>BTCutoverMessage</command:noun> <maml:description> <maml:para>Submits Cutover messages for Power365 Users.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Submit-BTCutoverMessage -User submits a Cutover message for a User.</maml:para> <maml:para>Submit-BTCutoverMessage -InputObject submits a Cutover message for a User.</maml:para> <maml:para>The ApiKey role must be 'Writer' to run the Submit-BTCutoverMessage cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByUser --> <command:syntaxItem> <maml:name>Submit-BTCutoverMessage</maml:name> <!-- Parameter: User --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>User identity: UserId, Uid, SamAccountName, Mail, UserPrincipalName, DisplayName, or User object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByInputObject --> <command:syntaxItem> <maml:name>Submit-BTCutoverMessage</maml:name> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The User object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: User --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>User identity: UserId, Uid, SamAccountName, Mail, UserPrincipalName, DisplayName, or User object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The User object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The User object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Submit-BTCutoverMessage -User 356</maml:para> <maml:para>Submit-BTCutoverMessage -User joe@contoso.com</maml:para> <maml:para>Submit-BTCutoverMessage -User $user</maml:para> <maml:para>Submits a BTCutoverMessage for a User by id, identity, or User object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>$users | Submit-BTCutoverMessage</maml:para> <maml:para>Submits a Cutover message for each input object, which can be a User object.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Start-BTDiscovery --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Start-BTDiscovery</command:name> <command:verb>Start</command:verb> <command:noun>BTDiscovery</command:noun> <maml:description> <maml:para>Starts a Power365 Discovery operation for the specified environment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Start-BTDiscovery -Identity starts Discovery of an Environment identified by the TenantId, or Environment object.</maml:para> <maml:para>Start-BTDiscovery [-DiscoveryDeltaTimestamp] starts Discovery of an Environment for objects with changes after the specified DateTime.</maml:para> <maml:para>The ApiKey role must be 'Writer' to run the Start-BTDiscovery cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Start-BTDiscovery</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Environment identity: TenantId, TenantName, TenantGuid, or Environment object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DiscoveryDeltaTimestamp --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiscoveryDeltaTimestamp</maml:name> <maml:description> <maml:para>Limits the scope of the discovery to objects changed after the DiscoveryDeltaTimestamp.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Environment identity: TenantId, TenantName, TenantGuid, or Environment object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DiscoveryDeltaTimestamp --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiscoveryDeltaTimestamp</maml:name> <maml:description> <maml:para>Limits the scope of the discovery to objects changed after the DiscoveryDeltaTimestamp.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Environment identity: TenantId, TenantName, TenantGuid, or Environment object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Environment --> <command:returnValue> <dev:type> <maml:name>System.Environment</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Start-BTDiscovery -Identity 986</maml:para> <maml:para>Start-BTDiscovery -Identity $environment</maml:para> <maml:para>Starts Discovery of an Environment by TenantId, TenantName, TenantGuid, or Environment object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Start-BTDiscovery -Identity $environment -DiscoveryDeltaTimestamp $changedAfterDateTime</maml:para> <maml:para>Starts Discovery of an Environment for items that have changes newer than $changedAfterDateTime</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-BTEnvironment --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-BTEnvironment</command:name> <command:verb>Get</command:verb> <command:noun>BTEnvironment</command:noun> <maml:description> <maml:para>Returns the statuses of Power365 Environments.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-BTEnvironment -Identity returns the Environment identified by its TenantId, TenantName, TenantGuid or a Environment object.</maml:para> <maml:para>Get-BTEnvironment [-Filter] [-Limit] returns Environment matching selection criteria.</maml:para> <maml:para>The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTEnvironment cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Get-BTEnvironment</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Environment identity: TenantId, TenantName, TenantGuid, or Environment object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByFilter --> <command:syntaxItem> <maml:name>Get-BTEnvironment</maml:name> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "TenantName -like 'My*'". The supported properties are TenantId, TenantName, TenantGuid, DiscoveryFrequencyHours, T2TPowerShellUsername, PFPowerShellUsername, SkipUserDiscovery, IsHybrid, IsConnected, DiscoveryDeltaTimestamp, DiscoveryStarted, DiscoveryFinished, DiscoveryState.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Environment identity: TenantId, TenantName, TenantGuid, or Environment object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "TenantName -like 'My*'". The supported properties are TenantId, TenantName, TenantGuid, DiscoveryFrequencyHours, T2TPowerShellUsername, PFPowerShellUsername, SkipUserDiscovery, IsHybrid, IsConnected, DiscoveryDeltaTimestamp, DiscoveryStarted, DiscoveryFinished, DiscoveryState.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Environment identity: TenantId, TenantName, TenantGuid, or Environment object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Environment --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.Models.Environment</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Get-BTEnvironment -Identity 986</maml:para> <maml:para>Get-BTEnvironment -Identity $environment</maml:para> <maml:para>Returns a Environment by TenantId, TenantName, TenantGuid, or an Environment object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get-BTEnvironment</maml:para> <maml:para>Returns all Environments.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Get-BTEnvironment -Identity $environment -Filter "IsConnected -eq true" -Limit 10</maml:para> <maml:para>Returns the first 10 Environments where IsConnected is true.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-BTEnvironment --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-BTEnvironment</command:name> <command:verb>Set</command:verb> <command:noun>BTEnvironment</command:noun> <maml:description> <maml:para>Updates Power365 Environment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Set-BTEnvironment -Identity [-SkipUserDiscovery] sets the Environment to Skip User Discovery.</maml:para> <maml:para>Set-BTEnvironment -Identity [-DiscoveryFrequencyHours] sets the Environment Discovery Frequency.</maml:para> <maml:para>Set-BTEnvironment -Identity [-DiscoveryState] sets the Environment Discovery State to Enabled or Disabled.</maml:para> <maml:para>The ApiKey role must be 'Writer' to run the Set-BTEnvironment cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-BTEnvironment</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Environment identity: TenantId, TenantName, or Environment object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DiscoveryFrequencyHours --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiscoveryFrequencyHours</maml:name> <maml:description> <maml:para>How often to perform discovery.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DiscoveryState --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiscoveryState</maml:name> <maml:description> <maml:para>New Discovery state: Enabled or Disabled</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SkipUserDiscovery --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SkipUserDiscovery</maml:name> <maml:description> <maml:para>Skip Discovery of users.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Environment identity: TenantId, TenantName, or Environment object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DiscoveryState --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiscoveryState</maml:name> <maml:description> <maml:para>New Discovery state: Enabled or Disabled</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SkipUserDiscovery --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SkipUserDiscovery</maml:name> <maml:description> <maml:para>Skip Discovery of users.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DiscoveryFrequencyHours --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiscoveryFrequencyHours</maml:name> <maml:description> <maml:para>How often to perform discovery.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Environment identity: TenantId, TenantName, or Environment object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Environment --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.Models.Environment</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Set-BTEnvironment -Identity $environment -SkipUserDiscovery $true</maml:para> <maml:para>Set the Environment SkipUserDiscovery flag.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Set-BTEnvironment -Identity 'Tenant XYZ' -DiscoveryFrequencyHours 12</maml:para> <maml:para>Sets the Environment Discovery Frequency to 12 hours.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Set-BTEnvironment -Identity 983 -DiscoveryState Disabled</maml:para> <maml:para>sets the Environment Discovery State to Disabled.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-BTLog --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-BTLog</command:name> <command:verb>Get</command:verb> <command:noun>BTLog</command:noun> <maml:description> <maml:para>Returns Power365 Prepare, Sync, Cutover, or Environment Discovery Logs.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-BTLog -Identity <id> -Prepare returns Prepare Logs.</maml:para> <maml:para>Get-BTLog -Identity <id> -Sync returns Sync Logs.</maml:para> <maml:para>Get-BTLog -Identity <id> -Cutover returns Cutover Logs.</maml:para> <maml:para>Get-BTLog -Identity <id> -Discovery returns Environment Discovery Logs.</maml:para> <maml:para>Get-BTLog -Identity <object> returns Logs for the specified Prepare, Sync, Cutover, or Environment object.</maml:para> <maml:para>The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTLog cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Get-BTLog</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Identity: PrepareJobId/SyncJobId/CutoverJobId/TenantId or Prepare/Sync/Cutover/Environment object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Levels --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Levels</maml:name> <maml:description> <maml:para>Filter by level(s): Error, Warn, Info, Debug, and/or Trace.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByPrepare --> <command:syntaxItem> <maml:name>Get-BTLog</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Identity: PrepareJobId/SyncJobId/CutoverJobId/TenantId or Prepare/Sync/Cutover/Environment object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Prepare --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Prepare</maml:name> <maml:description> <maml:para>Identity is a PrepareJobId.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Levels --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Levels</maml:name> <maml:description> <maml:para>Filter by level(s): Error, Warn, Info, Debug, and/or Trace.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: BySync --> <command:syntaxItem> <maml:name>Get-BTLog</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Identity: PrepareJobId/SyncJobId/CutoverJobId/TenantId or Prepare/Sync/Cutover/Environment object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Sync --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Sync</maml:name> <maml:description> <maml:para>Identity is a SyncJobId.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Levels --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Levels</maml:name> <maml:description> <maml:para>Filter by level(s): Error, Warn, Info, Debug, and/or Trace.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByCutover --> <command:syntaxItem> <maml:name>Get-BTLog</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Identity: PrepareJobId/SyncJobId/CutoverJobId/TenantId or Prepare/Sync/Cutover/Environment object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Cutover --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Cutover</maml:name> <maml:description> <maml:para>Identity is a CutoverJobId.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Levels --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Levels</maml:name> <maml:description> <maml:para>Filter by level(s): Error, Warn, Info, Debug, and/or Trace.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByEnvironment --> <command:syntaxItem> <maml:name>Get-BTLog</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Identity: PrepareJobId/SyncJobId/CutoverJobId/TenantId or Prepare/Sync/Cutover/Environment object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Discovery --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Discovery</maml:name> <maml:description> <maml:para>Identity is a TenantId.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Levels --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Levels</maml:name> <maml:description> <maml:para>Filter by level(s): Error, Warn, Info, Debug, and/or Trace.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Identity: PrepareJobId/SyncJobId/CutoverJobId/TenantId or Prepare/Sync/Cutover/Environment object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Prepare --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Prepare</maml:name> <maml:description> <maml:para>Identity is a PrepareJobId.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Sync --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Sync</maml:name> <maml:description> <maml:para>Identity is a SyncJobId.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Cutover --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Cutover</maml:name> <maml:description> <maml:para>Identity is a CutoverJobId.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Discovery --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Discovery</maml:name> <maml:description> <maml:para>Identity is a TenantId.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Levels --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Levels</maml:name> <maml:description> <maml:para>Filter by level(s): Error, Warn, Info, Debug, and/or Trace.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Identity: PrepareJobId/SyncJobId/CutoverJobId/TenantId or Prepare/Sync/Cutover/Environment object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: PSObject --> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Get-BTLog -Identity 355 -Prepare</maml:para> <maml:para>Get-BTLog -Identity 356 -Sync</maml:para> <maml:para>Get-BTLog -Identity 357 -Cutover</maml:para> <maml:para>Get-BTLog -Identity 368 -Discovery</maml:para> <maml:para>Returns Logs for a Prepare, Sync, Cutover, or Environment by id.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get-BTLog -Identity $prepare</maml:para> <maml:para>Get-BTLog -Identity $sync</maml:para> <maml:para>Get-BTLog -Identity $cutover</maml:para> <maml:para>Get-BTLog -Identity $environment</maml:para> <maml:para>Returns Logs for a Prepare, Sync, Cutover, or Environment by object.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-BTPrepare --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-BTPrepare</command:name> <command:verb>Get</command:verb> <command:noun>BTPrepare</command:noun> <maml:description> <maml:para>Returns the statuses of Power365 Prepare operations.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-BTPrepare -Identity returns the Prepare identified by its PrepareJobId, or a Prepare object.</maml:para> <maml:para>Get-BTPrepare [-Project] [-Wave] [-User] [-Filter] [-Limit] returns Prepares matching selection criteria.</maml:para> <maml:para>The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTProject cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Get-BTPrepare</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Prepare identity: PrepareJobId, or Prepare object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByFilter --> <command:syntaxItem> <maml:name>Get-BTPrepare</maml:name> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "PercentComplete -eq 100". The supported properties are PrepareJobId, UserId, PrepareState, IsComplete, Started, Completed, PercentComplete, and TotalTimeSeconds.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: User --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>Filter by User, specified by UserId, UPN, Email, or User object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Wave --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Wave</maml:name> <maml:description> <maml:para>Filter by Wave, specified by WaveId, WaveName, or Wave object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Prepare identity: PrepareJobId, or Prepare object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Wave --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Wave</maml:name> <maml:description> <maml:para>Filter by Wave, specified by WaveId, WaveName, or Wave object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: User --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>Filter by User, specified by UserId, UPN, Email, or User object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "PercentComplete -eq 100". The supported properties are PrepareJobId, UserId, PrepareState, IsComplete, Started, Completed, PercentComplete, and TotalTimeSeconds.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Prepare identity: PrepareJobId, or Prepare object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: PrepareJob --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.PrepareJob</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Get-BTPrepare -Identity 986</maml:para> <maml:para>Get-BTPrepare -Identity $prepare</maml:para> <maml:para>Returns a Prepare by PrepareJobId, or a Prepare object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get-BTPrepare</maml:para> <maml:para>Returns all Prepares.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Get-BTPrepare -User joe@contoso.com -Filter "IsComplete -eq true" -Limit 10</maml:para> <maml:para>Returns the most recent 10 Prepares for the specified User where IsComplete is true.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Start-BTPrepare --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Start-BTPrepare</command:name> <command:verb>Start</command:verb> <command:noun>BTPrepare</command:noun> <maml:description> <maml:para>Start Prepare operations for Power365 Users.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Start-BTPrepare -User starts a Prepare operation for a User.</maml:para> <maml:para>Start-BTPrepare -Wave starts a Prepare operation for a Wave.</maml:para> <maml:para>Start-BTPrepare -InputObject starts a Prepare operation for a User or Wave.</maml:para> <maml:para>The ApiKey role must be 'Writer' to run the Start-BTPrepare cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByUser --> <command:syntaxItem> <maml:name>Start-BTPrepare</maml:name> <!-- Parameter: User --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>User identity: UserId, Uid, SamAccountName, Mail, UserPrincipalName, DisplayName, or User object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByWave --> <command:syntaxItem> <maml:name>Start-BTPrepare</maml:name> <!-- Parameter: Wave --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Wave</maml:name> <maml:description> <maml:para>Wave identity: WaveId, WaveName, or Wave object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByInputObject --> <command:syntaxItem> <maml:name>Start-BTPrepare</maml:name> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The User or Wave object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: User --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>User identity: UserId, Uid, SamAccountName, Mail, UserPrincipalName, DisplayName, or User object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Wave --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Wave</maml:name> <maml:description> <maml:para>Wave identity: WaveId, WaveName, or Wave object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The User or Wave object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The User or Wave object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Start-BTPrepare -User 356</maml:para> <maml:para>Start-BTPrepare -User joe@contoso.com</maml:para> <maml:para>Start-BTPrepare -User $user</maml:para> <maml:para>Starts a Prepare for a User by id, identity, or User object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Start-BTPrepare -Wave 356</maml:para> <maml:para>Start-BTPrepare -Wave 'My Wave'</maml:para> <maml:para>Start-BTPrepare -Wave $wave</maml:para> <maml:para>Starts a Prepare for a Wave by id, identity, or Wave object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>$usersOrWaves | Start-BTPrepare</maml:para> <maml:para>Starts a Prepare for each input object, which can be a User or a Wave object.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-BTProfile --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-BTProfile</command:name> <command:verb>Get</command:verb> <command:noun>BTProfile</command:noun> <maml:description> <maml:para>Returns Power365 Profiles.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-BTProfile -Identity returns the Profile identified by its ProfileId, ProfileName, or a Profile object.</maml:para> <maml:para>Get-BTProfile [-Project] [-Filter] [-Limit] returns Profiles matching selection criteria.</maml:para> <maml:para>The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTProfile cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Get-BTProfile</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Profile identity: ProfileId, ProfileName, or Profile object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByFilter --> <command:syntaxItem> <maml:name>Get-BTProfile</maml:name> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "ProfileName -like 'My*'". The supported properties are CutoverNotificationBody, CutoverNotificationSubject, CutoverOutlookAgentEnabled, CutoverOutlookAgentSilent, CutoverSkipNoticeODB, CutoverSkipPermissionsFinalSync, CutoverSkipPermissionsInitialSync, CutoverSkipPermissionsNormalSync, CutoverWaitsOnOutlookAgent, ErrorFolderThreshold, ErrorFolderThresholdODB, ErrorItemThreshold, ErrorItemThresholdODB, FilterCalendarMaxAgeDays, FilterCalendarNotAfter, FilterCalendarNotBefore, FilterCalendarType, FilterMailMaxAgeDays, FilterMailNotAfter, FilterMailNotBefore, FilterMailType, FilterNotesMaxAgeDays, FilterNotesNotAfter, FilterNotesNotBefore, FilterNotesType, FilterSizeMaxMB, FilterSizeType, FilterTasksMaxAgeDays, FilterTasksNotAfter, FilterTasksNotBefore, FilterTasksType, IsDefault, LastUpdate, LicensingMode, LicensingSKU, LicensingSKUTeams, MigrateArchiveMailbox, MigrateAutomaticReplies, MigrateContacts, MigrateDeletedItems, MigrateLitHolds, MigrateOneDriveForBusiness, MigratePlanner, MigrateRules, MigrateSignatures, OneNoteFinalSyncOnly, PrepareUnifiedGroupsAsTeams, PrepareUnifiedGroupsAndTeams, PrepareUsers, ProfileId, ProfileName, ProjectId, and ProjectName.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Profile identity: ProfileId, ProfileName, or Profile object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "ProfileName -like 'My*'". The supported properties are CutoverNotificationBody, CutoverNotificationSubject, CutoverOutlookAgentEnabled, CutoverOutlookAgentSilent, CutoverSkipNoticeODB, CutoverSkipPermissionsFinalSync, CutoverSkipPermissionsInitialSync, CutoverSkipPermissionsNormalSync, CutoverWaitsOnOutlookAgent, ErrorFolderThreshold, ErrorFolderThresholdODB, ErrorItemThreshold, ErrorItemThresholdODB, FilterCalendarMaxAgeDays, FilterCalendarNotAfter, FilterCalendarNotBefore, FilterCalendarType, FilterMailMaxAgeDays, FilterMailNotAfter, FilterMailNotBefore, FilterMailType, FilterNotesMaxAgeDays, FilterNotesNotAfter, FilterNotesNotBefore, FilterNotesType, FilterSizeMaxMB, FilterSizeType, FilterTasksMaxAgeDays, FilterTasksNotAfter, FilterTasksNotBefore, FilterTasksType, IsDefault, LastUpdate, LicensingMode, LicensingSKU, LicensingSKUTeams, MigrateArchiveMailbox, MigrateAutomaticReplies, MigrateContacts, MigrateDeletedItems, MigrateLitHolds, MigrateOneDriveForBusiness, MigratePlanner, MigrateRules, MigrateSignatures, OneNoteFinalSyncOnly, PrepareUnifiedGroupsAsTeams, PrepareUnifiedGroupsAndTeams, PrepareUsers, ProfileId, ProfileName, ProjectId, and ProjectName.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Profile identity: ProfileId, ProfileName, or Profile object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Profile --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.Profile</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Get-BTProfile -Identity 986</maml:para> <maml:para>Get-BTProfile -Identity 'My Profile'</maml:para> <maml:para>Get-BTProfile -Identity $profile</maml:para> <maml:para>Returns a Profile by ProfileId, ProfileName, or a Profile object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get-BTProfile</maml:para> <maml:para>Returns all Profiles.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Get-BTProfile -Filter "ProfileName -like 'M*' -Limit 10</maml:para> <maml:para>Returns the first 10 Profiles whose ProfileName begins with 'M'.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-BTProject --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-BTProject</command:name> <command:verb>Get</command:verb> <command:noun>BTProject</command:noun> <maml:description> <maml:para>Returns Power365 Projects.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-BTProject -Identity returns the Project identified by its ProjectId, ProjectName, or a Project object.</maml:para> <maml:para>Get-BTProject [-Filter] [-Limit] returns Projects matching selection criteria.</maml:para> <maml:para>The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTProject cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Get-BTProject</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Project identity: ProjectId, ProjectName, or Project object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByFilter --> <command:syntaxItem> <maml:name>Get-BTProject</maml:name> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "ProjectName -like 'My*'". The supported properties are ProjectId, ProjectName, and ProjectType.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Project identity: ProjectId, ProjectName, or Project object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "ProjectName -like 'My*'". The supported properties are ProjectId, ProjectName, and ProjectType.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Project identity: ProjectId, ProjectName, or Project object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Project --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.Project</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Get-BTProject -Identity 986</maml:para> <maml:para>Get-BTProject -Identity 'My Project'</maml:para> <maml:para>Get-BTProject -Identity $project</maml:para> <maml:para>Returns a Project by ProjectId, ProjectName, or a Project object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get-BTProject</maml:para> <maml:para>Returns all Projects.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Get-BTProject -Filter "ProjectName -like 'M*'" -Limit 10</maml:para> <maml:para>Returns the first 10 Projects whose ProjectName begins with 'M'.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-BTProject --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-BTProject</command:name> <command:verb>Set</command:verb> <command:noun>BTProject</command:noun> <maml:description> <maml:para>Updates a Power365 Project, or sets the default Project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Set-BTProject -Default makes the Project the default for the Session.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-BTProject</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Project identity: ProjectId, ProjectName, or Project object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Default --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Default</maml:name> <maml:description> <maml:para>Sets the default Project for the Session.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Project identity: ProjectId, ProjectName, or Project object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Default --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Default</maml:name> <maml:description> <maml:para>Sets the default Project for the Session.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Project identity: ProjectId, ProjectName, or Project object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Project --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.Project</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Set-BTProject -Identity 986 -Default</maml:para> <maml:para>Set-BTProject -Identity 'My Project' -Default</maml:para> <maml:para>Set-BTProject -Identity $project -Default</maml:para> <maml:para>Sets the default Project by ProjectId, ProjectName, or a Project object.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Connect-BTSession --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Connect-BTSession</command:name> <command:verb>Connect</command:verb> <command:noun>BTSession</command:noun> <maml:description> <maml:para>Connects to a Power365 instance. The Power365 Session remains the default until Connect-BTSession is invoked again, or -Session is specified on a cmdlet.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Connect-BTSession connects to a Power365 instance.</maml:para> <maml:para>This requires an ApiKey issued by an administrator of your Power365 account.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Connect --> <command:syntaxItem> <maml:name>Connect-BTSession</maml:name> <!-- Parameter: ApiKey --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ApiKey</maml:name> <maml:description> <maml:para>The API Key issued by an administrator of your Power365 account.</maml:para> </maml:description> <command:parameterValue required="true">SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ApiKey --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ApiKey</maml:name> <maml:description> <maml:para>The API Key issued by an administrator of your Power365 account.</maml:para> </maml:description> <command:parameterValue required="true">SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Session --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>$secureKey = Read-Host 'What is your ApiKey?' -AsSecureString</maml:para> <maml:para>Connect-BTSession -ApiKey $secureKey</maml:para> <maml:para>Returns the Power365 Session.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Disconnect-BTSession --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Disconnect-BTSession</command:name> <command:verb>Disconnect</command:verb> <command:noun>BTSession</command:noun> <maml:description> <maml:para>Disconnects from a Power365 instance.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Disconnect-BTSession disconnects from a Power365 instance.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Disconnect-BTSession</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Disonnect-BTSession</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-BTSession --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-BTSession</command:name> <command:verb>Get</command:verb> <command:noun>BTSession</command:noun> <maml:description> <maml:para>Gets the default Power365 Session.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-BTSession gets the default Power365 Session.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-BTSession</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <!-- OutputType: Session --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Get-BTSession</maml:para> <maml:para>Returns the default Power365 Session.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-BTSync --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-BTSync</command:name> <command:verb>Get</command:verb> <command:noun>BTSync</command:noun> <maml:description> <maml:para>Returns the statuses of Power365 Sync operations.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-BTSync -Identity returns the Sync identified by its SyncJobId, or a Sync object.</maml:para> <maml:para>Get-BTSync [-Project] [-Wave] [-User] [-Filter] [-Limit] returns Syncs matching selection criteria.</maml:para> <maml:para>The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTProject cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Get-BTSync</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Sync identity: SyncJobId, or Sync object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByFilter --> <command:syntaxItem> <maml:name>Get-BTSync</maml:name> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "PercentComplete -eq 100". The supported properties are SyncJobId, UserId, SyncDataType, SyncState, IsComplete, Started, Completed, PercentComplete, and TotalTimeSeconds.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: User --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>Filter by User, specified by UserId, UPN, Email, or User object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Wave --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Wave</maml:name> <maml:description> <maml:para>Filter by Wave, specified by WaveId, WaveName, or Wave object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Sync identity: SyncJobId, or Sync object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Wave --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Wave</maml:name> <maml:description> <maml:para>Filter by Wave, specified by WaveId, WaveName, or Wave object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: User --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>Filter by User, specified by UserId, UPN, Email, or User object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "PercentComplete -eq 100". The supported properties are SyncJobId, UserId, SyncDataType, SyncState, IsComplete, Started, Completed, PercentComplete, and TotalTimeSeconds.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Sync identity: SyncJobId, or Sync object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: SyncJob --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.SyncJob</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Get-BTSync -Identity 986</maml:para> <maml:para>Get-BTSync -Identity $sync</maml:para> <maml:para>Returns a Sync by SyncJobId, or a Sync object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get-BTSync</maml:para> <maml:para>Returns all Syncs.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Get-BTSync -User joe@contoso.com -Filter "IsComplete -eq true" -Limit 10</maml:para> <maml:para>Returns the most recent 10 Syncs for the specified User where IsComplete is true.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Start-BTSync --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Start-BTSync</command:name> <command:verb>Start</command:verb> <command:noun>BTSync</command:noun> <maml:description> <maml:para>Start Sync operations for Power365 Users.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Start-BTSync -User starts a Sync operation for a User.</maml:para> <maml:para>Start-BTSync -Wave starts a Sync operation for a Wave.</maml:para> <maml:para>Start-BTSync -InputObject starts a Sync operation for a User or Wave.</maml:para> <maml:para>The ApiKey role must be 'Writer' to run the Start-BTSync cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByUser --> <command:syntaxItem> <maml:name>Start-BTSync</maml:name> <!-- Parameter: User --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>User identity: UserId, Uid, SamAccountName, Mail, UserPrincipalName, DisplayName, or User object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByWave --> <command:syntaxItem> <maml:name>Start-BTSync</maml:name> <!-- Parameter: Wave --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Wave</maml:name> <maml:description> <maml:para>Wave identity: WaveId, WaveName, or Wave object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByInputObject --> <command:syntaxItem> <maml:name>Start-BTSync</maml:name> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The User or Wave object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: User --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>User identity: UserId, Uid, SamAccountName, Mail, UserPrincipalName, DisplayName, or User object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Wave --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Wave</maml:name> <maml:description> <maml:para>Wave identity: WaveId, WaveName, or Wave object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The User or Wave object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The User or Wave object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Start-BTSync -User 356</maml:para> <maml:para>Start-BTSync -User joe@contoso.com</maml:para> <maml:para>Start-BTSync -User $user</maml:para> <maml:para>Starts a Sync for a User by id, identity, or User object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Start-BTSync -Wave 356</maml:para> <maml:para>Start-BTSync -Wave 'My Wave'</maml:para> <maml:para>Start-BTSync -Wave $wave</maml:para> <maml:para>Starts a Sync for a Wave by id, identity, or Wave object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>$usersOrWaves | Start-BTSync</maml:para> <maml:para>Starts a Sync for each input object, which can be a User or a Wave object.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-BTUser --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-BTUser</command:name> <command:verb>Get</command:verb> <command:noun>BTUser</command:noun> <maml:description> <maml:para>Returns Power365 Users.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-BTUser -Identity returns the User identified by its UserId, identity, or a User object.</maml:para> <maml:para>Get-BTUser [-Filter] [-Limit] [-Project] [-Wave] returns Users matching selection criteria.</maml:para> <maml:para>The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTUser cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Get-BTUser</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>User identity: UserId, Uid, SamAccountName, Mail, UserPrincipalName, DisplayName, or a User object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByFilter --> <command:syntaxItem> <maml:name>Get-BTUser</maml:name> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "ProjectName -like 'My*'". The supported properties are ArchiveSize, DeliverToMailboxAndForward, Department, DisplayName, ErsRewriteGroup, ErsRewriteMode, HiddenFromAddressListsEnabled, IsContact, IsEquipment, IsMailbox, IsMailUser, IsRoom, IsShared, IsTeam, IsUnifiedGroup, Mail, MailNickname, MigrationState, ProfileId, ProfileName, LitigationHoldDate, LitigationHoldDuration, LitigationHoldEnabled, LitigationHoldOwner, MailboxServicePlan, MailboxSize, MatchReason, NewPrimarySmtpAddress, NewUserPrincipalName, OdbQuota, OdbServicePlan, OdbSize, OnPremisesSamAccountName, OnPremisesUserPrincipalName, OutlookState, PercentComplete, PreferredLanguage, ProjectId, ProjectName, RecipientType, RecipientTypeDetails, Region, SamAccountName, TargetMail, TargetMailNickname, TargetSamAccountName, TargetTenantId, TargetTenantName, TargetUserPrincipalName, TenantId, TenantName, Uid, UserId, UserPrincipalName, WaveId, and WaveName.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Profile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Filter by Profile, specified by ProfileId, ProfileName, or Profile object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Wave --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Wave</maml:name> <maml:description> <maml:para>Filter by Wave, specified by WaveId, WaveName, or Wave object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>User identity: UserId, Uid, SamAccountName, Mail, UserPrincipalName, DisplayName, or a User object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Wave --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Wave</maml:name> <maml:description> <maml:para>Filter by Wave, specified by WaveId, WaveName, or Wave object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Profile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Filter by Profile, specified by ProfileId, ProfileName, or Profile object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "ProjectName -like 'My*'". The supported properties are ArchiveSize, DeliverToMailboxAndForward, Department, DisplayName, ErsRewriteGroup, ErsRewriteMode, HiddenFromAddressListsEnabled, IsContact, IsEquipment, IsMailbox, IsMailUser, IsRoom, IsShared, IsTeam, IsUnifiedGroup, Mail, MailNickname, MigrationState, ProfileId, ProfileName, LitigationHoldDate, LitigationHoldDuration, LitigationHoldEnabled, LitigationHoldOwner, MailboxServicePlan, MailboxSize, MatchReason, NewPrimarySmtpAddress, NewUserPrincipalName, OdbQuota, OdbServicePlan, OdbSize, OnPremisesSamAccountName, OnPremisesUserPrincipalName, OutlookState, PercentComplete, PreferredLanguage, ProjectId, ProjectName, RecipientType, RecipientTypeDetails, Region, SamAccountName, TargetMail, TargetMailNickname, TargetSamAccountName, TargetTenantId, TargetTenantName, TargetUserPrincipalName, TenantId, TenantName, Uid, UserId, UserPrincipalName, WaveId, and WaveName.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>User identity: UserId, Uid, SamAccountName, Mail, UserPrincipalName, DisplayName, or a User object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: User --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.User</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Get-BTUser -Identity 153</maml:para> <maml:para>Get-BTUser -Identity bob.smith@contoso.com</maml:para> <maml:para>Get-BTUser -Identity 'Bob Smith'</maml:para> <maml:para>Get-BTUser -Identity $user</maml:para> <maml:para>Returns a User by UserId, identity, or a User object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get-BTUser</maml:para> <maml:para>Returns all Users.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Get-BTUser -Wave 'My Wave' -Filter "MigrationState -eq 'Ready'" -Limit 10</maml:para> <maml:para>Returns the first 10 Users in the specified Wave where MigrationState is Ready.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-BTUser --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-BTUser</command:name> <command:verb>Set</command:verb> <command:noun>BTUser</command:noun> <maml:description> <maml:para>Updates Power365 Users.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Set-BTUser -Identity -Wave sets or clears a User's Wave.</maml:para> <maml:para>Set-BTUser -Identity -Profile sets a User's Profile.</maml:para> <maml:para>Set-BTUser -Identity -MatchIdentity sets or clears a User's matching target object.</maml:para> <maml:para>Set-BTUser -Identity -MigrationState updates a User's migration state.</maml:para> <maml:para>Set-BTUser -MatchProperty sets or clears multiple Users' matching target objects.</maml:para> <maml:para>The ApiKey role must be 'Writer' to run the Set-BTUser cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-BTUser</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>User identity: UserId, Uid, SamAccountName, Mail, UserPrincipalName, DisplayName, or a User object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MatchIdentity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MatchIdentity</maml:name> <maml:description> <maml:para>Identity of matching target user: To set the matching user, specify the UserId, Uid, SamAccountName, Mail, UserPrincipalName, DisplayName, or a User object. To clear the matching user, specify $null or an empty string. Cannot be used with pipeline input.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>~NotSpecified~</dev:defaultValue> </command:parameter> <!-- Parameter: MatchProperty --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MatchProperty</maml:name> <maml:description> <maml:para>Property of input object that contains the identity of the matching target user. Can be used with pipeline input. To clear the matching user, specify "None", or specify a property of the input object whose value is an empty string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>~NotSpecified~</dev:defaultValue> </command:parameter> <!-- Parameter: MigrationState --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MigrationState</maml:name> <maml:description> <maml:para>New migration state.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Profile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>New Profile.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit identity searches to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any. Ignored if -Identity is a UserId or User object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Wave --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Wave</maml:name> <maml:description> <maml:para>New Wave, or $null to remove the user from its current Wave.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>User identity: UserId, Uid, SamAccountName, Mail, UserPrincipalName, DisplayName, or a User object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit identity searches to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any. Ignored if -Identity is a UserId or User object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Wave --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Wave</maml:name> <maml:description> <maml:para>New Wave, or $null to remove the user from its current Wave.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Profile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>New Profile.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MigrationState --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MigrationState</maml:name> <maml:description> <maml:para>New migration state.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MatchIdentity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MatchIdentity</maml:name> <maml:description> <maml:para>Identity of matching target user: To set the matching user, specify the UserId, Uid, SamAccountName, Mail, UserPrincipalName, DisplayName, or a User object. To clear the matching user, specify $null or an empty string. Cannot be used with pipeline input.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>~NotSpecified~</dev:defaultValue> </command:parameter> <!-- Parameter: MatchProperty --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MatchProperty</maml:name> <maml:description> <maml:para>Property of input object that contains the identity of the matching target user. Can be used with pipeline input. To clear the matching user, specify "None", or specify a property of the input object whose value is an empty string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>~NotSpecified~</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>User identity: UserId, Uid, SamAccountName, Mail, UserPrincipalName, DisplayName, or a User object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: User --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.User</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Set-BTUser -Identity bob.smith@contoso.com -Wave 83</maml:para> <maml:para>Set-BTUser -Identity 'Bob Smith' -Wave 'My Wave'</maml:para> <maml:para>Set-BTUser -Identity 983 -Wave $wave</maml:para> <maml:para>Set-BTUser -Identity $user -Wave $null</maml:para> <maml:para>Sets or clears the specified User's Wave.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Set-BTUser -Identity bob.smith@contoso.com -Profile 906</maml:para> <maml:para>Set-BTUser -Identity bob.smith@contoso.com -Profile 'My Profile'</maml:para> <maml:para>Set-BTUser -Identity bob.smith@contoso.com -Profile $profile</maml:para> <maml:para>Sets the specified User's Profile.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Set-BTUser -Identity bob.smith@contoso.com -MigrationState Complete</maml:para> <maml:para>Sets the specified User's migration state.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <maml:introduction> <maml:para>Set-BTUser -Identity bob.smith@contoso.com -MatchIdentity bob.smith@fabrikam.com</maml:para> <maml:para>Sets the specified User's matching target object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 5 ----------</maml:title> <maml:introduction> <maml:para>Set-BTUser -Identity bob.smith@contoso.com -MatchIdentity $null</maml:para> <maml:para>Clears the specified User's matching target object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 6 ----------</maml:title> <maml:introduction> <maml:para>Import-CSV <path> | Set-BTUser -MatchProperty TargetUserPrincipalName</maml:para> <maml:para>Sets the specified Users' matching target objects using a column from a .csv file.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 7 ----------</maml:title> <maml:introduction> <maml:para>Import-CSV <path> | Set-BTUser -MatchProperty None</maml:para> <maml:para>Clears the specified Users' matching target objects using a .csv file.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-BTWave --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-BTWave</command:name> <command:verb>Get</command:verb> <command:noun>BTWave</command:noun> <maml:description> <maml:para>Returns Power365 Waves.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-BTWave -Identity returns the Wave identified by its WaveId, WaveName, or a Wave object.</maml:para> <maml:para>Get-BTWave [-Project] [-Filter] [-Limit] returns Waves matching selection criteria.</maml:para> <maml:para>The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTWave cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Get-BTWave</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Wave identity: WaveId, WaveName, or a Wave object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByFilter --> <command:syntaxItem> <maml:name>Get-BTWave</maml:name> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "WaveName -like 'My*'". The supported properties are AdGroupName, AdGroupUid, CompleteUsers, ErrorUsers, InProgressUsers, NotReadyUsers, OtherUsers, ProjectId, ProjectName, ReadyUsers, RollbackUsers, TenantMigrationId, TotalUsers, WaveId, and WaveName.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Wave identity: WaveId, WaveName, or a Wave object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "WaveName -like 'My*'". The supported properties are AdGroupName, AdGroupUid, CompleteUsers, ErrorUsers, InProgressUsers, NotReadyUsers, OtherUsers, ProjectId, ProjectName, ReadyUsers, RollbackUsers, TenantMigrationId, TotalUsers, WaveId, and WaveName.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Wave identity: WaveId, WaveName, or a Wave object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Wave --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.Wave</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Get-BTWave -Identity 986</maml:para> <maml:para>Get-BTWave -Identity 'My Wave'</maml:para> <maml:para>Get-BTWave -Identity $wave</maml:para> <maml:para>Returns a Wave by WaveId, WaveName, or a Wave object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get-BTWave</maml:para> <maml:para>Returns all Waves.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Get-BTWave -Filter "WaveName -like 'M*'" -Limit 10</maml:para> <maml:para>Returns the first 10 Waves whose WaveName starts with 'M'.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-BTWave --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-BTWave</command:name> <command:verb>New</command:verb> <command:noun>BTWave</command:noun> <maml:description> <maml:para>Creates a new Power365 Wave.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The ApiKey role must be 'Writer' to run the New-BTWave cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-BTWave</maml:name> <!-- Parameter: WaveName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WaveName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: WaveName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WaveName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Wave --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.Wave</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>New-BTWave -DisplayName 'My Wave'</maml:para> <maml:para>Creates a new Wave with the specified name.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-BTWorkflow --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-BTWorkflow</command:name> <command:verb>Get</command:verb> <command:noun>BTWorkflow</command:noun> <maml:description> <maml:para>Returns Power365 Workflows.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-BTWorkflow -Identity returns a Workflow by WorkflowId, identity, or a Workflow object.</maml:para> <maml:para>Get-BTWorkflow [-Filter] [-Limit] returns Workflows that match selection criteria.</maml:para> <maml:para>The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTWorkflow cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Get-BTWorkflow</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Workflow identity: WorkflowId, Name, or a Workflow object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByFilter --> <command:syntaxItem> <maml:name>Get-BTWorkflow</maml:name> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "Name -like 'My*'". The supported properties are WorkflowId and Name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Workflow identity: WorkflowId, Name, or a Workflow object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "Name -like 'My*'". The supported properties are WorkflowId and Name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Workflow identity: WorkflowId, Name, or a Workflow object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Workflow --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.Workflow</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Get-BTWorkflow -Identity 107</maml:para> <maml:para>Get-BTWorkflow -Identity 'My Workflow'</maml:para> <maml:para>Get-BTWorkflow -Identity $workflow</maml:para> <maml:para>Returns a Workflow by WorkflowId, identity, or a Workflow object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get-BTWorkflow</maml:para> <maml:para>Returns all Workflows.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Get-BTWorkflow -Filter "Name -like 'M*'" -Limit 3</maml:para> <maml:para>Returns the first 3 Workflows whose Name starts with 'M'.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Start-BTWorkflow --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Start-BTWorkflow</command:name> <command:verb>Start</command:verb> <command:noun>BTWorkflow</command:noun> <maml:description> <maml:para>Start a Power365 Workflow.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Start-BTWorkflow -Identity Workflow (by object or id) cmdlet starts the specified Workflow.</maml:para> <maml:para>The ApiKey role must be 'Writer' to run the Start-BTWorkflow cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Start-BTWorkflow</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specifies the identity (as a Workflow object or id) of a Workflow to start.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specifies the identity (as a Workflow object or id) of a Workflow to start.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the identity (as a Workflow object or id) of a Workflow to start.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Workflow --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.Workflow</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Start-BTWorkflow -Identity 4296</maml:para> <maml:para>Start a Workflow.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-BTWorkflowLog --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-BTWorkflowLog</command:name> <command:verb>Get</command:verb> <command:noun>BTWorkflowLog</command:noun> <maml:description> <maml:para>Returns the Logs for a specified Power365 WorkflowRun.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-BTWorkflowLog -Identity (WorkflowRun object or id) cmdlet matches only one identity.</maml:para> <maml:para>The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTWorkflowLog cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-BTWorkflowLog</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Identity: WorkflowRunId or WorkflowRun object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "Level -eq 'Error'". The supported properties are JobLogId, Level, TimeStamp, Message, and AgentId.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Levels --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Levels</maml:name> <maml:description> <maml:para>Filter by level(s): Error, Warn, Info, Debug, and/or Trace.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Identity: WorkflowRunId or WorkflowRun object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Levels --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Levels</maml:name> <maml:description> <maml:para>Filter by level(s): Error, Warn, Info, Debug, and/or Trace.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "Level -eq 'Error'". The supported properties are JobLogId, Level, TimeStamp, Message, and AgentId.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: PSObject --> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Get-BTWorkFlowLog -Identity 4926 -Limit 10</maml:para> <maml:para>Returns the most recent 10 Logs for WorkflowRun 4926.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-BTWorkflowRun --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-BTWorkflowRun</command:name> <command:verb>Get</command:verb> <command:noun>BTWorkflowRun</command:noun> <maml:description> <maml:para>Returns Power365 WorkflowRuns.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-WorkflowRun -Identity returns a WorkflowRun by WorkflowRunId or a WorkflowRun object.</maml:para> <maml:para>Get-WorkflowRun [-Filter] [-Limit] [-Workflow] returns WorkflowRuns that match selection criteria.</maml:para> <maml:para>The ApiKey role must be 'Reader' or 'Writer' to run the Get-WorkflowRun cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Get-BTWorkflowRun</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>WorkflowRun identity: WorkflowRunId or WorkflowRun object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByFilter --> <command:syntaxItem> <maml:name>Get-BTWorkflowRun</maml:name> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "WorkflowName -like 'My*'". The supported properties are WorkflowRunId, WorkflowId, and WorkflowName.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Workflow --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Workflow</maml:name> <maml:description> <maml:para>Filter by Workflow (WorkflowId, Name, or Workflow object).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>WorkflowRun identity: WorkflowRunId or WorkflowRun object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Workflow --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Workflow</maml:name> <maml:description> <maml:para>Filter by Workflow (WorkflowId, Name, or Workflow object).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "WorkflowName -like 'My*'". The supported properties are WorkflowRunId, WorkflowId, and WorkflowName.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>WorkflowRun identity: WorkflowRunId or WorkflowRun object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: WorkflowRun --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.WorkflowRun</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Get-WorkflowRun -Identity 766</maml:para> <maml:para>Get-WorkflowRun -Identity $workflowRun</maml:para> <maml:para>Gets a WorkflowRun by WorkflowRunId or WorkflowRun object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get-WorkflowRun</maml:para> <maml:para>Returns all WorkflowRuns.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Get-WorkflowRun -Filter "WorkflowName -like 'M*'" -Limit 5</maml:para> <maml:para>Returns the 5 most recent WorkflowRuns for Workflows whose names start with 'M'.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> </helpItems> |