Invoke-RestMethod

參考

模組:: Microsoft.PowerShell.Utility

傳送 HTTP 或 HTTPS 要求至 RESTful Web 服務。

Syntax

Invoke-RestMethod
      [-Method <WebRequestMethod>]
      [-FollowRelLink]
      [-MaximumFollowRelLink <Int32>]
      [-ResponseHeadersVariable <String>]
      [-UseBasicParsing]
      [-Uri] <Uri>
      [-WebSession <WebRequestSession>]
      [-SessionVariable <String>]
      [-AllowUnencryptedAuthentication]
      [-Authentication <WebAuthenticationType>]
      [-Credential <PSCredential>]
      [-UseDefaultCredentials]
      [-CertificateThumbprint <String>]
      [-Certificate <X509Certificate>]
      [-SkipCertificateCheck]
      [-SslProtocol <WebSslProtocol>]
      [-Token <SecureString>]
      [-UserAgent <String>]
      [-DisableKeepAlive]
      [-TimeoutSec <Int32>]
      [-Headers <IDictionary>]
      [-MaximumRedirection <Int32>]
      [-MaximumRetryCount <Int32>]
      [-RetryIntervalSec <Int32>]
      [-Proxy <Uri>]
      [-ProxyCredential <PSCredential>]
      [-ProxyUseDefaultCredentials]
      [-Body <Object>]
      [-Form <IDictionary>]
      [-ContentType <String>]
      [-TransferEncoding <String>]
      [-InFile <String>]
      [-OutFile <String>]
      [-PassThru]
      [-Resume]
      [-PreserveAuthorizationOnRedirect]
      [-SkipHeaderValidation]
      [<CommonParameters>]

Invoke-RestMethod
      [-Method <WebRequestMethod>]
      [-FollowRelLink]
      [-MaximumFollowRelLink <Int32>]
      [-ResponseHeadersVariable <String>]
      [-UseBasicParsing]
      [-Uri] <Uri>
      [-WebSession <WebRequestSession>]
      [-SessionVariable <String>]
      [-AllowUnencryptedAuthentication]
      [-Authentication <WebAuthenticationType>]
      [-Credential <PSCredential>]
      [-UseDefaultCredentials]
      [-CertificateThumbprint <String>]
      [-Certificate <X509Certificate>]
      [-SkipCertificateCheck]
      [-SslProtocol <WebSslProtocol>]
      [-Token <SecureString>]
      [-UserAgent <String>]
      [-DisableKeepAlive]
      [-TimeoutSec <Int32>]
      [-Headers <IDictionary>]
      [-MaximumRedirection <Int32>]
      [-MaximumRetryCount <Int32>]
      [-RetryIntervalSec <Int32>]
      -NoProxy
      [-Body <Object>]
      [-Form <IDictionary>]
      [-ContentType <String>]
      [-TransferEncoding <String>]
      [-InFile <String>]
      [-OutFile <String>]
      [-PassThru]
      [-Resume]
      [-PreserveAuthorizationOnRedirect]
      [-SkipHeaderValidation]
      [<CommonParameters>]

Invoke-RestMethod
      -CustomMethod <String>
      [-FollowRelLink]
      [-MaximumFollowRelLink <Int32>]
      [-ResponseHeadersVariable <String>]
      [-UseBasicParsing]
      [-Uri] <Uri>
      [-WebSession <WebRequestSession>]
      [-SessionVariable <String>]
      [-AllowUnencryptedAuthentication]
      [-Authentication <WebAuthenticationType>]
      [-Credential <PSCredential>]
      [-UseDefaultCredentials]
      [-CertificateThumbprint <String>]
      [-Certificate <X509Certificate>]
      [-SkipCertificateCheck]
      [-SslProtocol <WebSslProtocol>]
      [-Token <SecureString>]
      [-UserAgent <String>]
      [-DisableKeepAlive]
      [-TimeoutSec <Int32>]
      [-Headers <IDictionary>]
      [-MaximumRedirection <Int32>]
      [-MaximumRetryCount <Int32>]
      [-RetryIntervalSec <Int32>]
      [-Proxy <Uri>]
      [-ProxyCredential <PSCredential>]
      [-ProxyUseDefaultCredentials]
      [-Body <Object>]
      [-Form <IDictionary>]
      [-ContentType <String>]
      [-TransferEncoding <String>]
      [-InFile <String>]
      [-OutFile <String>]
      [-PassThru]
      [-Resume]
      [-PreserveAuthorizationOnRedirect]
      [-SkipHeaderValidation]
      [<CommonParameters>]

