Versions Compared

Key

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

...

Get-JobSchedulerEvent [-EventClass <String>] [-EventId <String>] [-ExitCode <Int32>] [-MasterUrl <Uri>] [[-SupervisorUrlSupe
rvisorUrl] <Uri>] [-SupervisorJobChain <String>] [-XPath
<String>] <CommonParameters>

...

-EventClass <String>
Specifies a common name for a set of events that enabling enable event handlers to process multiple events of the
same event class. For example, "daily_closing" could be an event class for jobs that should start once day-time
business processes have drawn to a close.

Species Specifies a unique identifier when used together with the -EventId parameter. Can, for example, be used to remove
events (, e.g. remove all events of a particular event class).

Required? false
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?

...

Specifies a unique identifier when used together with the -EventClass parameter. An event id is required to be unique uniq
ue
for the same event class.

...

Default: If used with a job then the CLI will assign by default the JobScheduler Master that the job is running for
otherwise the JobScheduler Master as specified with the Use-Master cmdlet will be used.

Required? false
Position? 4
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?

...

Default: If used with a job then the CLI will assign by default assign the JobScheduler Supervisor that the
current JobScheduler Master is registered for and otherwise assign the JobScheduler Master.

Required? false
Position? 5
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?

...

-SupervisorJobChain <String>
Specifies the path of the job chain in the JobScheduler Master or Supervisor instance that implements the event
processor.

...

-XPath <String>
All events corresponding to the XPath expression specified when this parameter is set. Complex expressions
are possible and all the any attributes of an event can be consideredaddressed. This parameter allows complex queries to
be made, that would not be possible with the -EventClass, -EventId and -ExitCode parameters.

...

C:\PS>$events = Get-Event -EventClass daily_closing

Returns a an array of event objects for the specified event class.

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

C:\PS>Get-Event -Xpath "//events/eventstarts-with(@event_id, 'my')"

Return Returns a number of event objects that are assigned an event id starting with the characters 'my'.