Name
Remove-JobSchedulerEvent
SYNOPSIS
Removes a number of events from a JobScheduler instance.
SYNTAX
Remove-JobSchedulerEvent [[-EventClass] <String>] [[-EventId] <String>] [[-MasterUrl] <Uri>] [[-SupervisorUrl] <Uri>] [[-SupervisorJobChain] <String>] [<CommonParameters>]
DESCRIPTION
Events that have previously been added can be removed from a JobScheduler instance.
If events are processed by a JobScheduler Supervisor then the same instance
has to be addressed for removal of events.
PARAMETERS
EventClass
-EventClass <String>
Specifies a common name for a set of events enabling event handlers to process multiple events of the
same 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.
Specifies a unique identifier when used together with the -EventId parameter. Can be used to remove
all events of a particular event class.
| Required? | false |
| Position? | 1 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
EventId
-EventId <String>
An identifier for an event. Allows event handlers to react to events having a particular identifier.
Specifies a unique identifier when used together with the -EventClass parameter. An event id is required to be unique
for the same event class.
| Required? | false |
| Position? | 2 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
MasterUrl
-MasterUrl <Uri>
Specifies the Job Scheduler Master instance URL.
The URL consists of the protocol, host name and port, e.g. http://localhost:4454.
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-JobSchedulerMaster cmdlet will be used.
| Required? | false |
| Position? | 3 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
SupervisorUrl
-SupervisorUrl <Uri>
Specifies a Job Scheduler Supervisor instance URL.
Job Scheduler Master instances register with a JobScheduler Supervisor (if configured to do so)
in order to synchronize job configurations. The Supervisor instance receives events, executes the
event handler and starts jobs and job chains for registered JobScheduler Master instances.
The URL consists of the protocol, host name and port, e.g. http://localhost:4454.
Default: If used with a job then the CLI will assign by default the JobScheduler Supervisor that the
current JobScheduler Master is registered for and otherwise assign the JobScheduler Master.
| Required? | false |
| Position? | 4 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
SupervisorJobChain
-SupervisorJobChain <String>
Specifies the path of the job chain in the JobScheduler Master or Supervisor instance that implements the event
processor.
Default: /sos/events/scheduler_event_service
| Required? | false |
| Position? | 5 |
| Default value | /sos/events/scheduler_event_service |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > Remove-JobSchedulerEvent -EventClass daily_closing -EventId 12345678
Removes an individual event identified by its event class and event id.
-------------------------- EXAMPLE 2 --------------------------
PS > Remove-JobSchedulerEvent -EventClass daily_closing
Removes all events that are assigned the specified event class.