Invoke-RestMethod

Referentie

Module:: Microsoft.PowerShell.Utility

Verzendt een HTTP- of HTTPS-aanvraag naar een RESTful-webservice.

Syntaxis

Invoke-RestMethod
      [-Method <WebRequestMethod>]
      [-UseBasicParsing]
      [-Uri] <Uri>
      [-WebSession <WebRequestSession>]
      [-SessionVariable <String>]
      [-Credential <PSCredential>]
      [-UseDefaultCredentials]
      [-CertificateThumbprint <String>]
      [-Certificate <X509Certificate>]
      [-UserAgent <String>]
      [-DisableKeepAlive]
      [-TimeoutSec <Int32>]
      [-Headers <IDictionary>]
      [-MaximumRedirection <Int32>]
      [-Proxy <Uri>]
      [-ProxyCredential <PSCredential>]
      [-ProxyUseDefaultCredentials]
      [-Body <Object>]
      [-ContentType <String>]
      [-TransferEncoding <String>]
      [-InFile <String>]
      [-OutFile <String>]
      [-PassThru]
      [<CommonParameters>]

Description

De Invoke-RestMethod cmdlet verzendt HTTP- en HTTPS-aanvragen naar REST-webservices (Representational State Transfer) die uitgebreide gestructureerde gegevens retourneren.

Windows PowerShell formatteert het antwoord op basis van het gegevenstype. Voor een RSS- of ATOM-feed retourneert Windows PowerShell de XML-knooppunten Item of Entry. Voor JavaScript Object Notation (JSON) of XML converteert Windows PowerShell de inhoud naar objecten (of deserialisatie).

Deze cmdlet wordt geïntroduceerd in Windows PowerShell 3.0.

Notitie

Standaard kan scriptcode op de webpagina worden uitgevoerd wanneer de pagina wordt geparseerd om de eigenschap ParsedHtml te vullen. Gebruik de -UseBasicParsing schakeloptie om dit te onderdrukken.

Voorbeelden

Voorbeeld 1: De PowerShell RSS-feed ophalen

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

Deze opdracht maakt gebruik van de Invoke-RestMethod cmdlet om informatie op te halen uit de RSS-feed van de PowerShell-blog. De opdracht gebruikt de Format-Table cmdlet om de waarden van de Title en pubDate eigenschappen van elke blog in een tabel weer te geven.

Voorbeeld 2

In het volgende voorbeeld voert een gebruiker Invoke-RestMethod uit om een POST-aanvraag uit te voeren op een intranetwebsite in de organisatie van de gebruiker.

$Cred = Get-Credential

# Next, allow the use of self-signed SSL certificates.

[System.Net.ServicePointManager]::ServerCertificateValidationCallback = { $True }

# Create variables to store the values consumed by the Invoke-RestMethod command.
# The search variable contents are later embedded in the body variable.

$Server = 'server.contoso.com'
$Url = "https://${server}:8089/services/search/jobs/export"
$Search = "search index=_internal | reverse | table index,host,source,sourcetype,_raw"

# The cmdlet handles URL encoding. The body variable describes the search criteria, specifies CSV as the output mode, and specifies a time period for returned data that starts two days ago and ends one day ago. The body variable specifies values for parameters that apply to the particular REST API with which Invoke-RestMethod is communicating.

$Body = @{
    search = $Search
    output_mode = "csv"
    earliest_time = "-2d@d"
    latest_time = "-1d@d"
}

# Now, run the Invoke-RestMethod command with all variables in place, specifying a path and file name for the resulting CSV output file.

Invoke-RestMethod -Method Post -Uri $url -Credential $Cred -Body $body -OutFile output.csv

{"preview":true,"offset":0,"result":{"sourcetype":"contoso1","count":"9624"}}

{"preview":true,"offset":1,"result":{"sourcetype":"contoso2","count":"152"}}

{"preview":true,"offset":2,"result":{"sourcetype":"contoso3","count":"88494"}}

{"preview":true,"offset":3,"result":{"sourcetype":"contoso4","count":"15277"}}

Voorbeeld 3: Meerdere headers doorgeven

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

API's vereisen vaak doorgegeven headers voor verificatie, validatie, enzovoort.

In dit voorbeeld ziet u hoe u meerdere headers vanuit een hash-table doorgeeft aan een REST API.

Parameters

-Body

Hiermee geeft u de hoofdtekst van de aanvraag. De hoofdtekst is de inhoud van de aanvraag die de headers volgt. U kunt ook een hoofdwaarde doorsluisen naar Invoke-RestMethod.

