Invoke-RestMethod

Syntax

StandardMethod (Standard)

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

StandardMethodNoProxy

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

CustomMethod

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

CustomMethodNoProxy

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

Description

Exempel

Exempel 1: Hämta PowerShell RSS-feeden

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

Exempel 2: Kör en POST-begäran

$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

Exempel 3: Följ relationslänkar

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

Exempel 4: Förenklad multipart-inlämning/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

Exempel 5: Skicka flera rubriker

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

Exempel 6: Räkna upp returnerade objekt i pipelinen

$uri = 'https://api.github.com/repos/microsoftdocs/powershell-docs/issues'
$x = 0
Invoke-RestMethod -Uri $uri | ForEach-Object { $x++ }
$x
1

$x = 0
(Invoke-RestMethod -Uri $uri) | ForEach-Object { $x++ }
$x
30

$x = 0
Invoke-RestMethod -Uri $uri | Write-Output | ForEach-Object { $x++ }
$x
30

Exempel 7: Hoppa över sidhuvudverifiering

$Uri = 'https://httpbin.org/headers'
$InvalidHeaders = @{
    'If-Match' = '12345'
}

Invoke-RestMethod -Uri $Uri -Headers $InvalidHeaders

Invoke-RestMethod -Uri $Uri -Headers $InvalidHeaders -SkipHeaderValidation |
    Format-List

Invoke-RestMethod: The format of value '12345' is invalid.

headers : @{Host=httpbin.org; If-Match=12345; User-Agent=Mozilla/5.0 (Windows NT 10.0; Microsoft Windows
          10.0.19044; en-US) PowerShell/7.2.5;  X-Amzn-Trace-Id=Root=1-62f150a6-27754fd4226f31b43a3d2874}

Exempel 8: Skicka en begäran med HTTP 2.0

$uri = 'https://api.github.com/repos/microsoftdocs/powershell-docs/issues'
Invoke-RestMethod -Uri $uri -HttpVersion 2.0 -SkipCertificateCheck

Exempel 9: Skicka en begäran till ett Unix Socket-program

Invoke-RestMethod -Uri "http://localhost/v1.40/images/json/" -UnixSocket "/var/run/docker.sock"

Parametrar

-AllowInsecureRedirect

Tillåter omdirigering från HTTPS till HTTP. Som standard resulterar alla begäranden som omdirigeras från HTTPS till HTTP i ett fel och begäran avbryts för att förhindra oavsiktlig kommunikation i oformaterad text över okrypterade anslutningar. Om du vill åsidosätta det här beteendet på egen risk använder du parametern AllowInsecureRedirect.

Den här parametern lades till i PowerShell 7.4.

Parameteregenskaper

Parameteruppsättningar

-AllowUnencryptedAuthentication

Tillåter sändning av autentiseringsuppgifter och hemligheter via okrypterade anslutningar. Om du som standard anger inloggningsuppgifter eller något inloggningsalternativ med en URI som inte börjar med https://, resulterar det i ett fel och begäran avbryts för att förhindra att hemligheter kommuniceras i klartext över okrypterade anslutningar. Om du vill åsidosätta det här beteendet på egen risk anger du parametern AllowUnencryptedAuthentication.

Den här funktionen lades till i PowerShell 6.0.0.

Parameteregenskaper

Parameteruppsättningar

-Authentication

Anger den explicita autentiseringstyp som ska användas för begäran. Standardvärdet är Ingen. Parametern Authentication kan inte användas med parametern UseDefaultCredentials.

Tillgängliga autentiseringsalternativ:

• None: Det här är standardalternativet när autentisering inte anges. Ingen explicit autentisering används.
• Basic: Kräver autentiseringsuppgifter. Autentiseringsuppgifterna används för att skicka en RFC 7617 Basic Authentication-Authorization: Basic-rubrik i formatet base64(user:password).
• Bearer: Kräver parametern Token. Skickar ett RFC 6750 Authorization: Bearer-huvud med den angivna token.
• OAuth: Kräver parametern Token. Skickar ett RFC 6750 Authorization: Bearer-huvud med den angivna token.

Om du tillhandahåller autentisering åsidosätter alla Authorization rubriker som tillhandahålls till rubriker eller som ingår i WebSession.

Den här funktionen lades till i PowerShell 6.0.0.

