Invoke-WebRequest

Invoke-WebRequest
    [-UseBasicParsing]
    [-Uri] <Uri>
    [-WebSession <WebRequestSession>]
    [-SessionVariable <String>]
    [-Credential <PSCredential>]
    [-UseDefaultCredentials]
    [-CertificateThumbprint <String>]
    [-Certificate <X509Certificate>]
    [-UserAgent <String>]
    [-DisableKeepAlive]
    [-TimeoutSec <Int32>]
    [-Headers <IDictionary>]
    [-MaximumRedirection <Int32>]
    [-Method <WebRequestMethod>]
    [-Proxy <Uri>]
    [-ProxyCredential <PSCredential>]
    [-ProxyUseDefaultCredentials]
    [-Body <Object>]
    [-ContentType <String>]
    [-TransferEncoding <String>]
    [-InFile <String>]
    [-OutFile <String>]
    [-PassThru]
    [<CommonParameters>]

Invoke-WebRequest Cmdlet 會將 HTTP、HTTPS、FTP 和 FILE 要求傳送至網頁或 Web 服務。 它會剖析回應，並傳回窗體、連結、影像和其他重要 HTML 元素的集合。

此 Cmdlet 已在 Windows PowerShell 3.0 中引進。

Security Warning: Script Execution Risk
Invoke-WebRequest parses the content of the web page. Script code in the web page might be
run when the page is parsed.
      RECOMMENDED ACTION:
      Use the -UseBasicParsing switch to avoid script code execution.
      Do you want to continue?

預設情況下，HTTP 請求包含以下 HTTP 標頭的預設值：

• Host
• User-Agent

使用 Headers 參數來新增其他標頭或覆蓋預設值。

可以使用 、 iwr或curl別名來wget執行此指令。

此範例會使用 Invoke-WebRequest Cmdlet 將 Web 要求傳送至 Bing.com 網站。

$Response = Invoke-WebRequest -UseBasicParsing -Uri https://www.bing.com?q=how+many+feet+in+a+mile
$Response.InputFields |
    Where-Object Name -Like "* Value" |
    Select-Object Name, Value

Name       Value
----       -----
From Value 1
To Value   5280

傳 Invoke-WebRequest 回的數據會儲存在變數中 $Response 。 回應 的 InputFields 屬性包含表單域。 Where-Object 可用來將表單域篩選為 Name 屬性就像 “* Value”。 篩選的結果會透過管道傳送至 Select-Object，以選取 Name 和 Value 屬性。

此範例示範如何使用 Invoke-WebRequest Cmdlet 搭配具狀態 Web 服務，例如 Facebook。

$R = Invoke-WebRequest https://www.facebook.com/login.php -SessionVariable fb
# This command stores the first form in the Forms property of the $R variable in the $Form variable.
$Form = $R.Forms[0]
# This command shows the fields available in the form.
$Form.Fields

Key                     Value
---                     -----
...
email
pass
...

# These commands populate the username and password of the respective form fields.
$Form.Fields["email"]="User01@Fabrikam.com"
$Form.Fields["pass"]="P@ssw0rd"
# This command creates the Uri that will be used to log in to facebook.
# The value of the Uri parameter is the value of the Action property of the form.
$Uri = "https://www.facebook.com" + $Form.Action
# Now the Invoke-WebRequest cmdlet is used to sign into the Facebook web service.
# The WebRequestSession object in the $FB variable is passed as the value of the WebSession parameter.
# The value of the Body parameter is the hash table in the Fields property of the form.
# The value of the *Method* parameter is POST. The command saves the output in the $R variable.
$R = Invoke-WebRequest -Uri $Uri -WebSession $FB -Method Post -Body $Form.Fields
$R.StatusDescription

第一個命令會使用 Invoke-WebRequest Cmdlet 來傳送登入要求。 此命令會指定 SessionVariable 參數值的 “FB” 值，並將結果儲存在 $R 變數中。 當命令完成時，$R 變數會包含 HtmlWebResponseObject，而 $FB 變數包含 WebRequestSession 物件。

Invoke-WebRequest Cmdlet 登入 facebook 之後， 變數中 Web 回應物件的 $R 属性表示使用者已成功登入。

此命令會取得網頁中的連結。

(Invoke-WebRequest -Uri "https://devblogs.microsoft.com/powershell/").Links.Href

Invoke-WebRequest Cmdlet 會取得網頁內容。 然後會使用所傳回 HtmlWebResponseObject 的 Links 屬性來顯示每個連結的 Href 屬性。

當 Invoke-WebRequest 遇到非成功 HTTP 訊息（404、500 等）時，它不會傳回任何輸出並擲回終止錯誤。 若要攔截錯誤並檢視 StatusCode 您可以在 try/catch 區塊中括住執行。

try
{
    $Response = Invoke-WebRequest -Uri "www.microsoft.com/unkownhost"
    # This will only execute if the Invoke-WebRequest is successful.
    $StatusCode = $Response.StatusCode
}
catch
{
    $StatusCode = $_.Exception.Response.StatusCode.value__
}
$StatusCode

404

終止錯誤是由 catch 區塊攔截，它會從 Exception 物件擷取 StatusCode。

Invoke-WebRequest Cmdlet 一次只能下載一個檔案。 下列範例會使用 Start-ThreadJob 建立多個線程作業，同時下載多個檔案。

$baseUri = 'https://github.com/PowerShell/PowerShell/releases/download'
$files = @(
    @{
        Uri = "$baseUri/v7.3.0-preview.5/PowerShell-7.3.0-preview.5-win-x64.msi"
        OutFile = 'PowerShell-7.3.0-preview.5-win-x64.msi'
    },
    @{
        Uri = "$baseUri/v7.3.0-preview.5/PowerShell-7.3.0-preview.5-win-x64.zip"
        OutFile = 'PowerShell-7.3.0-preview.5-win-x64.zip'
    },
    @{
        Uri = "$baseUri/v7.2.5/PowerShell-7.2.5-win-x64.msi"
        OutFile = 'PowerShell-7.2.5-win-x64.msi'
    },
    @{
        Uri = "$baseUri/v7.2.5/PowerShell-7.2.5-win-x64.zip"
        OutFile = 'PowerShell-7.2.5-win-x64.zip'
    }
)

$jobs = @()

foreach ($file in $files) {
    $jobs += Start-ThreadJob -Name $file.OutFile -ScriptBlock {
        $params = $Using:file
        Invoke-WebRequest @params
    }
}

Write-Host "Downloads started..."
Wait-Job -Job $jobs

foreach ($job in $jobs) {
    Receive-Job -Job $job
}

此 Cmdlet 支援一般參數：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊，請參閱 about_CommonParameters。

您可以透過管道將 Web 要求的主體傳遞給此 Cmdlet。

此 Cmdlet 會傳回代表 Web 要求結果的響應物件。

Windows PowerShell 包含下列 Invoke-WebRequest的別名：

• iwr
• curl
• wget