De parameter -Body kan worden gebruikt om een lijst met queryparameters op te geven of de inhoud van het antwoord op te geven.

Wanneer de invoer een GET-aanvraag is en de hoofdtekst een IDictionary is (meestal een hash-tabel), wordt de hoofdtekst als queryparameters toegevoegd aan de URI. Voor andere aanvraagtypen (zoals POST) wordt de hoofdtekst ingesteld als de waarde van de aanvraagbody in de standaardnaam=waardenotatie.

Waarschuwing: De uitgebreide uitvoer van een POST-hoofdtekst eindigt met with -1-byte payload, ook al is de grootte van de hoofdtekst zowel bekend als verzonden in de Content-Length HTTP-header.

Wanneer de hoofdtekst een formulier is of als uitvoer van een andere Invoke-WebRequest aanroep, stelt Windows PowerShell de aanvraaginhoud in op de formuliervelden.

Bijvoorbeeld:

$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.Forms[0]

Type:	Object
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	True
Jokertekens accepteren:	False

-Certificate

Hiermee geeft u het clientcertificaat op dat wordt gebruikt voor een beveiligde webaanvraag. Voer een variabele in die een certificaat of een opdracht of expressie bevat die het certificaat ophaalt.

Als u een certificaat wilt zoeken, gebruikt u Get-PfxCertificate of gebruikt u de Get-ChildItem-cmdlet in het certificaatstation (Cert:). Als het certificaat niet geldig is of onvoldoende autoriteit heeft, mislukt de opdracht.

Type:	X509Certificate
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-CertificateThumbprint

Hiermee geeft u het certificaat voor de digitale openbare sleutel (X509) van een gebruikersaccount op dat gemachtigd is om de aanvraag te verzenden. Voer de vingerafdruk van het certificaat in.

Certificaten worden gebruikt in verificatie op basis van clientcertificaten. Ze kunnen alleen worden toegewezen aan lokale gebruikersaccounts; ze werken niet met domeinaccounts.

Als u een vingerafdruk van een certificaat wilt ophalen, gebruikt u de opdracht Get-Item of Get-ChildItem in het Windows PowerShell-station (Cert:).

Type:	String
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-ContentType

Hiermee geeft u het inhoudstype van de webaanvraag op.

Als deze parameter wordt weggelaten en de aanvraagmethode POST is, Invoke-RestMethod stelt het inhoudstype in op 'application/x-www-form-urlencoded'. Anders wordt het inhoudstype niet opgegeven in de aanroep.

Type:	String
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-Credential

Hiermee geeft u een gebruikersaccount op dat gemachtigd is om de aanvraag te verzenden. De standaardwaarde is de huidige gebruiker.

Typ een gebruikersnaam, zoals 'User01' of 'Domain01\User01', of voer een PSCredential--object in, zoals een object dat is gegenereerd door de Get-Credential-cmdlet.

Type:	PSCredential
Position:	Named
Default value:	Current user
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-DisableKeepAlive

Hiermee stelt u de KeepAlive--waarde in de HTTP-header in op False. Standaard is KeepAlive- Waar. KeepAlive- brengt een permanente verbinding tot stand met de server om volgende aanvragen te vergemakkelijken.

Type:	SwitchParameter
Position:	Named
Default value:	KeepAlive
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-Headers

Hiermee geeft u de headers van de webaanvraag. Voer een hash-tabel of -woordenlijst in.

Als u UserAgent-headers wilt instellen, gebruikt u de parameter -UserAgent. U kunt deze parameter niet gebruiken om UserAgent- of cookieheaders op te geven.

Type:	IDictionary
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-InFile

Hiermee haalt u de inhoud van de webaanvraag op uit een bestand.

Voer een pad en bestandsnaam in. Als u het pad weglaat, is de standaardlocatie de huidige locatie.

Type:	String
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-MaximumRedirection

Bepaalt hoe vaak Windows PowerShell een verbinding omleidt naar een alternatieve URI (Uniform Resource Identifier) voordat de verbinding mislukt. De standaardwaarde is 5. Een waarde van 0 (nul) voorkomt dat alle omleidingen worden omgeleid.

Type:	Int32
Position:	Named
Default value:	5
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-Method

Hiermee geeft u de methode op die wordt gebruikt voor de webaanvraag. De acceptabele waarden voor deze parameter zijn:

Verstek
Verwijderen
Toevoegen
Hoofd
Fuseren
Opties
Lap
Verzenden
Zetten
Spoor

