Skip to content

Test-PodeAuthEvent

SYNOPSIS

Tests whether an Authentication event is registered.

SYNTAX

Test-PodeAuthEvent [[-Name] <String[]>] [-Type] <String[]> [[-EventName] <String[]>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

Tests whether an Authentication event is registered.

EXAMPLES

EXAMPLE 1

if (Test-PodeAuthEvent -Name 'Basic' -Type 'Login' -EventName 'OnLogin') { ... }

EXAMPLE 2

if (Test-PodeAuthEvent -Type 'Logout') { ... }

PARAMETERS

-EventName

An optional array of event Names to check for.

Type: String[]
Parameter Sets: (All)
Aliases:

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

-Name

An optional array of Authentication method Names to check for.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
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

-Type

The Type of event to check for, either 'Login' or 'Logout'.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: True
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.

INPUTS

OUTPUTS

System.Boolean

NOTES