Add-PodeRouteGroup
SYNOPSIS
Add a Route Group for multiple Routes.
SYNTAX
Add-PodeRouteGroup [[-Path] <String>] [-Routes] <ScriptBlock> [[-Middleware] <Object[]>]
[[-EndpointName] <String[]>] [[-ContentType] <String>] [[-TransferEncoding] <String>]
[[-ErrorContentType] <String>] [[-Authentication] <String>] [[-IfExists] <Object>] [-AllowAnon]
[<CommonParameters>]
DESCRIPTION
Add a Route Group for sharing values between multiple Routes.
EXAMPLES
EXAMPLE 1
Add-PodeRouteGroup -Path '/api' -Routes { Add-PodeRoute -Path '/route1' -Etc }
PARAMETERS
-AllowAnon
If supplied, the Routes will allow anonymous access for non-authenticated users.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Authentication
The name of an Authentication method which should be used as middleware on the Routes.
Type: String
Parameter Sets: (All)
Aliases: Auth
Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ContentType
The content type to use for the Routes, when parsing any payloads.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-EndpointName
The EndpointName of an Endpoint(s) to use for the Routes.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ErrorContentType
The content type of any error pages that may get returned.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IfExists
Specifies what action to take when a Route already exists. (Default: Default)
Type: Object
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: Default
Accept pipeline input: False
Accept wildcard characters: False
-Middleware
An array of ScriptBlocks for optional Middleware to give each Route.
Type: Object[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Path
The URI path to use as a base for the Routes, that should be prepended.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Routes
A ScriptBlock for adding Routes.
Type: ScriptBlock
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-TransferEncoding
The transfer encoding to use for the Routes, when parsing any payloads.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
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.