Start-Polaris
SYNOPSIS
Start Polaris web server.
SYNTAX
Start-Polaris [[-Port] <Int32>] [[-MinRunspaces] <Int32>] [[-MaxRunspaces] <Int32>]
[-UseJsonBodyParserMiddleware] [-Https] [[-HostName] <String>] [[-Auth] <String>] [[-Polaris] <Object>]
[<CommonParameters>]
DESCRIPTION
Start Polaris web server.
EXAMPLES
EXAMPLE 1
Start-Polaris
EXAMPLE 2
Start-Polaris -Port 8081 -MinRunspaces 2 -MaxRunspaces 10 -UseJsonBodyParserMiddleware
PARAMETERS
-Port
Port number to listen on. Defaults to 8080.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: 8080
Accept pipeline input: False
Accept wildcard characters: False
-MinRunspaces
Minimum number of PowerShell runspaces for web server to use. Defaults to 1.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: 1
Accept pipeline input: False
Accept wildcard characters: False
-MaxRunspaces
Maximum number of PowerShell runspaces for web server to use. Defaults to 1.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: 1
Accept pipeline input: False
Accept wildcard characters: False
-UseJsonBodyParserMiddleware
When present, JSONBodyParser middleware will be created, if needed.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Https
Determines if you want to use https as the prefix.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-HostName
Determines the hostname used in the URL prefix. Defaults to localhost.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: Localhost
Accept pipeline input: False
Accept wildcard characters: False
-Auth
Polaris will use various authentication methods to authenticate requests.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: Anonymous
Accept pipeline input: False
Accept wildcard characters: False
-Polaris
A Polaris object Defaults to the script scoped Polaris
Type: Object
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: $Script:Polaris
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.