New-PolarisGetRoute
SYNOPSIS
Add web route with method GET
SYNTAX
Scriptblock
New-PolarisGetRoute [-Path] <String> [-Scriptblock] <ScriptBlock> [-Force] [-Polaris <Object>]
[<CommonParameters>]
ScriptPath
New-PolarisGetRoute [-Path] <String> -ScriptPath <String> [-Force] [-Polaris <Object>] [<CommonParameters>]
DESCRIPTION
Wrapper for New-PolarisRoute -Method GET
EXAMPLES
EXAMPLE 1
New-PolarisGetRoute -Path "helloworld" -Scriptblock { $Response.Send( 'Hello World' ) }
To view results: Start-Polaris Start-Process http://localhost:8080/helloworld
EXAMPLE 2
New-PolarisGetRoute -Path "helloworld" -ScriptPath D:\Scripts\Example.ps1
To view results, assuming default port: Start-Polaris Start-Process http://localhost:8080/helloworld
PARAMETERS
-Path
Path (path/route/endpoint) of the web route to to be serviced.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Scriptblock
Scriptblock that will be triggered when web route is called.
Type: ScriptBlock
Parameter Sets: Scriptblock
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ScriptPath
Full path and name of script that will be triggered when web route is called.
Type: String
Parameter Sets: ScriptPath
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Force
Use -Force to overwrite any existing web route for the same path and method.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
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: Named
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.