New-KrServer

SYNOPSIS

Creates a new Kestrun server instance.

SYNTAX

Logger (Default)

New-KrServer -Name <String> [-Logger <ILogger>] [-PassThru] [-DisablePowershellMiddleware] [-Default]
 [-Environment <String>] [-Force] [<CommonParameters>]

LoggerName

New-KrServer -Name <String> -LoggerName <String> [-PassThru] [-DisablePowershellMiddleware] [-Default]
 [-Environment <String>] [-Force] [<CommonParameters>]

DESCRIPTION

This function initializes a new Kestrun server instance with the specified name and logger.

EXAMPLES

EXAMPLE 1

New-KrServer -Name "MyKestrunServer"
Creates a new Kestrun server instance with the specified name.

PARAMETERS

-Name

The name of the Kestrun server instance to create.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Logger

An optional Serilog logger instance to use for logging. It’s mutually exclusive with the LoggerName parameter. If not specified, the default logger will be used.

Type: ILogger
Parameter Sets: Logger
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-LoggerName

An optional name of a registered logger to use for logging. It’s mutually exclusive with the Logger parameter. If specified, the logger with this name will be used instead of the default logger.

Type: String
Parameter Sets: LoggerName
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PassThru

If specified, the cmdlet will return the created server instance.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-DisablePowershellMiddleware

If specified, the PowerShell middleware will be disabled for this server instance.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Default

If specified, this server instance will be set as the default instance.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Environment

The environment to set for the Kestrun server instance. Valid values are ‘Auto’, ‘Development’, ‘Staging’, and ‘Production’.

• ‘Auto’ (default): Automatically sets the environment to ‘Development’ if a debugger is attached or if the -Debug switch is used; otherwise, it uses the environment specified by the KESTRUN_ENVIRONMENT environment variable or defaults to ‘Production’.
• ‘Development’: Forces the environment to ‘Development’.
• ‘Staging’: Forces the environment to ‘Staging’.
• ‘Production’: Forces the environment to ‘Production’. The environment setting affects middleware behavior, such as detailed error pages in ‘Development’.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: Auto
Accept pipeline input: False
Accept wildcard characters: False

-Force

If specified, the cmdlet will overwrite any existing server instance with the same name.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
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.

INPUTS

OUTPUTS

Kestrun.Hosting.KestrunHost

NOTES

This function is designed to be used in the context of a Kestrun server setup.

RELATED LINKS