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>]

Description

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

此 Cmdlet 已在 Windows PowerShell 3.0 中引進。

範例

範例 1：傳送 Web 要求

此範例會 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選取名稱和值屬性。

範例 2：使用具狀態 Web 服務

此範例示範如何使用 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 之後，變數中 $R Web 回應物件的 StatusDescription 屬性表示使用者已成功登入。

範例 3：從網頁取得連結

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

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

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

範例 4：從 Invoke-WebRequest 攔截非成功訊息

當遇到非成功 HTTP 訊息（404、500 等）時 Invoke-WebRequest ，它不會傳回任何輸出並擲回終止錯誤。 若要攔截錯誤並檢視 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。

範例 8：同時下載多個檔案

Cmdlet Invoke-WebRequest 一次只能下載一個檔案。 下列範例會使用 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
}

參數

-Body

-Certificate

-CertificateThumbprint

-ContentType

-Credential

-DisableKeepAlive

-Headers

-InFile

-MaximumRedirection

-Method

-OutFile

-PassThru

-Proxy

-ProxyCredential

-ProxyUseDefaultCredentials

-SessionVariable

-TimeoutSec

-TransferEncoding

-Uri

-UseBasicParsing

-UseDefaultCredentials

-UserAgent

-WebSession

輸入

Object

您可以使用管線將 Web 要求的本文傳送至此 Cmdlet。

輸出

HtmlWebResponseObject

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

備註

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

• iwr

相關連結

• Invoke-RestMethod
• ConvertFrom-Json
• ConvertTo-Json