Get-HtmlExtractionProfile

August 3, 2026 ยท View on GitHub

SYNOPSIS

Returns built-in extraction workflow profiles or the profile recommended by an extraction plan.

SYNTAX

List (Default)

Get-HtmlExtractionProfile [[-Name] <string[]>] [-RecommendedMode <HtmlExtractionPlanMode>] [<CommonParameters>]

Plan

Get-HtmlExtractionProfile [-Plan] <HtmlExtractionPlan> [<CommonParameters>]

DESCRIPTION

Returns built-in extraction workflow profiles or the profile recommended by an extraction plan.

EXAMPLES

EXAMPLE 1

Get-HtmlExtractionProfile

EXAMPLE 2

Test-HtmlExtractionPlan -Url https://example.com | Get-HtmlExtractionProfile

PARAMETERS

-Name

Optional extraction profile name filter.

Type: String[]
Parameter Sets: List
Aliases: None
Possible values:

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

-Plan

Extraction plan whose suggested profile should be returned.

Type: HtmlExtractionPlan
Parameter Sets: Plan
Aliases: None
Possible values:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-RecommendedMode

Optional extraction mode filter.

Type: HtmlExtractionPlanMode
Parameter Sets: List
Aliases: None
Possible values: Static, RenderedSnapshot, Crawl, BrowserlessRelayCandidate, AuthRequired

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

  • HtmlTinkerX.HtmlExtractionPlan

OUTPUTS

  • HtmlTinkerX.HtmlExtractionProfile
  • None