Type:	WebRequestMethod
Geaccepteerde waarden:	Default, Get, Head, Post, Put, Delete, Trace, Options, Merge, Patch
Position:	Named
Default value:	Default
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-OutFile

Slaat de hoofdtekst van het antwoord op in het opgegeven uitvoerbestand. Voer een pad en bestandsnaam in. Als u het pad weglaat, is de standaardlocatie de huidige locatie.

Standaard retourneert Invoke-RestMethod de resultaten naar de pijplijn. Als u de resultaten naar een bestand en naar de pijplijn wilt verzenden, gebruikt u de parameter -Passthru.

Type:	String
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-PassThru

Retourneert de resultaten, naast het schrijven ervan naar een bestand. Deze parameter is alleen geldig wanneer de -OutFile parameter ook wordt gebruikt in de opdracht.

Type:	SwitchParameter
Position:	Named
Default value:	No output
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-Proxy

Maakt gebruik van een proxyserver voor de aanvraag, in plaats van rechtstreeks verbinding te maken met de internetresource. Voer de URI van een netwerkproxyserver in.

Type:	Uri
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-ProxyCredential

Hiermee geeft u een gebruikersaccount op dat is gemachtigd voor het gebruik van de proxyserver die is opgegeven door de parameter -Proxy. De standaardwaarde is de huidige gebruiker.

Typ een gebruikersnaam, zoals 'User01' of 'Domain01\User01', of voer een PSCredential--object in, zoals een object dat is gegenereerd door de Get-Credential-cmdlet.

Deze parameter is alleen geldig wanneer de -Proxy parameter ook wordt gebruikt in de opdracht. U kunt de parameters -ProxyCredential en -ProxyUseDefaultCredentials niet gebruiken in dezelfde opdracht.

Type:	PSCredential
Position:	Named
Default value:	Current user
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-ProxyUseDefaultCredentials

Gebruikt de referenties van de huidige gebruiker voor toegang tot de proxyserver die is opgegeven door de parameter -Proxy.

Type:	SwitchParameter
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-SessionVariable

Hiermee maakt u een webaanvraagsessie en slaat u deze op in de waarde van de opgegeven variabele. Voer een variabelenaam in zonder het dollarteken ($) symbool.

Wanneer u een sessievariabele opgeeft, maakt Invoke-RestMethod een sessieobject voor webaanvragen en wijst deze toe aan een variabele met de opgegeven naam in uw Windows PowerShell-sessie. U kunt de variabele in uw sessie gebruiken zodra de opdracht is voltooid.

In tegenstelling tot een externe sessie is de webaanvraagsessie geen permanente verbinding. Het is een object dat informatie bevat over de verbinding en de aanvraag, waaronder cookies, referenties, de maximale omleidingswaarde en de tekenreeks van de gebruikersagent. U kunt deze gebruiken om status en gegevens te delen tussen webaanvragen.

Als u de sessie met webaanvragen wilt gebruiken in volgende webaanvragen, geeft u de sessievariabele op in de waarde van de parameter -WebSession. Windows PowerShell gebruikt de gegevens in het sessieobject voor webaanvragen bij het tot stand brengen van de nieuwe verbinding. Als u een waarde in de webaanvraagsessie wilt overschrijven, gebruikt u een cmdlet-parameter, zoals -UserAgent of -Credential. Parameterwaarden hebben voorrang op waarden in de webaanvraagsessie.

U kunt de parameters -SessionVariable en -WebSession niet gebruiken in dezelfde opdracht.

Type:	String
Aliassen:	SV
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-TimeoutSec

Hiermee geeft u op hoe lang de aanvraag in behandeling kan zijn voordat er een time-out optreedt. Voer een waarde in seconden in. De standaardwaarde, 0, geeft een onbepaalde time-out op.

Het kan tot 15 seconden duren voordat een DNS-query (Domain Name System) retourneert of een time-out optreedt. Als uw aanvraag een hostnaam bevat waarvoor een oplossing is vereist en u TimeoutSec instelt op een waarde die groter is dan nul, maar minder dan 15 seconden, kan het 15 seconden of langer duren voordat een WebException wordt gegenereerd en er een time-out optreedt voor uw aanvraag.

Type:	Int32
Position:	Named
Default value:	0
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-TransferEncoding

Hiermee geeft u een waarde op voor de http-antwoordheader voor overdrachtscodering. De acceptabele waarden voor deze parameter zijn:

Gesegmenteerd
Comprimeren
Deflate
GZip
Identiteit

Type:	String
Geaccepteerde waarden:	chunked, compress, deflate, gzip, identity
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-Uri

