Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Get-JobSchedulerJobStreamHistory [[-JobStream] <String>] [[-State] <String>] [[-DateFrom] <DateTime>] [[-DateTo] <DateTime>] [[-RelativeDateFrom] <String>] [[-RelativeDateTo] <String>] [[-Timezone] <TimeZoneInfo>] [[-Limit] <Int32>] [-Successful] [-Failed] [-Incomplete] [-WithTasks] [<CommonParameters>]

DESCRIPTION

...

-RelativeDateFrom <String>
Specifies a relative date starting from which history items should be returned, e.g.

* -1d, -2d: one day ago, two days ago
* -1w, -2w: one week ago, two weeks ago
* -1M, -2M: one month ago, two months ago
* -1y, -2y: one year ago, two years ago

Optionally a timezone offset can be specified, e.g. -1d+02:00, as otherwise a UTC date is assumed.
This parameter takes precedence over the -DateFrom parameter.

...

-RelativeDateTo <String>
Specifies a relative date until which history items should be returned, e.g.

* -1d, -2d: one day ago, two days ago
* -1w, -2w: one week ago, two weeks ago
* -1M, -2M: one month ago, two months ago
* -1y, -2y: one year ago, two years ago

Optionally a timezone offset can be specified, e.g. -1d+02:00, as otherwise a UTC date is assumed.
This parameter takes precedence over the -DateTo parameter.

...

-Incomplete <SwitchParameter>
Specifies that history information for running job streams should be returned.

Required?false
Position?named
Default valueFalse
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

WithTasks

-WithTasks <SwitchParameter>

Required?false
Position?named
Default valueFalse
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...

PS > $items = Get-JobSchedulerJobStreamHistory -Successful -DateFrom "2020-08-11 14:00:00Z"

Returns the order execution history for successfully completed job streams that started after the specified UTC date and time.

-------------------------- EXAMPLE 6 --------------------------

PS > $items = Get-JobSchedulerJobStreamHistory -RelativeDateFrom -7d

Returns the job stream execution history for the last seven days. The history is reported starting from midnight UTC.

-------------------------- EXAMPLE 7 --------------------------

PS > $items = Get-JobSchedulerJobStreamHistory -RelativeDateFrom -7d+01:00

Returns the job stream execution history for the last seven days. The history is reported starting from 1 hour after midnight UTC.

-------------------------- EXAMPLE 8 --------------------------

PS > $items = Get-JobSchedulerJobStreamHistory -RelativeDateFrom -7d+TZ

Returns the job stream execution history for any jobs for the last seven days. The history is reported starting from midnight in the same timezone that is used with the -Timezone parameter.

-------------------------- EXAMPLE 9 --------------------------

PS > $items = Get-JobSchedulerJobStreamHistory -RelativeDateFrom -1w

Returns the job stream execution history for the last week.

-------------------------- EXAMPLE 10 --------------------------

...