Invoke-WebRequest

Syntax

Default (Standard)

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

Exempel

Exempel 1: Skicka en webbbegäran

$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

Exempel 2: Använd en tillståndskänslig webbtjänst

$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

Exempel 3: Hämta länkar från en webbsida

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

Exempel 4: Fånga meddelanden som inte lyckades från Invoke-WebRequest

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

Exempel 5: Ladda ned flera filer samtidigt

$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
}

Parametrar

-Body

Anger innehållet i begäran. Kroppen är innehållet i begäran som följer efter rubrikerna. Du kan också skicka ett kroppsvärde till Invoke-WebRequest.

Parametern Body kan användas för att ange en lista med frågeparametrar eller ange innehållet i svaret.

När indata är en GET-begäran och brödtexten är en IDictionary- (vanligtvis en hashtabell) läggs brödtexten till i URI:n som frågeparametrar. För andra typer av begäranden (till exempel POST) anges brödtexten som värdet för begärandetexten i standardformatet name=value .

När brödtexten är ett formulär, eller om det är utdata från ett Invoke-WebRequest-anrop, anger PowerShell begärandeinnehållet till formulärfälten. Till exempel:

$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

• eller-

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

Parameteregenskaper

Parameteruppsättningar

-Certificate

Anger det klientcertifikat som används för en säker webbbegäran. Ange en variabel som innehåller ett certifikat eller ett kommando eller uttryck som hämtar certifikatet.

Om du vill hitta ett certifikat använder du Get-PfxCertificate eller Get-ChildItem-cmdleten på Certifikat-enheten (Cert:). Om certifikatet inte är giltigt eller inte har tillräcklig behörighet misslyckas kommandot.

Parameteregenskaper

Parameteruppsättningar

-CertificateThumbprint

Anger det digitala offentliga nyckelcertifikatet (X509) för ett användarkonto som har behörighet att skicka begäran. Ange certifikatets tumavtryck.

Certifikat används i klientcertifikatbaserad autentisering. Certifikat kan bara mappas till lokala användarkonton, inte domänkonton.

Om du vill se certifikatets tumavtryck använder du kommandot Get-Item eller Get-ChildItem för att hitta certifikatet i Cert:\CurrentUser\My.

Parameteregenskaper

Parameteruppsättningar

-ContentType

Anger innehållstypen för webbbegäran.

Om värdet för ContentType innehåller kodningsformatet (som charset) använder cmdleten formatet för att koda brödtexten i webbbegäran. Om ContentType- inte anger något kodningsformat används standardkodningsformatet i stället. Ett exempel på en ContentType- med ett kodningsformat är text/plain; charset=iso-8859-5, som anger alfabetet latinsk/kyrillisk.

Om du utelämnar parametern kan innehållstypen vara annorlunda baserat på den HTTP-metod som du använder:

• För en POST-metod är innehållstypen application/x-www-form-urlencoded
• För en PUT-metod är innehållstypen application/json
• För andra metoder anges inte innehållstypen i begäran

Om du använder parametern InFile för att ladda upp en fil bör du ange innehållstypen. Vanligtvis ska typen vara application/octet-stream. Du måste dock ange innehållstypen baserat på slutpunktens krav.

Parameteregenskaper

Parameteruppsättningar

-Credential

Anger ett användarkonto som har behörighet att skicka begäran. Standardvärdet är den aktuella användaren.

Ange ett användarnamn, till exempel User01 eller Domain01\User01, eller ange ett PSCredential- objekt som genereras av cmdleten Get-Credential.

Autentiseringsuppgifter lagras i ett PSCredential--objekt och lösenordet lagras som en SecureString-.

Parameteregenskaper

Parameteruppsättningar

-DisableKeepAlive

Anger att cmdleten anger värdet KeepAlive i HTTP-huvudet till False. Som standard är KeepAliveTrue. KeepAlive upprättar en beständig anslutning till servern för att underlätta efterföljande begäranden.

Parameteregenskaper

Parameteruppsättningar

-Headers

Anger sidhuvudena för webbbegäran. Ange en hashtabell eller ordlista.

