Stop-KrServer

SYNOPSIS

Starts the Kestrun server and listens for incoming requests.

SYNTAX

__AllParameterSets

Stop-KrServer [[-Server] <KestrunHost>] [-NoWait] [-Quiet] [<CommonParameters>]

ALIASES

This cmdlet has the following aliases, {{Insert list of aliases}}

DESCRIPTION

This function starts the Kestrun server, allowing it to accept incoming HTTP requests.

EXAMPLES

EXAMPLE 1

Start-KrServer -Server $server Starts the specified Kestrun server instance and listens for incoming requests.

PARAMETERS

-NoWait

If specified, the function will not wait for the server to start and will return immediately.

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: ''

-Quiet

If specified, suppresses output messages during the startup process.

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 server instance to start. This parameter is mandatory.

Type: Kestrun.Hosting.KestrunHost
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 0
  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

OUTPUTS

NOTES

This function is designed to be used after the server has been configured and routes have been added. It will block the console until the server is stopped or Ctrl+C is pressed.