Hiermee geeft u de URI (Uniform Resource Identifier) van de internetresource waarnaar de webaanvraag wordt verzonden. Deze parameter ondersteunt HTTP-, HTTPS-, FTP- en FILE-waarden.

Deze parameter is vereist. De parameternaam (-Uri) is optioneel.

Type:	Uri
Position:	0
Default value:	None
Vereist:	True
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-UseBasicParsing

Geeft aan dat de cmdlet basisparsering gebruikt. De cmdlet retourneert de onbewerkte HTML in een Tekenreeks-object.

Type:	SwitchParameter
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-UseDefaultCredentials

Gebruikt de referenties van de huidige gebruiker om de webaanvraag te verzenden.

Type:	SwitchParameter
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-UserAgent

Hiermee geeft u een tekenreeks voor de gebruikersagent voor de webaanvraag op.

De standaardgebruikersagent is vergelijkbaar met Mozilla/5.0 (Windows NT; Windows NT 6.1; en-US) WindowsPowerShell/3.0" met lichte variaties voor elk besturingssysteem en platform.

Als u een website wilt testen met de standaardtekenreeks van de gebruikersagent die door de meeste internetbrowsers wordt gebruikt, gebruikt u de eigenschappen van de PSUserAgent-klasse, zoals Chrome, FireFox, Internet Explorer, Opera en Safari.

De volgende opdracht maakt bijvoorbeeld gebruik van de tekenreeks van de gebruikersagent voor internet

Invoke-WebRequest -Uri https://website.com/ -UserAgent ([Microsoft.PowerShell.Commands.PSUserAgent]::InternetExplorer)

Type:	String
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-WebSession

Hiermee geeft u een webaanvraagsessie. Voer de naam van de variabele in, inclusief het dollarteken ($).

Als u een waarde in de webaanvraagsessie wilt overschrijven, gebruikt u een cmdlet-parameter, zoals -UserAgent of -Credential. Parameterwaarden hebben voorrang op waarden in de webaanvraagsessie.

Als u een webaanvraagsessie wilt maken, voert u een variabelenaam (zonder dollarteken) in de waarde van de parameter -SessionVariable van een Invoke-RestMethod opdracht in. Invoke-RestMethod maakt de sessie en slaat deze op in de variabele. In volgende opdrachten gebruikt u de variabele als de waarde van de parameter -WebSession.

U kunt de parameters -SessionVariable en -WebSession niet gebruiken in dezelfde opdracht.

Type:	WebRequestSession
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

Invoerwaarden

Object

U kunt de hoofdtekst van een webaanvraag doorsluisen naar Invoke-RestMethod.

Uitvoerwaarden

System.Xml.XmlDocument, Microsoft.PowerShell.Commands.HtmlWebResponseObject, System.String

De uitvoer van de cmdlet is afhankelijk van de indeling van de inhoud die wordt opgehaald.

PSObject

Als de aanvraag JSON-tekenreeksen retourneert, retourneert Invoke-RestMethod een PSObject dat de tekenreeksen vertegenwoordigt.

Delen via

Invoke-RestMethod

Syntaxis

Description

Voorbeelden

Voorbeeld 1: De PowerShell RSS-feed ophalen

Voorbeeld 2

Voorbeeld 3: Meerdere headers doorgeven

Parameters

-Body

-Certificate

-CertificateThumbprint

-ContentType

-Credential

-DisableKeepAlive

-Headers

-InFile

-MaximumRedirection

-Method

-OutFile

-PassThru

-Proxy

-ProxyCredential

-ProxyUseDefaultCredentials

-SessionVariable

-TimeoutSec

-TransferEncoding

-Uri

-UseBasicParsing

-UseDefaultCredentials

-UserAgent

-WebSession

Invoerwaarden

Uitvoerwaarden

Aanvullende resources

Delen via

Invoke-RestMethod

Syntaxis

Description

Voorbeelden

Voorbeeld 1: De PowerShell RSS-feed ophalen

Voorbeeld 2

Voorbeeld 3: Meerdere headers doorgeven

Parameters

-Body

-Certificate

-CertificateThumbprint

-ContentType

-Credential

-DisableKeepAlive

-Headers

-InFile

-MaximumRedirection

-Method

-OutFile

-PassThru

-Proxy

-ProxyCredential

-ProxyUseDefaultCredentials

-SessionVariable

-TimeoutSec

-TransferEncoding

-Uri

-UseBasicParsing

-UseDefaultCredentials

-UserAgent

-WebSession

Invoerwaarden

Uitvoerwaarden

Verwante koppelingen

Aanvullende resources