Om du vill ange UserAgent--huvuden använder du parametern UserAgent. Du kan inte använda den här parametern för att ange UserAgent-- eller cookierubriker.

Parameteregenskaper

Parameteruppsättningar

-InFile

Hämtar innehållet i webbbegärandetexten från en fil. Ange en sökväg och ett filnamn. Om du utelämnar sökvägen är standardinställningen den aktuella platsen.

Du måste också ange innehållstypen för begäran. Om du till exempel vill ladda upp en fil bör du ange innehållstypen. Vanligtvis ska typen vara application/octet-stream. Du måste dock ange innehållstypen baserat på slutpunktens krav.

Parameteregenskaper

Parameteruppsättningar

-MaximumRedirection

Anger hur många gånger PowerShell omdirigerar en anslutning till en alternativ URI (Uniform Resource Identifier) innan anslutningen misslyckas. Standardvärdet är 5. Värdet 0 (noll) förhindrar all omdirigering.

Parameteregenskaper

Parameteruppsättningar

-Method

Anger den metod som används för webbbegäran. De godtagbara värdena för den här parametern är:

• Default
• Delete
• Get
• Head
• Merge
• Options
• Patch
• Post
• Put
• Trace

Parameteregenskaper

Parameteruppsättningar

-OutFile

Anger den utdatafil som den här cmdleten sparar svarstexten för. Ange en sökväg och ett filnamn. Om du utelämnar sökvägen är standardinställningen den aktuella platsen.

Som standard returnerar Invoke-WebRequest resultatet till pipelinen. Om du vill skicka resultatet till en fil och till pipelinen använder du parametern PassThru .

Parameteregenskaper

Parameteruppsättningar

-PassThru

Anger att cmdleten returnerar resultatet, förutom att skriva dem till en fil. Den här parametern är endast giltig när parametern OutFile också används i kommandot .

Parameteregenskaper

Parameteruppsättningar

-Proxy

Anger en proxyserver för begäran i stället för att ansluta direkt till Internetresursen. Ange URI för en nätverksproxyserver.

Parameteregenskaper

Parameteruppsättningar

-ProxyCredential

Anger ett användarkonto som har behörighet att använda proxyservern som anges av parametern Proxy. Standardvärdet är den aktuella användaren.

Ange ett användarnamn, till exempel User01 eller Domain01\User01, eller ange ett PSCredential- objekt, till exempel ett som genereras av Get-Credential cmdlet.

Den här parametern är endast giltig när parametern Proxy också används i kommandot . Du kan inte använda parametrarna ProxyCredential och ProxyUseDefaultCredentials i samma kommando.

Parameteregenskaper

Parameteruppsättningar

-ProxyUseDefaultCredentials

Anger att cmdleten använder den aktuella användarens autentiseringsuppgifter för att komma åt proxyservern som anges av parametern Proxy.

Den här parametern är endast giltig när parametern Proxy också används i kommandot . Du kan inte använda parametrarna ProxyCredential och ProxyUseDefaultCredentials i samma kommando.

Parameteregenskaper

Parameteruppsättningar

-SessionVariable

Anger en variabel för vilken den här cmdleten skapar en webbbegärandesession och sparar den i värdet. Ange ett variabelnamn utan symbolen dollartecken ($).

När du anger en sessionsvariabel skapar Invoke-WebRequest ett sessionsobjekt för webbbegäran och tilldelar det till en variabel med det angivna namnet i PowerShell-sessionen. Du kan använda variabeln i sessionen så snart kommandot har slutförts.

Till skillnad från en fjärrsession är webbbegärandesessionen inte en beständig anslutning. Det är ett objekt som innehåller information om anslutningen och begäran, inklusive cookies, autentiseringsuppgifter, maximalt omdirigeringsvärde och användaragentsträngen. Du kan använda den för att dela tillstånd och data mellan webbbegäranden.

Om du vill använda webbbegärandesessionen i efterföljande webbbegäranden anger du sessionsvariabeln i värdet för parametern WebSession. PowerShell använder data i sessionsobjektet för webbbegäran när den nya anslutningen upprättas. Om du vill åsidosätta ett värde i webbbegäranssessionen använder du en cmdlet-parameter, till exempel UserAgent eller Credential. Parametervärden har företräde framför värden i webbbegärandesessionen.