Parameteregenskaper

Parameteruppsättningar

-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-RestMethod.

Brödtextparametern kan användas för att ange en lista med frågeparametrar eller ange innehållet i begäran. För frågeparametrar använder cmdleten System.Net.WebUtility.UrlEncode metodmetod för att koda nyckel/värde-paren. Mer information om kodningssträngar för URL:er finns i urlencode()-metodreferensen.

När indata är en POST-begäran och brödtexten är en Stränganges värdet till vänster om det första likhetstecknet (=) som en nyckel i formulärdata och den återstående texten anges som värdet. Om du vill ange flera nycklar använder du ett IDictionary-objekt, till exempel en hash-tabell, för Body.

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 PATCH) anges brödtexten som värdet för begärandetexten i standardformatet name=value med värdena URL-kodade.

När indata är ett System.Xml.XmlNode- objekt och XML-deklarationen anger en kodning, används kodningen för data i begäran om den inte åsidosätts av parametern ContentType.

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

Parametern Body kan också acceptera ett System.Net.Http.MultipartFormDataContent-objekt, vilket underlättar multipart/form-data begäranden. När ett MultipartFormDataContent--objekt tillhandahålls för Body, blir alla innehållsrelaterade huvuden som tillhandahålls till ContentType, Headerseller WebSession-parametrarna åsidosatta av innehållshuvudena i MultipartFormDataContent-objektet. Den här funktionen lades till i PowerShell 6.0.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

-ConnectionTimeoutSeconds

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 återvända eller avbrytas på grund av tidsgränsen. Om din begäran innehåller ett värdnamn som behöver lösas och du anger ConnectionTimeoutSeconds 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 kastas och din begäran avbryts på grund av tidsgränsen.

Den här parametern ersatte parametern TimeoutSec i PowerShell 7.4. Du kan använda TimeoutSec som alias för ConnectionTimeoutSeconds.

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.

ContentType åsidosättas när Body är ett MultipartFormDataContent- objekt.

Från och med PowerShell 7.4 används värdet som anges i parametern ContentType om du använder både den här parametern och parametern Content-Type för att definiera -huvudet.

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.

Du kan använda autentiseringsuppgifter enbart eller tillsammans med vissa autentiseringsparameteralternativ. När den används ensam tillhandahåller den bara autentiseringsuppgifter till fjärrservern om fjärrservern skickar en begäran om autentiseringsutmaning. När alternativ för autentisering används, skickas autentiseringsuppgifterna uttryckligen.

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

Parameteregenskaper

Parameteruppsättningar

-CustomMethod

Anger den anpassade metod som används för webbbegäran. Detta kan användas när den begärandemetod som krävs av slutpunkten inte är ett tillgängligt alternativ för metod . Metoden och CustomMethod kan inte användas tillsammans.

Exempel:

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

Detta gör en TEST HTTP-begäran till API:et.

Den här funktionen lades till i PowerShell 6.0.0.

Parameteregenskaper

Parameteruppsättningar

-DisableKeepAlive

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

Parameteregenskaper

Parameteruppsättningar

-FollowRelLink

Anger att cmdleten ska följa relationslänkarna.

Vissa REST-API:er stöder sidnumrering via relationslänkar per RFC5988. I stället för att analysera sidhuvudet för att hämta URL:en för nästa sida kan du låta cmdleten göra detta åt dig. Om du vill ange hur många gånger du ska följa relationslänkar använder du parametern MaximumFollowRelLink.

När du använder den här växeln returnerar cmdleten en samling sidor med resultat. Varje sida med resultat kan innehålla flera resultatobjekt.

Den här funktionen lades till i PowerShell 6.0.0.

Parameteregenskaper

Parameteruppsättningar

-Form

Konverterar en ordlista till en multipart/form-data-inlämning. Formulär får inte användas med Body. -ContentType ignoreras.

Nycklarna i ordlistan används som formulärfältnamn. Som standard konverteras formulärvärden till strängvärden.

Om värdet är ett System.IO.FileInfo- objekt skickas innehållet i den binära filen. Namnet på filen skickas som filename. MIME-typen anges som application/octet-stream. Get-Item kan användas för att förenkla leveransen av objektet System.IO.FileInfo.

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

