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 コマンドレットは、HTTP、HTTPS、FTP、FILE の要求を Web ページまたは Web サービスに送信します。 さらに、応答を解析し、フォーム、リンク、画像、およびその他の重要な HTML 要素のコレクションを返します。

このコマンドレットは、Windows PowerShell 3.0 で導入されました。

例

例 1: Web 要求を送信する

この例では、 Invoke-WebRequest コマンドレットを使用して、Bing.com サイトに Web 要求を送信します。

$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 プロパティが選択されます。

例 2: ステートフル Web サービスを使用する

この例では、Facebook などのステートフル Web サービスで Invoke-WebRequest コマンドレットを使用する方法を示します。

$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 コマンドレットを使用してサインイン要求を送信します。 このコマンドは、 SessionVariable パラメーターの値に "FB" の値を指定し、結果を $R 変数に保存します。 コマンドが完了すると、 $R 変数には HtmlWebResponseObject が含まれており、 $FB 変数には WebRequestSession オブジェクトが含まれます。

Invoke-WebRequest コマンドレットが facebook にサインインすると、$R変数の Web 応答オブジェクトの StatusDescription プロパティは、ユーザーが正常にサインインしたことを示します。

例 3: Web ページからリンクを取得する

このコマンドは、Web ページ内のリンクを取得します。

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

Invoke-WebRequest コマンドレットは、Web ページのコンテンツを取得します。 次に、返された HtmlWebResponseObject の Links プロパティを使用して、各リンクの Href プロパティを表示します。

例 4: Invoke-WebRequest から成功以外のメッセージをキャッチする

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 を取得します。

例 8: 複数のファイルを同時にダウンロードする

Invoke-WebRequest コマンドレットは、一度に 1 つのファイルのみをダウンロードできます。 次の例では、 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 要求の本文をこのコマンドレットにパイプできます。

出力

HtmlWebResponseObject

このコマンドレットは、Web 要求の結果を表す応答オブジェクトを返します。

メモ

Windows PowerShell には、 Invoke-WebRequestの次のエイリアスが含まれています。

• iwr

関連リンク

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