Close-PodeSignalConnection
SYNOPSIS
Close one or more Signal connections.
SYNTAX
Close-PodeSignalConnection [-Name] <String> [[-Group] <String[]>] [[-ClientId] <String[]>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION
Close one or more Signal connections. Either all connections for a Signal connection Name, or specific ClientIds for a Name.
EXAMPLES
EXAMPLE 1
Close-PodeSignalConnection -Name 'Metrics'
EXAMPLE 2
Close-PodeSignalConnection -Name 'Metrics' -Group 'admins'
EXAMPLE 3
Close-PodeSignalConnection -Name 'Metrics' -ClientId @('my-client-id', 'my-other'id')
PARAMETERS
-ClientId
An optional array of 1 or more Signal connection ClientIds, that are for the Signal connection Name. If not supplied, every Signal connection for the supplied Name will be closed.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Group
An optional array of 1 or more Signal connection Groups, that are for the Signal connection Name. If supplied without any ClientIds, then all connections for the Group(s) will be closed.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Name
The Name of the Signal connection which has the ClientIds for the connections to close. If supplied on its own, all connections will be closed.
Type: String
Parameter Sets: (All)
Aliases: Path
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
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.