Skip to content

Get-PodeSignalEvent

SYNOPSIS

Retrieve one or more Signal connection events.

SYNTAX

Get-PodeSignalEvent [[-Name] <String[]>] [-Type] <PodeClientConnectionEventType[]> [[-EventName] <String[]>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

Retrieve one or more Signal connection events.

EXAMPLES

EXAMPLE 1

$events = Get-PodeSignalEvent -Name 'Metrics' -Type Connect -EventName 'OnConnect'

EXAMPLE 2

$events = Get-PodeSignalEvent -Type Disconnect

PARAMETERS

-EventName

An optional name of the event being retrieved.

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

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

-Name

An optional Name of the Signal connection(s) to retrieve events 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 retrieve, either Connect or Disconnect.

Type: PodeClientConnectionEventType[]
Parameter Sets: (All)
Aliases:
Accepted values: Connect, Disconnect

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.Object[]

NOTES