Invoke-RestMethod
      -CustomMethod <String>
      [-FollowRelLink]
      [-MaximumFollowRelLink <Int32>]
      [-ResponseHeadersVariable <String>]
      [-UseBasicParsing]
      [-Uri] <Uri>
      [-WebSession <WebRequestSession>]
      [-SessionVariable <String>]
      [-AllowUnencryptedAuthentication]
      [-Authentication <WebAuthenticationType>]
      [-Credential <PSCredential>]
      [-UseDefaultCredentials]
      [-CertificateThumbprint <String>]
      [-Certificate <X509Certificate>]
      [-SkipCertificateCheck]
      [-SslProtocol <WebSslProtocol>]
      [-Token <SecureString>]
      [-UserAgent <String>]
      [-DisableKeepAlive]
      [-TimeoutSec <Int32>]
      [-Headers <IDictionary>]
      [-MaximumRedirection <Int32>]
      [-MaximumRetryCount <Int32>]
      [-RetryIntervalSec <Int32>]
      -NoProxy
      [-Body <Object>]
      [-Form <IDictionary>]
      [-ContentType <String>]
      [-TransferEncoding <String>]
      [-InFile <String>]
      [-OutFile <String>]
      [-PassThru]
      [-Resume]
      [-PreserveAuthorizationOnRedirect]
      [-SkipHeaderValidation]
      [<CommonParameters>]

Description

Cmdlet 會將 Invoke-RestMethod HTTP 和 HTTPS 要求傳送至表示狀態傳輸 (REST) Web 服務，以傳回豐富的結構化數據。

PowerShell 會根據數據類型來格式化回應。針對 RSS 或 ATOM 摘要，PowerShell 會傳回 Item 或 Entry XML 節點。針對 JavaScript 物件表示法 (JSON) 或 XML、PowerShell 會將內容轉換成物件或還原串行化。

此 Cmdlet 是在 Windows PowerShell 3.0 引進。

範例

範例 1：取得 PowerShell RSS 摘要

此範例會 Invoke-RestMethod 使用 Cmdlet 從 PowerShell 部落格 RSS 摘要取得資訊。此命令會 Format-Table 使用 Cmdlet 來顯示資料表中每個部落格的 Title 和 pubDate 屬性值。

Invoke-RestMethod -Uri https://blogs.msdn.microsoft.com/powershell/feed/ |
  Format-Table -Property Title, pubDate

Title                                                                pubDate
-----                                                                -------
Join the PowerShell 10th Anniversary Celebration!                    Tue, 08 Nov 2016 23:00:04 +0000
DSC Resource Kit November 2016 Release                               Thu, 03 Nov 2016 00:19:07 +0000
PSScriptAnalyzer Community Call - Oct 18, 2016                       Thu, 13 Oct 2016 17:52:35 +0000
New Home for In-Box DSC Resources                                    Sat, 08 Oct 2016 07:13:10 +0000
New Social Features on Gallery                                       Fri, 30 Sep 2016 23:04:34 +0000
PowerShellGet and PackageManagement in PowerShell Gallery and GitHub Thu, 29 Sep 2016 22:21:42 +0000
PowerShell Security at DerbyCon                                      Wed, 28 Sep 2016 01:13:19 +0000
DSC Resource Kit September Release                                   Thu, 22 Sep 2016 00:25:37 +0000
PowerShell DSC and implicit remoting broken in KB3176934             Tue, 23 Aug 2016 15:07:50 +0000
PowerShell on Linux and Open Source!                                 Thu, 18 Aug 2016 15:32:02 +0000

範例 2：執行 POST 要求

在此範例中，用戶會執行 Invoke-RestMethod ，在用戶組織中的內部網路網站上執行POST要求。

$Cred = Get-Credential
$Url = "https://server.contoso.com:8089/services/search/jobs/export"
$Body = @{
    search = "search index=_internal | reverse | table index,host,source,sourcetype,_raw"
    output_mode = "csv"
    earliest_time = "-2d@d"
    latest_time = "-1d@d"
}
Invoke-RestMethod -Method 'Post' -Uri $url -Credential $Cred -Body $body -OutFile output.csv

系統會提示輸入認證，然後儲存在中 $Cred ，且將存取的URL定義於中 $Url。

