< Back
Get-BTWorkflowLog
Post
NAME Get-BTWorkflowLog
SYNOPSIS
Returns the Logs for a specified Power365 WorkflowRun.
SYNTAX
Get-BTWorkflowLog [-Identity] <object> [-Filter <string>] [-Levels <string[]>] [-Limit <int>] [-Session <Session>]
[<CommonParameters>]
DESCRIPTION
The Get-BTWorkflowLog -Identity (WorkflowRun object or id) cmdlet matches only one identity.
The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTWorkflowLog cmdlet.
PARAMETERS
-Identity <object>
Identity: WorkflowRunId or WorkflowRun object.
Required? true
Position? 0
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Levels <string[]>
Filter by level(s): Error, Warn, Info, Debug, and/or Trace.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Filter <string>
Filter expression. The filter is in OPath syntax, such as "Level -eq 'Error'". The supported properties are
JobLogId, Level, TimeStampUtc, Message, and AgentId.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Limit <int>
Limit the number of returned items.
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-Session <Session>
The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
System.Management.Automation.PSObject
---------- EXAMPLE 1 ----------
Get-BTWorkFlowLog -Identity 4926 -Limit 10
Returns the most recent 10 Logs for WorkflowRun 4926.
RELATED LINKS
SYNOPSIS
Returns the Logs for a specified Power365 WorkflowRun.
SYNTAX
Get-BTWorkflowLog [-Identity] <object> [-Filter <string>] [-Levels <string[]>] [-Limit <int>] [-Session <Session>]
[<CommonParameters>]
DESCRIPTION
The Get-BTWorkflowLog -Identity (WorkflowRun object or id) cmdlet matches only one identity.
The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTWorkflowLog cmdlet.
PARAMETERS
-Identity <object>
Identity: WorkflowRunId or WorkflowRun object.
Required? true
Position? 0
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Levels <string[]>
Filter by level(s): Error, Warn, Info, Debug, and/or Trace.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Filter <string>
Filter expression. The filter is in OPath syntax, such as "Level -eq 'Error'". The supported properties are
JobLogId, Level, TimeStampUtc, Message, and AgentId.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Limit <int>
Limit the number of returned items.
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-Session <Session>
The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
System.Management.Automation.PSObject
---------- EXAMPLE 1 ----------
Get-BTWorkFlowLog -Identity 4926 -Limit 10
Returns the most recent 10 Logs for WorkflowRun 4926.
RELATED LINKS