Invoke-IdlePlan
SYNOPSIS
Executes an IdLE plan.
SYNTAX
Invoke-IdlePlan [-Plan] <Object> [[-Providers] <Hashtable>] [[-EventSink] <Object>]
[[-ExecutionOptions] <Hashtable>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION
Executes a plan deterministically and emits structured events. Delegates execution to IdLE.Core.
Provider resolution:
- If -Providers is supplied, it is used for execution.
- If -Providers is not supplied, Plan.Providers is used if available.
- If neither is present, execution fails early with a clear error message.
EXAMPLES
EXAMPLE 1
# Default: plan built with providers, execution uses Plan.Providers
$providers = @{ Identity = $provider; AuthSessionBroker = $authSessionBroker }
$plan = New-IdlePlan -WorkflowPath ./joiner.psd1 -Request $req -Providers $providers
Invoke-IdlePlan -Plan $plan
EXAMPLE 2
# Override: explicit -Providers at invoke time
Invoke-IdlePlan -Plan $plan -Providers $otherProviders
EXAMPLE 3
$execOptions = @{
RetryProfiles = @{
Default = @{ MaxAttempts = 3; InitialDelayMilliseconds = 200 }
ExchangeOnline = @{ MaxAttempts = 6; InitialDelayMilliseconds = 500 }
}
DefaultRetryProfile = 'Default'
}
Invoke-IdlePlan -Plan $plan -ExecutionOptions $execOptions
PARAMETERS
-Plan
The plan object created by New-IdlePlan.
Type: Object
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-Providers
Provider registry/collection passed through to execution. If omitted and Plan.Providers exists, Plan.Providers will be used. If supplied, overrides Plan.Providers.
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-EventSink
Optional external event sink for streaming. Must be an object with a WriteEvent(event) method.
Type: Object
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ExecutionOptions
Optional host-owned execution options. Supports retry profile configuration. Must be a hashtable with optional keys: RetryProfiles, DefaultRetryProfile.
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ProgressAction
TODO: ProgressAction Description
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.