$Body變數會描述搜尋準則、指定 CSV 做為輸出模式，並指定傳回數據的時間週期，該時間週期會在兩天前開始且一天前結束。本文變數會指定套用至與通訊之特定 REST API Invoke-RestMethod 的參數值。

命令 Invoke-RestMethod 會就地執行，並指定結果 CSV 輸出檔案的路徑和檔名。

範例 3：追蹤關聯連結

某些 REST API 支援透過每個 RFC5988的關聯連結進行分頁。您可以讓 Cmdlet 為您執行此動作，而不是剖析標頭以取得下一頁的 URL。此範例會從PowerShell GitHub存放庫傳回前兩個頁面的問題。

$url = 'https://api.github.com/repos/powershell/powershell/issues'
Invoke-RestMethod $url -FollowRelLink -MaximumFollowRelLink 2

範例 4：簡化的多部分/表單數據提交

某些 API 需要 multipart/form-data 提交才能上傳檔案和混合內容。此範例示範如何更新使用者配置檔。

$Uri = 'https://api.contoso.com/v2/profile'
$Form = @{
    firstName  = 'John'
    lastName   = 'Doe'
    email      = 'john.doe@contoso.com'
    avatar     = Get-Item -Path 'c:\Pictures\jdoe.png'
    birthday   = '1980-10-15'
    hobbies    = 'Hiking','Fishing','Jogging'
}
$Result = Invoke-RestMethod -Uri $Uri -Method Post -Form $Form

設定檔案表單需要下列欄位：firstName、、lastNameemail、avatar、birthday、和 hobbies。 API 預期會在欄位中提供使用者配置檔圖片的 avatar 影像。 API 也會接受以相同形式提交的多個 hobbies 專案。

建立 $Form HashTable時，索引鍵名稱會當做表單域名稱使用。根據預設，HashTable 的值會轉換成字串。 System.IO.FileInfo如果存在值，則會提交檔案內容。如果陣列或清單之類的集合存在，則會多次提交表單域。

藉由在 Get-Item 索引鍵上使用 avatar ，物件 FileInfo 將會設定為值。結果是將提交的 jdoe.png 影像數據。

藉由提供清單給 hobbies 索引鍵， hobbies 字段將會出現在每個清單專案的提交中一次。

範例 5：傳遞多個標頭

API 通常需要通過的標頭進行驗證或驗證。此範例示範如何將多個標頭從 hash-table 傳遞至 REST API。

$headers = @{
    'userId' = 'UserIDValue'
    'token' = 'TokenValue'
}
Invoke-RestMethod -Uri $uri -Method Post -Headers $headers -Body $body

參數

-AllowUnencryptedAuthentication

允許透過未加密連線傳送認證和秘密。根據預設，以未開頭https://的 URI 提供認證或任何驗證選項將會導致錯誤，而且要求會中止，以防止不小心透過未加密的連線以純文本通訊秘密。若要以您自己的風險覆寫此行為，請提供 AllowUnencryptedAuthentication 參數。

警告

使用此參數並不安全，不建議使用。它僅適用於無法提供加密連線的舊版系統相容性。以您自己的風險使用。

此功能已在PowerShell 6.0.0中新增。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Authentication

指定要用於要求的明確驗證類型。預設值為 [無]。驗證無法與 UseDefaultCredentials搭配使用。

可用的驗證選項：

無：未提供驗證時，這是預設選項。不會使用明確的驗證。
基本：需要認證。認證將用來以格式base64(user:password)傳送 RFC 7617 基本身份驗證Authorization: Basic標頭。
持有人：需要令牌。將會傳送和 RFC 6750 Authorization: Bearer 標頭與提供的令牌。這是 OAuth 的別名
OAuth：需要令牌。將會傳送具有所提供令牌的 RFC 6750 Authorization: Bearer 標頭。這是持有人的別名

提供驗證會覆寫提供給標頭或Authorization包含在 WebSession 中的任何標頭。

此功能已在PowerShell 6.0.0中新增。

Type:	WebAuthenticationType
Accepted values:	None, Basic, Bearer, OAuth
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Body

指定要求的主體。主體為標頭之後的要求內容。您也可以使用管線將主體值傳送至 Invoke-RestMethod。

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

當輸入是 GET 要求，且主體 IDictionary 通常是 (哈希表) 時，主體會新增至統一資源標識碼 (URI) 作為查詢參數。對於其他要求類型 (例如，POST)，會以標準「名稱=值」格式將主體設定為要求主體的值。

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

