ConvertTo-HtmlWebRequestSession

August 3, 2026 ยท View on GitHub

SYNOPSIS

Converts browser session cookies or HtmlCookie objects into a PowerShell WebRequestSession.

SYNTAX

Session (Default)

ConvertTo-HtmlWebRequestSession [[-Session] <HtmlBrowserSession>] [-Domain <string[]>] [-UserAgent <string>] [-Header <hashtable>] [-IncludeExpired] [-Quiet] [-CancellationToken <CancellationToken>] [<CommonParameters>]

ConvertTo-HtmlWebRequestSession [-Cookie] <HtmlCookie[]> [-UserAgent <string>] [-Header <hashtable>] [-IncludeExpired] [-Quiet] [-CancellationToken <CancellationToken>] [<CommonParameters>]

DESCRIPTION

Converts browser session cookies or HtmlCookie objects into a PowerShell WebRequestSession.

EXAMPLES

EXAMPLE 1

$session = Start-HtmlBrowserSession -Url https://portal.contoso.example -Visible -ManualLogin
$webSession = ConvertTo-HtmlWebRequestSession -Session $session
Invoke-WebRequest -Uri https://portal.contoso.example/report -WebSession $webSession

PARAMETERS

-CancellationToken

Token used to cancel the operation.

Type: CancellationToken
Parameter Sets: Session, Cookie
Aliases: None
Possible values:

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

Cookies to copy into a PowerShell WebRequestSession.

Type: HtmlCookie[]
Parameter Sets: Cookie
Aliases: None
Possible values:

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

-Domain

Cookie domain filter used when reading cookies from a browser session.

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

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

Optional headers to add to the WebRequestSession.

Type: Hashtable
Parameter Sets: Session, Cookie
Aliases: None
Possible values:

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

-IncludeExpired

Include expired cookies instead of skipping them.

Type: SwitchParameter
Parameter Sets: Session, Cookie
Aliases: None
Possible values:

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

-Quiet

Suppress warnings about browser cookies that cannot be represented by System.Net.Cookie.

Type: SwitchParameter
Parameter Sets: Session, Cookie
Aliases: None
Possible values:

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

-Session

Browser session whose cookies should be copied. When omitted, the default PSParseHTML session is used.

Type: HtmlBrowserSession
Parameter Sets: Session
Aliases: None
Possible values:

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

-UserAgent

Optional User-Agent to set on the WebRequestSession.

Type: String
Parameter Sets: Session, Cookie
Aliases: None
Possible values:

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.HtmlBrowserSession
  • HtmlTinkerX.HtmlCookie[]

OUTPUTS

  • System.Management.Automation.PSObject
  • None