Skip to content

Get-PodeFavicon

SYNOPSIS

Retrieves the configured favicon(s) for one or more Pode endpoints.

SYNTAX

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

DESCRIPTION

This function returns a hashtable containing the endpoint names and their corresponding favicon data (byte array and content type). If an endpoint name is specified, only its favicon is returned if set. If none is specified, the function returns all favicons set across endpoints. You can also limit the query to only endpoints marked as default.

EXAMPLES

EXAMPLE 1

Get-PodeFavicon

Returns a hashtable of all endpoints with configured favicons.

EXAMPLE 2

Get-PodeFavicon -EndpointName 'api'

Returns the favicon for the 'api' endpoint.

EXAMPLE 3

Get-PodeFavicon -DefaultEndpoint

Returns favicons for endpoints marked as default only.

PARAMETERS

-DefaultEndpoint

If supplied, only endpoints created with `-Default` are included in the result.

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 a specific endpoint to retrieve the favicon from. If not provided, favicons from all endpoints are returned.

Type: String
Parameter Sets: (All)
Aliases:

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

INPUTS

OUTPUTS

System.Collections.Hashtable

NOTES