Om värdet är en samlingstyp, till exempel en matris eller lista, skickas formulärfältet flera gånger. Värdena i listan behandlas som strängar som standard. Om värdet är ett System.IO.FileInfo- objekt skickas innehållet i den binära filen. Kapslade samlingar stöds inte.

$Form = @{
    tags     = 'Vacation', 'Italy', '2017'
    pictures = Get-ChildItem 'C:\Users\jdoe\Pictures\2017-Italy\'
}

I exemplet ovan anges fältet tags tre gånger i formuläret, en gång för vart och ett av värdena: Vacation, Italyoch 2017. Fältet pictures skickas en gång för varje fil i mappen 2017-Italy. Det binära innehållet i filerna i mappen skickas som värden.

Den här funktionen lades till i PowerShell 6.1.0.

Parameteregenskaper

Parameteruppsättningar

-Headers

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

Innehållsrelaterade rubriker, till exempel Content-Type, åsidosätts när en MultipartFormDataContent-objekt anges för Body.

Från och med PowerShell 7.4 används det värde som anges i parametern Content-Type om du använder den här parametern för att definiera -huvudet och använda parametern ContentType.

Parameteregenskaper

Parameteruppsättningar

-HttpVersion

Anger den HTTP-version som används för begäran. Standardvärdet är 1.1.

Giltiga värden är:

• 1.0
• 1.1
• 2.0
• 3.0

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

-MaximumFollowRelLink

Anger hur många gånger du ska följa relationslänkar om FollowRelLink- används. Ett mindre värde kan behövas om REST-API:et begränsas på grund av för många begäranden. Standardvärdet är [int32]::MaxValue. Värdet 0 (noll) förhindrar följande relationslänkar.

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

-MaximumRetryCount

Anger hur många gånger PowerShell försöker ansluta igen när en felkod mellan 400 och 599, inklusive eller 304 tas emot. Se även RetryIntervalSec parameter för att ange intervallet mellan återförsök.

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

Parametern CustomMethod kan användas för begärandemetoder som inte anges ovan.

Parameteregenskaper

Parameteruppsättningar

-NoProxy

Anger att cmdleten inte använder en proxy för att nå målet. Använd det här alternativet om du vill kringgå proxyn som konfigurerats i dina Internetinställningar eller som angetts i miljön.

Den här parametern introducerades i PowerShell 6.0.

Parameteregenskaper

Parameteruppsättningar

-OperationTimeoutSeconds

Den här tidsgränsen gäller för dataläsningar i en dataström, inte för dataströmtiden som helhet. Standardvärdet 0 anger en tidsgräns på obestämd tid.

Om värdet anges till 30 sekunder innebär det att en fördröjning på mer än 30 sekunder mellan data i dataströmmen avslutar begäran. En stor fil som tar flera minuter att ladda ned avslutas inte om inte strömmen stannar i mer än 30 sekunder.

Parameteregenskaper

Parameteruppsättningar

-OutFile

Som standard returnerar Invoke-RestMethod resultatet till pipelinen. När du använder parametern OutFile sparas resultatet i den angivna filen och returneras inte till pipelinen. Ange en sökväg och ett filnamn. Om du vill skicka resultatet till en fil och till pipelinen lägger du till parametern PassThru.

