Invoke-WebRequest

模組:: Microsoft.PowerShell.Utility Module

從因特網上的網頁取得內容。

語法

Default (預設值)

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

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

此 Cmdlet 已在 Windows PowerShell 3.0 中引進。

備註

根據預設，網頁中的腳本代碼可能會在剖析頁面以填入 ParsedHtml 屬性時執行。使用 -UseBasicParsing 參數來隱藏此專案。

範例

範例 1：傳送 Web 要求

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

$R = Invoke-WebRequest -URI https://www.bing.com?q=how+many+feet+in+a+mile
$R.AllElements | Where-Object {
    $_.name -like "* Value" -and $_.tagName -eq "INPUT"
} | Select-Object Name, Value

name       value
----       -----
From Value 1
To Value   5280

第一個命令會發出要求，並將響應儲存在 $R 變數中。

第二個命令會篩選 AllElements 屬性中的物件，其中名稱屬性就像 “* Value”，而 tagName 為 “INPUT”。篩選的結果會透過管道傳送至 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 之後，變數中 Web 回應物件的 $R 属性表示使用者已成功登入。

範例 3：從網頁取得連結

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

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

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

範例 4：從 Invoke-WebRequest 擷取非成功訊息

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

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

第一個命令會使用 Invoke-WebRequest的 ErrorAction 呼叫，這會強制 Invoke-WebRequest 在任何失敗的要求上擲回終止錯誤。 catch 區塊會攔截終止錯誤，該區塊會從 Exception 物件擷取 StatusCode。

參數

-Body

指定請求的主體內容。請求的主體是緊接著標頭的內容。您也可以將資料流參數的值傳送至 Invoke-WebRequest。

Body 參數可用來指定查詢參數清單或指定回應的內容。

當輸入是 GET 要求，主體是 IDictionary（通常是哈希表），主體會新增至 URI 作為查詢參數。對於其他 GET 要求，本文會設定為標準 name=value 格式的要求本文值。

當本文是窗體，或它是 Invoke-WebRequest 呼叫的輸出時，PowerShell 會將要求內容設定為表單域。例如：

$r = Invoke-WebRequest https://website.com/login.aspx $r.Forms\[0\].Name = "MyName" $r.Forms\[0\].Password = "MyPassword" Invoke-RestMethod https://website.com/service.aspx -Body $r

或-

Invoke-RestMethod https://website.com/service.aspx -Body $r.Forms\[0\]

參數屬性

類型:	Object
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	True
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-Certificate

指定用於安全 Web 要求的客戶端憑證。輸入包含憑證的變數，或取得憑證的命令或表達式。

若要尋找憑證，請使用 Get-PfxCertificate 或使用 Get-ChildItem （）磁碟驅動器中的 Cert: Cmdlet。如果憑證無效或沒有足夠的授權單位，則命令會失敗。

參數屬性

類型:	X509Certificate
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-CertificateThumbprint

指定有權傳送要求之用戶帳戶的數位公鑰憑證（X509）。輸入憑證的憑證指紋。憑證用於客戶端憑證型驗證。它們只能對應至本機用戶帳戶;它們不適用於網域帳戶。

若要取得憑證指紋，請使用PowerShell Get-Item 磁碟驅動器中的 Get-ChildItem 或 Cert: 命令。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-ContentType

指定 Web 要求的內容類型。

如果省略此參數，而且要求方法是POST，Invoke-WebRequest 將內容類型設定為application/x-www-form-urlencoded。否則，不會在呼叫中指定內容類型。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-Credential

指定有權傳送要求的用戶帳戶。預設值為目前的使用者。

輸入使用者名稱，例如 User01 或 Domain01\User01，或輸入 PSCredential 物件，例如 Get-Credential Cmdlet 所產生的用戶名稱。

參數屬性

類型:	PSCredential
預設值:	Current user
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-DisableKeepAlive

指出 Cmdlet 會將 HTTP 標頭中的 KeepAlive 值設定為 False。根據預設，KeepAlive是 true。 KeepAlive 會建立與伺服器的持續性連線，以利後續的要求。