Body 參數也可以接受 System.Net.Http.MultipartFormDataContent 物件。這可協助 multipart/form-data 要求。為 Body 提供 MultipartFormDataContent 物件時，提供給 ContentType、Headers 或 WebSession 參數的任何內容相關標頭，都會由對象的內容標頭MultipartFormDataContent覆寫。此功能已在PowerShell 6.0.0中新增。

Type:	Object
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Certificate

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

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

Type:	X509Certificate
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CertificateThumbprint

指定具有傳送要求權限之使用者帳戶的數位公開金鑰憑證 (X509)。請輸入憑證的憑證指紋。

憑證將用於用戶端憑證式驗證。這些憑證只能對應至本機使用者帳戶，無法用於網域帳戶。

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

注意

這項功能目前僅在 Windows OS 平臺上受到支援。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ContentType

指定 Web 要求的內容類型。

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

當為 Body 提供物件時MultipartFormDataContent，將會覆寫 ContentType。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Credential

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

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

認證可以 單獨使用，或搭配特定驗證參數選項使用。單獨使用時，只有在遠端伺服器傳送驗證挑戰要求時，才會將認證提供給遠端伺服器。搭配驗證選項使用時，系統會明確傳送認證。

認證會儲存在 PSCredential 物件中，密碼會儲存為 SecureString。

注意

如需 SecureString 數據保護的詳細資訊，請參閱 SecureString 有多安全？。

Type:	PSCredential
Position:	Named
Default value:	Current user
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CustomMethod

指定用於 Web 要求的自訂方法。這可以與端點所需的要求方法搭配使用，不是方法上的可用選項。方法與 CustomMethod 不能一起使用。

範例：

Invoke-RestMethod -uri 'https://api.contoso.com/widget/' -CustomMethod 'TEST'

這會對 API 提出 TEST HTTP 要求。

此功能已在PowerShell 6.0.0中新增。

Type:	String
Aliases:	CM
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-DisableKeepAlive

表示 Cmdlet 會將 HTTP 標頭中的 KeepAlive 值設定為 False。 KeepAlive 預設為 True。 KeepAlive 會建立伺服器持續連線，有助於後續要求。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-FollowRelLink

指出 Cmdlet 應該遵循關聯連結。

某些 REST API 支援透過每個 RFC5988的關聯連結進行分頁。您可以讓 Cmdlet 為您執行此動作，而不是剖析標頭以取得下一頁的 URL。若要設定要追蹤關聯連結的次數，請使用 MaximumFollowRelLink 參數。

使用此參數時，Cmdlet 會傳回結果頁面的集合。結果的每個頁面可能包含多個結果專案。

此功能已在PowerShell 6.0.0中新增。

Type:	SwitchParameter
Aliases:	FL
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Form

將字典轉換成 multipart/form-data 提交。表單不能與 Body 搭配使用。如果 將會忽略 ContentType 。

字典的索引鍵將用來做為窗體功能變數名稱。根據預設，表單值會轉換成字串值。

如果值為 System.IO.FileInfo 物件，則會提交二進位文件內容。檔案名稱將會提交為 filename。 MIME 將會設定為 application/octet-stream。 Get-Item 可用來簡化 提供 System.IO.FileInfo 物件。

$Form = @{ resume = Get-Item 'c：\Users\jdoe\Documents\John Doe.pdf' }

如果值是集合類型，例如 Array 或 List，則會多次提交欄位的。清單的值預設會被視為字串。如果值為 System.IO.FileInfo 物件，則會提交二進位文件內容。不支援巢狀集合。

$Form = @{ tags = 'Vacation'， '義大利'， '2017' pictures = Get-ChildItem 'c：\Users\jdoe\Pictures\2017-義大利' }

在上述範例中 tags ，會在表單中提供欄位三次，每個 Vacation、 Italy和 2017都會提供一次。欄位 pictures 也會針對資料夾中的每個檔案 2017-Italy 提交一次。該資料夾中檔案的二進位內容將會提交為值。

此功能已在PowerShell 6.1.0中新增。

Type:	IDictionary
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Headers

指定 Web 要求的標頭。輸入雜湊表或字典。

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

內容相關標頭，例如Content-Type，當為 Body 提供物件時MultipartFormDataContent，將會覆寫這類標頭。

Type:	IDictionary
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InFile

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

輸入路徑和檔案名稱。若省略路徑，則預設為目前位置。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-MaximumFollowRelLink

