Skip to content

Remove-PodeWebSocket

SYNOPSIS

Remove a WebSocket connection.

SYNTAX

Remove-PodeWebSocket [[-Name] <String>] [<CommonParameters>]

DESCRIPTION

Disconnects and then removes a WebSocket connection.

EXAMPLES

EXAMPLE 1

Remove-PodeWebSocket -Name 'Example'

PARAMETERS

-Name

The Name of the WebSocket connection (optional if in the scope where $WsEvent is available).

Type: String
Parameter Sets: (All)
Aliases:

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

NOTES

Back to top