Skip to content

Get-PodeSignalClientIdList

SYNOPSIS

Returns a list of ClientIds connected to a Signal.

SYNTAX

Get-PodeSignalClientIdList [-Name] <String> [[-Group] <String[]>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

DESCRIPTION

Returns a list of ClientIds connected to a Signal. You can filter by Group.

EXAMPLES

EXAMPLE 1

$clientIds = Get-PodeSignalClientIdList -Name 'Example'

EXAMPLE 2

$clientIds = Get-PodeSignalClientIdList -Name 'Example' -Group 'Admins'

PARAMETERS

-Group

An optional Group(s) for the Signal connection.

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.

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

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

NOTES