Skip to content

New-PodeLimitEndpointComponent

SYNOPSIS

Creates a new Limit Endpoint component.

SYNTAX

New-PodeLimitEndpointComponent [[-Name] <String[]>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

Creates a new Limit Endpoint component. This supports the WebEvent, SmtpEvent, and TcpEvent endpoints.

EXAMPLES

EXAMPLE 1

New-PodeLimitEndpointComponent

EXAMPLE 2

New-PodeLimitEndpointComponent -Name 'api'

PARAMETERS

-Name

The endpoint name(s) to check.

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

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

A hashtable containing the options and scriptblock for the endpoint component.

The scriptblock will return the endpoint name if found, or null if not.

NOTES