Add-KrAddCallbacksAutomation
SYNOPSIS
Adds callback automation middleware to the Kestrun host.
SYNTAX
Items (Default)
Add-KrAddCallbacksAutomation [-Server <KestrunHost>] [-DefaultTimeout <int>] [-MaxAttempts <int>]
[-BaseDelay <int>] [-MaxDelay <int>] [-PassThru] [<CommonParameters>]
Options
Add-KrAddCallbacksAutomation -Options <CallbackDispatchOptions> [-Server <KestrunHost>] [-PassThru]
[<CommonParameters>]
ALIASES
This cmdlet has the following aliases, {{Insert list of aliases}}
DESCRIPTION
This cmdlet adds middleware to the Kestrun host that enables automatic handling of callbacks using specified options or individual parameters for configuration.
EXAMPLES
EXAMPLE 1
Add-KrAddCallbacksAutomation -DefaultTimeout 30 -MaxAttempts 5 -BaseDelay 2 -MaxDelay 60 Adds callback automation middleware to the current Kestrun host with specified parameters and returns the modified host instance.
EXAMPLE 2
$server = Get-KrServer PS> Add-KrAddCallbacksAutomation -Server $server -Options $customOptions Adds callback automation middleware to the specified Kestrun host using the provided options.
PARAMETERS
-BaseDelay
The base delay in seconds between callback attempts. Used when Options is not provided.
Type: System.Int32
DefaultValue: 0
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Items
Position: Named
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-DefaultTimeout
The default timeout in seconds for callback operations. Used when Options is not provided.
Type: System.Int32
DefaultValue: 0
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Items
Position: Named
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-MaxAttempts
The maximum number of attempts for callback operations. Used when Options is not provided.
Type: System.Int32
DefaultValue: 0
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Items
Position: Named
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-MaxDelay
The maximum delay in seconds between callback attempts. Used when Options is not provided.
Type: System.Int32
DefaultValue: 0
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Items
Position: Named
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-Options
An instance of CallbackDispatchOptions to configure callback dispatch behavior.
Type: Kestrun.Callback.CallbackDispatchOptions
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Options
Position: Named
IsRequired: true
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-PassThru
If specified, the cmdlet returns the modified Kestrun host instance.
Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
Position: Named
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-Server
The Kestrun host instance to which the middleware will be added. If not specified, the current host instance will be used.
Type: Kestrun.Hosting.KestrunHost
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
Position: Named
IsRequired: false
ValueFromPipeline: true
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS
Kestrun.Hosting.KestrunHost
{{ Fill in the Description }}
OUTPUTS
Kestrun.Hosting.KestrunHost
{{ Fill in the Description }}
NOTES
This cmdlet is part of the Kestrun PowerShell module.
RELATED LINKS
{{ Fill in the related links here }}