Du kan inte använda parametrarna SessionVariable och WebSession i samma kommando.

Parameteregenskaper

Parameteruppsättningar

-TimeoutSec

Anger hur länge begäran kan vänta innan tidsgränsen uppnås. Ange ett värde i sekunder. Standardvärdet 0 anger en tidsgräns på obestämd tid.

En DNS-fråga (Domain Name System) kan ta upp till 15 sekunder att returnera eller överskrida tidsgränsen. Om din begäran innehåller ett värdnamn som kräver lösning och du anger TimeoutSec till ett värde som är större än noll, men mindre än 15 sekunder, kan det ta 15 sekunder eller mer innan en WebException- utlöses och din begäran överskrider tidsgränsen.

Parameteregenskaper

Parameteruppsättningar

-TransferEncoding

Anger ett värde för http-svarshuvudet för överföringskodning. De godtagbara värdena för den här parametern är:

• Chunked
• Compress
• Deflate
• GZip
• Identity

Parameteregenskaper

Parameteruppsättningar

-Uri

Anger URI (Uniform Resource Identifier) för den Internetresurs som webbbegäran skickas till. Ange en URI. Den här parametern stöder HTTP-, HTTPS-, FTP- och FILE-värden.

Den här parametern krävs. Parameternamnet Uri är valfritt.

Parameteregenskaper

Parameteruppsättningar

-UseBasicParsing

Anger att cmdleten använder svarsobjektet för HTML-innehåll utan dom-parsning (Document Object Model). Den här parametern krävs när Internet Explorer inte är installerat på datorerna, till exempel på en Server Core-installation av ett Windows Server-operativsystem.

Parameteregenskaper

Parameteruppsättningar

-UseDefaultCredentials

Anger att cmdleten använder den aktuella användarens autentiseringsuppgifter för att skicka webbbegäran.

Parameteregenskaper

Parameteruppsättningar

-UserAgent

Anger en användaragentsträng för webbbegäran. Standardanvändaragenten liknar Mozilla/5.0 (Windows NT; Windows NT 6.1; en-US) WindowsPowerShell/3.0 med små variationer för varje operativsystem och plattform.

Om du vill testa en webbplats med standardanvändaragentsträngen som används av de flesta webbläsare använder du egenskaperna för PSUserAgent-klass, till exempel Chrome, Firefox, InternetExplorer, Opera och Safari. Följande kommando använder till exempel användaragentsträngen för Internet Explorer: Invoke-WebRequest -Uri https://website.com/ -UserAgent ([Microsoft.PowerShell.Commands.PSUserAgent]::InternetExplorer)

Parameteregenskaper

Parameteruppsättningar

-WebSession

Anger en webbförfrågningssession. Ange variabelnamnet, inklusive dollartecknet ($).

Om du vill åsidosätta ett värde i webbbegäranssessionen använder du en cmdlet-parameter, till exempel UserAgent eller Credential. Parametervärden har företräde framför värden i webbbegärandesessionen.

Till skillnad från en fjärrsession är webbbegärandesessionen inte en beständig anslutning. Det är ett objekt som innehåller information om anslutningen och begäran, inklusive cookies, autentiseringsuppgifter, maximalt omdirigeringsvärde och användaragentsträngen. Du kan använda den för att dela tillstånd och data mellan webbbegäranden.

Om du vill skapa en webbförfrågningssession anger du ett variabelnamn, utan dollartecken, i värdet för parametern SessionVariable för ett Invoke-WebRequest kommando. Invoke-WebRequest skapar sessionen och sparar den i variabeln. I efterföljande kommandon använder du variabeln som värdet för parametern WebSession.

Du kan inte använda parametrarna SessionVariable och WebSession i samma kommando.

Parameteregenskaper

Parameteruppsättningar

CommonParameters

Indata

Object

Utdata

HtmlWebResponseObject

Kommentarer

Relaterade länkar

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