Skip to content

Test-PodeSignalClientId

SYNOPSIS

Test if a Signal connection ClientId exists or not.

SYNTAX

Test-PodeSignalClientId [-Name] <String> [[-Group] <String[]>] [-ClientId] <String>
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

Test if a Signal connection ClientId exists or not.

EXAMPLES

EXAMPLE 1

if (Test-PodeSignalClientId -Name 'Example' -ClientId 'my-client-id') { ... }

PARAMETERS

-ClientId

The Signal connection ClientId to test.

Type: String
Parameter Sets: (All)
Aliases:

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

-Group

An optional Group 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 a 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

NOTES