參數屬性

類型:	SwitchParameter
預設值:	KeepAlive
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-Headers

指定 Web 要求的標頭。輸入哈希表或字典。

若要設定 UserAgent 標頭，請使用 UserAgent 參數。您無法使用此參數來指定 UserAgent 或 Cookie 標頭。

參數屬性

類型:	IDictionary
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-InFile

從檔案取得 Web 要求的內容。

輸入路徑和檔名。如果您省略路徑，則預設值為目前的位置。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-MaximumRedirection

指定 PowerShell 在連線失敗之前，將連線重新導向至替代統一資源識別碼（URI）的次數。預設值為 5。值為 0 （零）會防止所有重新導向。

參數屬性

類型:	Int32
預設值:	5
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-Method

指定用於 Web 要求的方法。此參數可接受的值為：

預設
刪除
獲取
頭
合併
選項
補丁
貼文
放
痕跡

參數屬性

類型:	WebRequestMethod
預設值:	Default
接受的值:	Default, Get, Head, Post, Put, Delete, Trace, Options, Merge, Patch
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-OutFile

指定此 Cmdlet 儲存回應本文的輸出檔案。輸入路徑和檔名。如果您省略路徑，則預設值為目前的位置。

根據預設，Invoke-WebRequest 會將結果傳回至管線。若要將結果傳送至檔案和管線，請使用 Passthru 參數。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-PassThru

指出 Cmdlet 除了將結果寫入檔案之外，也會傳回結果。只有當命令中也會使用 OutFile 參數時，此參數才有效。

參數屬性

類型:	SwitchParameter
預設值:	False
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-Proxy

指定要求的 Proxy 伺服器，而不是直接連線到因特網資源。輸入網路 Proxy 伺服器的 URI。

參數屬性

類型:	Uri
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-ProxyCredential

指定有權使用 Proxy 參數所指定 Proxy 伺服器的用戶帳戶。預設值為目前的使用者。

輸入使用者名稱，例如 User01 或 Domain01\User01，或輸入 PSCredential 物件，例如 Get-Credential Cmdlet 所產生的用戶名稱。

只有當命令中也使用 Proxy 參數時，此參數才有效。您不能在相同的命令中使用 ProxyCredential 和 ProxyUseDefaultCredentials 參數。

參數屬性

類型:	PSCredential
預設值:	Current user
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-ProxyUseDefaultCredentials

指出 Cmdlet 會使用目前使用者的認證來存取 Proxy 參數所指定的 Proxy 伺服器。

只有當命令中也使用 Proxy 參數時，此參數才有效。您不能在相同的命令中使用 ProxyCredential 和 ProxyUseDefaultCredentials 參數。

參數屬性

類型:	SwitchParameter
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-SessionVariable

指定此 Cmdlet 建立 Web 要求工作階段並將它儲存在值的變數。輸入不含 "$" 符號（$）的變數名稱。

當您指定會話變數時，Invoke-WebRequest 會建立 Web 要求工作階段物件，並將它指派給 PowerShell 工作階段中具有指定名稱的變數。只要命令完成，您就可以在會話中使用變數。

不同於遠端會話，Web 要求會話不是持續性連線。它是物件，其中包含連線和要求的相關信息，包括 Cookie、認證、最大重新導向值，以及使用者代理程式字串。您可以使用它，在 Web 要求之間共享狀態和數據。

若要在後續的網頁請求中使用網頁請求會話，請在 WebSession 參數的值中指定會話變數。 PowerShell 會在建立新的連線時，使用 Web 要求工作階段物件中的數據。若要覆寫 Web 要求工作階段中的值，請使用 Cmdlet 參數，例如 UserAgent 或 Credential。參數值優先於網路要求會話中的值。

您無法在相同的命令中使用 SessionVariable 和 WebSession 參數。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False
別名:	SV

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-TimeoutSec

指定請求逾時前可擱置的時間長度。輸入以秒為單位的數值。預設值 0 表示無限期等待。