Om du utelämnar sökvägen är standardinställningen den aktuella platsen. Namnet behandlas som en bokstavlig sökväg. Namn som innehåller hakparenteser ([]) måste omges av enkla citattecken (').

Från och med PowerShell 7.4 kan du ange en mappsökväg utan filnamnet. När du gör det använder kommandot filnamn från det sista segmentet i den lösta URI:n efter eventuella omdirigeringar. När du anger en mappsökväg för OutFilekan du inte använda parametern Återuppta.

Parameteregenskaper

Parameteruppsättningar

-PassThru

Den här parametern är endast giltig när parametern OutFile också används i kommandot . Avsikten är att få resultatet skrivet till en fil och till pipelinen.

Parameteregenskaper

Parameteruppsättningar

-PreserveAuthorizationOnRedirect

Anger att cmdleten ska bevara Authorization-rubriken över omdirigeringar, när den finns.

Som standardinställning tar cmdlet-kommandot bort Authorization huvud innan den omdirigerar. Om du anger den här parametern inaktiveras logiken för fall där headern måste skickas till omdirigeringsplatsen.

Den här funktionen lades till i PowerShell 6.0.0.

Parameteregenskaper

Parameteruppsättningar

-PreserveHttpMethodOnRedirect

Kommandot anger att cmdleten ska bevara förfrågans metod vid omdirigeringar.

Som standard ändrar cmdleten metoden till GET när den omdirigeras. Om du anger den här parametern inaktiveras den här logiken för att säkerställa att den avsedda metoden kan användas med omdirigering.

Den här funktionen har lagts till i PowerShell 7.4.

Parameteregenskaper

Parameteruppsättningar

-Proxy

Använder en proxyserver för begäran i stället för att ansluta direkt till Internetresursen. Ange URI (Uniform Resource Identifier) för en nätverksproxyserver.

Den här funktionen lades till i PowerShell 6.0.0.

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

Använder autentiseringsuppgifterna för den aktuella användaren 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

-ResponseHeadersVariable

Skapar en variabel som innehåller en ordlista för svarsrubriker. Ange ett variabelnamn utan symbolen dollartecken ($). Nycklarna i ordlistan innehåller fältnamnen och värdena för svarshuvudet som returneras av webbservern.

Den här funktionen lades till i PowerShell 6.0.0.

Parameteregenskaper

Parameteruppsättningar

-Resume

Utför ett bästa försök att återuppta nedladdningen av en partiell fil. Parametern Resume kräver parametern OutFile.

Återuppta fungerar bara på storleken på den lokala filen och fjärrfilen och utför ingen annan verifiering av att den lokala filen och fjärrfilen är desamma.

Om den lokala filstorleken är mindre än fjärrfilens storlek försöker cmdleten att återuppta nedladdningen av filen och lägga till de återstående byteen i slutet av filen.

Om den lokala filstorleken är samma som fjärrfilens storlek vidtas ingen åtgärd och cmdleten förutsätter att nedladdningen redan har slutförts.

Om den lokala filstorleken är större än fjärrfilens storlek skrivs den lokala filen över och hela fjärrfilen laddas ned igen. Det här beteendet är detsamma som att använda OutFile utan återuppta.

Om fjärrservern inte stöder återupptagning av nedladdning skrivs den lokala filen över och hela fjärrfilen laddas ned igen. Det här beteendet är detsamma som att använda OutFile utan återuppta.

Om den lokala filen inte finns skapas den lokala filen och hela fjärrfilen laddas ned. Det här beteendet är detsamma som att använda OutFile utan återuppta.

Den här funktionen lades till i PowerShell 6.1.0.

Parameteregenskaper

Parameteruppsättningar

-RetryIntervalSec

Anger intervallet mellan återförsök för anslutningen när en felkod mellan 400 och 599, inklusive eller 304 tas emot. Värdet måste vara mellan 1 och [int]::MaxValue. När felkoden är 429 och svaret innehåller egenskapen Försök igen efter i dess huvuden använder cmdleten det värdet för återförsöksintervallet, även om den här parametern har angetts.

Se även parametern MaximumRetryCount för att ange antalet återförsök.

Parameteregenskaper

Parameteruppsättningar

-SessionVariable

Skapar en variabel som innehåller webbbegärandesessionen. Ange ett variabelnamn utan symbolen dollartecken ($).

När du anger en sessionsvariabel skapar Invoke-RestMethod 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.

Före PowerShell 7.4 ä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.

Från och med PowerShell 7.4 är webbbegärandesessionen beständig så länge egenskaperna för sessionen inte åsidosättas i en efterföljande begäran. När det sker återskapar cmdleten sessionen med de nya värdena. De beständiga sessionerna minskar kostnaderna för upprepade begäranden, vilket gör dem mycket snabbare.

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

-SkipCertificateCheck

Hoppar över certifikatverifieringskontroller som innehåller alla valideringar, till exempel förfallodatum, återkallande, betrodd rotutfärdare osv.

Den här funktionen lades till i PowerShell 6.0.0.

Parameteregenskaper

Parameteruppsättningar

-SkipHeaderValidation

Anger att cmdleten ska lägga till rubriker i begäran utan validering.

Den här växeln ska användas för webbplatser som kräver rubrikvärden som inte följer standarder. Genom att ange den här växeln inaktiveras valideringen och tillåter att värdet skickas utan kontroll. När du anger det läggs alla rubriker till utan validering.

Den här växeln inaktiverar validering av värden som skickas till parametrarna ContentType, Headersoch UserAgent.

Den här funktionen lades till i PowerShell 6.0.0.

Parameteregenskaper

Parameteruppsättningar

-SkipHttpErrorCheck

Den här parametern gör att cmdleten ignorerar HTTP-felstatusar och fortsätter att bearbeta svar. Felsvaren skrivs till pipelinen precis som om de lyckades.

Den här parametern introducerades i PowerShell 7.

Parameteregenskaper

Parameteruppsättningar

-SslProtocol

Anger de SSL/TLS-protokoll som är tillåtna för webbbegäran. Som standard tillåts alla SSL/TLS-protokoll som stöds av systemet. SslProtocol tillåter begränsning till specifika protokoll i efterlevnadssyfte.

Dessa värden definieras som en flaggbaserad uppräkning. Du kan kombinera flera värden för att ange flera flaggor med hjälp av den här parametern. Värdena kan skickas till parametern SslProtocol som en matris med värden eller som en kommaavgränsad sträng med dessa värden. Cmdleten kombinerar värdena med hjälp av en binär-OR-åtgärd. Att skicka värden som en matris är det enklaste alternativet och du kan även använda tab-completion på värdena. Du kanske inte kan ange flera värden på alla plattformar.

Den här funktionen lades till i PowerShell 6.0.0. Stöd för Tls13 har lagts till i PowerShell 7.1.

Parameteregenskaper

Parameteruppsättningar

-StatusCodeVariable

Skapar en variabel som innehåller ett HTTP-statuskodresultat för begäran. Ange ett variabelnamn utan symbolen dollartecken ($).

Parametern kan identifiera lyckade meddelanden eller felmeddelanden när den används med parametern SkipHttpErrorCheck.

Ange parameterns variabelnamn som en sträng, till exempel -StatusCodeVariable "scv".

Den här parametern introducerades i PowerShell 7.

Parameteregenskaper

Parameteruppsättningar

-Token

OAuth- eller Bearer-token som ska inkluderas i begäran. Token krävs för vissa alternativ för Autentisering. Det kan inte användas oberoende av varandra.

Token tar en SecureString som innehåller token. Använd följande manuellt för att ange token:

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

Den här parametern introducerades i PowerShell 6.0.

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:

• Indelad i bitar
• Komprimera
• Släppa ut luft
• GZip
• Identitet

Parameteregenskaper

Parameteruppsättningar

-UnixSocket

Anger namnet på unix-socketen som ska anslutas till. Den här parametern stöds i Unix-baserade system och Windows version 1803 och senare. Mer information om Windows-stöd för Unix-socketar finns i blogginlägget Windows/WSL Interop med AF_UNIX.

Den här parametern lades till i PowerShell 7.4.

Parameteregenskaper

Parameteruppsättningar

-Uri

Anger URI (Uniform Resource Identifier) för den Internetresurs som webbbegäran skickas till. 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

Den här parametern är inaktuell. Från och med PowerShell 6.0.0 använder alla webbbegäranden endast grundläggande parsning. Den här parametern ingår endast för bakåtkompatibilitet. När den används har den ingen effekt på cmdletens funktion.

Parameteregenskaper

Parameteruppsättningar

-UseDefaultCredentials

Anger att cmdleten använder den aktuella användarens autentiseringsuppgifter för att skicka webbbegäran. Detta kan inte användas med autentisering eller autentiseringsuppgifter och stöds kanske inte på alla plattformar.

Parameteregenskaper

Parameteruppsättningar

-UserAgent

Anger en användaragentsträng för webbbegäran.

Standardanvändaragenten liknar Mozilla/5.0 (Windows NT 10.0; Microsoft Windows 10.0.15063; en-US) PowerShell/6.0.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 klassen PSUserAgent, till exempel Chrome, Firefox, InternetExplorer, Opera och Safari.

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. Innehållsrelaterade rubriker, till exempel Content-Type, åsidosätts när ett MultipartFormDataContent-objekt anges för Body.

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-RestMethod kommando. Invoke-RestMethod 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

Int64

String

XmlDocument

PSObject

Kommentarer

Relaterade länkar

• ConvertTo-Json
• ConvertFrom-Json
• Invoke-WebRequest