指定如果使用 FollowRelLink ，則追蹤關聯連結的次數。如果 REST API 因要求太多而節流，可能需要較小的值。預設值是 [Int32]::MaxValue。值 0 (零) 會防止下列關聯連結。

Type:	Int32
Aliases:	ML
Position:	Named
Default value:	Int32.MaxValue
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-MaximumRedirection

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

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-MaximumRetryCount

指定在收到 400 到 599 之間的失敗碼或 304 時，PowerShell 重試連線的次數。另請參閱 RetryIntervalSec 參數，以指定重試次數。

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Method

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

Default
刪除
Get
前端
合併
選項
修補程式
郵寄
Put
追蹤

CustomMethod 參數可用於上述未列出的 Request 方法。

Type:	WebRequestMethod
Accepted values:	Default, Get, Head, Post, Put, Delete, Trace, Options, Merge, Patch
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-NoProxy

表示 Cmdlet 不會使用 Proxy 來到達目的地。

當您需要略過 Internet Explorer 中所設定的 Proxy 或環境中指定的 Proxy 時，請使用此參數。

此參數是在 PowerShell 6.0 中引進。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-OutFile

將回應主體儲存在指定的輸出檔中。輸入路徑和檔案名稱。若省略路徑，則預設為目前位置。

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

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PassThru

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

Type:	SwitchParameter
Position:	Named
Default value:	No output
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PreserveAuthorizationOnRedirect

指出 Cmdlet 應該在重新導向之間保留 Authorization 標頭。

根據預設，Cmdlet 會在重新導向之前移除 Authorization 標頭。針對需要將標頭傳送至重新導向位置的情況，指定此參數會停用此邏輯。

此功能已在PowerShell 6.0.0中新增。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Proxy

針對要求使用 Proxy 伺服器，而不是直接連線到因特網資源。輸入網路 Proxy 伺服器的統一資源標識碼 (URI) 。

此功能已在PowerShell 6.0.0中新增。

Type:	Uri
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ProxyCredential

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

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

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

Type:	PSCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ProxyUseDefaultCredentials

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

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

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResponseHeadersVariable

建立響應標頭字典，並將它儲存在指定變數的值中。字典的索引鍵將包含網頁伺服器所傳回之響應標頭的功能變數名稱，而值將會是個別的域值。

此功能已在PowerShell 6.0.0中新增。

Type:	String
Aliases:	RHV
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Resume

執行最佳嘗試以繼續下載部分檔案。 Resume 參數需要 OutFile 參數。

繼續只會在本機檔案和遠端檔案的大小上運作，而且不會執行本機檔案和遠端檔案相同的其他驗證。

如果本機檔案大小小於遠端檔案大小，則 Cmdlet 會嘗試繼續下載檔，並將剩餘的位元組附加至檔尾。

如果本機檔案大小與遠端檔案大小相同，則不會採取任何動作，而且 Cmdlet 會假設下載已完成。

如果本機檔案大小大於遠端檔案大小，則會覆寫本機檔案，並完全重新下載整個遠端檔案。此行為與不使用 Resume 使用 OutFile 相同。

如果遠端伺服器不支援繼續下載，則會覆寫本機檔案，並完全重新下載整個遠端檔案。此行為與不使用 Resume 使用 OutFile 相同。

如果本機檔案不存在，則會建立本機檔案，並完全下載整個遠端檔案。此行為與不使用 Resume 使用 OutFile 相同。

此功能已在PowerShell 6.1.0中新增。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RetryIntervalSec

指定收到 400 到 599 之間的失敗碼或 304 之間的連線重試間隔。另請參閱 MaximumRetryCount 參數，以指定重試次數。

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SessionVariable

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

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

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

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

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

Type:	String
Aliases:	SV
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SkipCertificateCheck

略過包含所有驗證的憑證驗證檢查，例如到期、撤銷、受信任的根授權單位等。

警告

使用此參數並不安全，不建議使用。此參數僅供使用自我簽署憑證進行測試之已知主機使用。以您自己的風險使用。

此功能已在PowerShell 6.0.0中新增。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SkipHeaderValidation

指出 Cmdlet 應該在要求中新增標頭，而不需驗證。

此參數應該用於需要不符合標準的標頭值的網站。指定此參數會停用驗證，以允許未核取值。指定時，會新增所有標頭，而不需驗證。

這會停用傳遞至 ContentType、標頭和 UserAgent 參數的值驗證。

