New-PodeLimitHeaderComponent
SYNOPSIS
Creates a new Limit Header component.
SYNTAX
New-PodeLimitHeaderComponent [-Name] <String[]> [[-Value] <String[]>] [-Group]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION
Creates a new Limit Header component. This support WebEvent and SmtpEvent headers.
EXAMPLES
EXAMPLE 1
New-PodeLimitHeaderComponent -Name 'X-AuthToken'
EXAMPLE 2
New-PodeLimitHeaderComponent -Name 'X-AuthToken', 'X-AuthKey'
EXAMPLE 3
New-PodeLimitHeaderComponent -Name 'X-AuthToken' -Value '12345'
EXAMPLE 4
New-PodeLimitHeaderComponent -Name 'X-AuthToken' -Group
PARAMETERS
-Group
If supplied, the headers will be grouped by name, ignoring the value. For example, any headers matching "X-AuthToken" will be grouped as "X-AuthToken", and not "X-AuthToken=123".
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Name
The name of the header(s) to check.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ProgressAction
{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Value
The value of the header(s) to check.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
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.