Skip to content

Add-PodeLogW3CCustomField

SYNOPSIS

Creates a new Pode Log W3C Custom Field object.

SYNTAX

Add-PodeLogW3CCustomField [-Name] <String> [-Type] <String> [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

DESCRIPTION

Creates a new Pode Log W3C Custom Field object with the specified name and type.

EXAMPLES

EXAMPLE 1

$field = Add-PodeLogW3CCustomField -Name 'custom-field' -Type 'Request'

EXAMPLE 2

$field = Add-PodeLogW3CCustomField -Name 'custom-field' -Type 'Response'

EXAMPLE 3

$field = Add-PodeLogW3CCustomField -Name 'custom-field' -Type 'Environment'

PARAMETERS

-Name

The name of the custom field to create. Custom field names can only contain alphanumeric characters, hyphens, and underscores.

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

-Type

The type of the custom field, which can be 'Request', 'Response', or 'Environment'.

Request: retrieved from the request headers, and wrapped with "cs(...)" in the W3C log. Response: retrieved from the response headers, and wrapped with "sc(...)" in the W3C log. Environment: retrieved from the process environment variables, and prefixed with "x-" in the W3C log.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
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.Collections.Hashtable

NOTES