此功能已在PowerShell 6.0.0中新增。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SslProtocol

設定 Web 要求允許的 SSL/TLS 通訊協定。根據預設，系統支援 SSL/TLS 通訊協定。 SslProtocol 允許限制特定通訊協定以符合規範。

SslProtocol 使用 WebSslProtocol 旗標列舉。您可以使用旗標表示法或結合多個選項來提供多個通訊協定，-bor不過在所有平臺上都不支援提供多個WebSslProtocol通訊協定。

注意

在非 Windows 平臺上，可能無法提供 'Tls, Tls12' 作為選項。

此功能已在PowerShell 6.0.0中新增。

Type:	WebSslProtocol
Accepted values:	Default, Tls, Tls11, Tls12
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-TimeoutSec

指定要求逾時之前可以擱置的時間長度。以秒為單位輸入值。預設值為 0，會指定無限逾時。

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

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Token

要包含在要求中的 OAuth 或 Bearer 令牌。某些驗證選項需要令牌。無法獨立使用。

Token 接受 SecureString 包含權杖的。若要提供令牌，請手動使用下列專案：

Invoke-RestMethod -Uri $uri -Authentication OAuth -Token (Read-Host -AsSecureString)

此參數是在 PowerShell 6.0 中引進。

Type:	SecureString
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-TransferEncoding

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

區塊化
壓縮
上下凹陷
GZip
身分識別

Type:	String
Accepted values:	chunked, compress, deflate, gzip, identity
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Uri

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

此為必要參數。參數名稱 (Uri) 是選擇性的。

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

-UseBasicParsing

此參數已被取代。從 PowerShell 6.0.0 開始，所有 Web 要求只會使用基本剖析。此參數僅包含回溯相容性，且任何使用它不會影響 Cmdlet 的作業。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-UseDefaultCredentials

指出 Cmdlet 會使用目前使用者的認證來傳送 Web 要求。這無法與驗證或認證搭配使用，而且可能無法在所有平臺上受到支援。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-UserAgent

指定 Web 要求的使用者代理字串。

默認使用者代理程式類似於 Mozilla/5.0 (Windows NT 10.0; Microsoft Windows 10.0.15063; en-US) PowerShell/6.0.0 每個作業系統和平臺稍有變化。

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

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WebSession

指定 Web 要求工作階段。輸入變數名稱，包括貨幣符號 ($) 。

若要覆寫 Web 要求工作階段中的值，請使用 Cmdlet 參數，例如 UserAgent 或 Credential。參數值的優先順序高於 Web 要求工作階段中的值。針對 Body 提供 MultipartFormDataContent 物件時，也會覆寫內容相關標頭，例如 Content-Type。

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

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

Type:	WebRequestSession
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

輸入

Object

您可以使用管線將 Web 要求的主體傳送至 Invoke-RestMethod。

輸出

System.Int64, System.String, System.Xml.XmlDocument

Cmdlet 的輸出取決於抓取內容的格式。

PSObject

如果要求傳回 JSON 字串， Invoke-RestMethod 則會傳回代表字串的 PSObject 。

備註

某些功能可能無法在所有平臺上使用。

如需 .NET 如何為PowerShell提供 Proxy 服務的詳細資訊，請參閱透過 Proxy 存取因特網。

共用方式為

Invoke-RestMethod

Syntax

Description

範例

範例 1：取得 PowerShell RSS 摘要

範例 2：執行 POST 要求

範例 3：追蹤關聯連結

範例 4：簡化的多部分/表單數據提交

範例 5：傳遞多個標頭

參數

-AllowUnencryptedAuthentication

-Authentication

-Body

-Certificate

-CertificateThumbprint

-ContentType

-Credential

-CustomMethod

-DisableKeepAlive

-FollowRelLink

-Form

-Headers

-InFile

-MaximumFollowRelLink

-MaximumRedirection

-MaximumRetryCount

-Method

-NoProxy

-OutFile

-PassThru

-PreserveAuthorizationOnRedirect

-Proxy

-ProxyCredential

-ProxyUseDefaultCredentials

-ResponseHeadersVariable

-Resume

-RetryIntervalSec

-SessionVariable

-SkipCertificateCheck

-SkipHeaderValidation

-SslProtocol

-TimeoutSec

-Token

-TransferEncoding

-Uri

-UseBasicParsing

-UseDefaultCredentials

-UserAgent

-WebSession

輸入

輸出

備註

相關連結

其他資源