IdLE.Step.EmitEvent

Generated file. Do not edit by hand. Source: tools/Generate-IdleStepReference.ps1

Summary

• Step Type: IdLE.Step.EmitEvent
• Module: IdLE.Steps.Common
• Implementation: Invoke-IdleStepEmitEvent
• Idempotent: Unknown

Synopsis

Emits a workflow-defined event.

Description

This step does not change external state. It writes one structured event to the EventSink on the execution context (buffered in the execution result and forwarded to the host event sink, if any).

Inputs (all optional):

• With.Message: event message. Defaults to "Event emitted by step '<Name>'.".

• With.Type: event type, e.g. 'Contoso.Joiner.Notified'. Must not start with 'IdLE.' (reserved) and must not be 'Information', 'Warning', 'Error' or 'Custom'. Defaults to 'IdLE.Step.EmitEvent.Emitted'.

• With.Level: 'Information' (default), 'Warning' or 'Error'.

Inputs (With.*)

Validated at plan time against the step's WithSchema (see Step metadata contract).

Key	Type	Required	Default	Notes
Level	String	No	Information	One of: Information, Warning, Error
Message	String	No
Type	String	No

Example

@{
  Name = 'IdLE.Step.EmitEvent Example'
  Type = 'IdLE.Step.EmitEvent'
  With = @{
    # See step description for available options
  }
}

See Also

• Capabilities Reference - Overview of IdLE capabilities
• Providers - Available provider implementations