功能變數名稱系統（DNS）查詢最多可能需要 15 秒才能傳回或逾時。如果您的要求包含需要解析的主機名，而且您將 TimeoutSec 設定為大於零的值，但小於 15 秒，則擲回 WebException 之前，可能需要 15 秒以上的時間，而且您的要求逾時。

參數屬性

類型:	Int32
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-TransferEncoding

指定傳輸編碼 HTTP 回應標頭的值。此參數可接受的值為：

分塊
壓縮
洩氣
GZip
身份

參數屬性

類型:	String
預設值:	None
接受的值:	chunked, compress, deflate, gzip, identity
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-Uri

指定傳送 Web 要求之因特網資源的統一資源識別碼（URI）。輸入 URI。此參數支援 HTTP、HTTPS、FTP 和 FILE 值。

這是必要參數。

參數屬性

類型:	Uri
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	0
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-UseBasicParsing

指出 Cmdlet 會針對沒有檔案物件模型（DOM）剖析的 HTML 內容使用回應物件。當計算機上未安裝 Internet Explorer 時，需要此參數，例如在 Windows Server 操作系統的 Server Core 安裝上。

參數屬性

類型:	SwitchParameter
預設值:	False
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-UseDefaultCredentials

指出 Cmdet 會使用目前使用者的認證來傳送 Web 要求。

參數屬性

類型:	SwitchParameter
預設值:	False
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-UserAgent

指定 Web 要求的使用者代理字串。默認使用者代理程式類似於 Mozilla/5.0 (Windows NT; Windows NT 6.1; en-US) WindowsPowerShell/3.0，每個作業系統和平臺都有輕微的變化。

若要使用大部分因特網瀏覽器所使用的標準使用者代理程式字串測試網站，請使用 PSUserAgent 類別的屬性，例如 Chrome、FireFox、InternetExplorer、Opera 和 Safari。例如，下列命令使用 Internet Explorer 的使用者代理程式字串

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-WebSession

指定網頁要求會話。輸入變數名稱，包括貨幣符號（$）。

若要覆寫 Web 要求工作階段中的值，請使用 Cmdlet 參數，例如 UserAgent 或 Credential。參數值優先於網路要求會話中的值。

若要建立 Web 要求工作階段，請在命令的 Invoke-WebRequest 參數值中輸入變數名稱（不含貨幣符號）。 Invoke-WebRequest 建立會話，並將它儲存在變數中。在後續命令中，使用變數作為 WebSession 參數的值。

您無法在相同的命令中使用 SessionVariable 和 WebSession 參數。

參數屬性

類型:	WebRequestSession
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

CommonParameters

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

輸入

Object

您可以使用管線將 Web 要求的本文傳送至 Invoke-WebRequest。

共用方式為

Invoke-WebRequest

語法

Default (預設值)

Description

範例

範例 1：傳送 Web 要求

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

範例 3：從網頁取得連結

範例 4：從 Invoke-WebRequest 擷取非成功訊息

參數

-Body

參數屬性

參數集

-Certificate

參數屬性

參數集

-CertificateThumbprint

參數屬性

參數集

-ContentType

參數屬性

參數集

-Credential

參數屬性

參數集

-DisableKeepAlive

參數屬性

參數集

-Headers

參數屬性

參數集

-InFile

參數屬性

參數集

-MaximumRedirection

參數屬性

參數集

-Method

參數屬性

參數集

-OutFile

參數屬性

參數集

-PassThru

參數屬性

參數集

-Proxy

參數屬性

參數集

-ProxyCredential

參數屬性

參數集

-ProxyUseDefaultCredentials

參數屬性

參數集

-SessionVariable

參數屬性

參數集

-TimeoutSec

參數屬性

參數集

-TransferEncoding

參數屬性

參數集

-Uri

參數屬性

參數集

-UseBasicParsing

參數屬性

參數集

-UseDefaultCredentials

參數屬性

參數集

-UserAgent

參數屬性

參數集

-WebSession

參數屬性

參數集