Skip to content

Test-PodeFavicon

SYNOPSIS

Checks whether a favicon is configured for one or more Pode endpoints.

SYNTAX

Test-PodeFavicon [[-EndpointName] <String>] [-DefaultEndpoint]

DESCRIPTION

This function determines if a favicon is configured on a specific HTTP/S endpoint, or across all endpoints if no name is supplied. You can also limit the check to only endpoints marked as default. It returns $true only if all applicable endpoints have a favicon configured.

EXAMPLES

EXAMPLE 1

Test-PodeFavicon

Returns true if all endpoints have a favicon configured.

EXAMPLE 2

Test-PodeFavicon -EndpointName 'api'

Returns true if the 'api' endpoint has a favicon configured.

EXAMPLE 3

Test-PodeFavicon -DefaultEndpoint

Returns true only if all default endpoints have a favicon.

PARAMETERS

-DefaultEndpoint

If supplied, only endpoints created with `-Default` are checked.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-EndpointName

The name of the specific endpoint to check. If not provided, all endpoints are checked.

Type: String
Parameter Sets: (All)
Aliases:

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

INPUTS

OUTPUTS

System.Boolean

NOTES

This is an internal Pode function and is subject to change.