Invoke-RestMethod
Verzendt een HTTP- of HTTPS-aanvraag naar een RESTful-webservice.
Syntax
Invoke-RestMethod
[-Method <WebRequestMethod>]
[-FollowRelLink]
[-MaximumFollowRelLink <Int32>]
[-ResponseHeadersVariable <String>]
[-StatusCodeVariable <String>]
[-UseBasicParsing]
[-Uri] <Uri>
[-HttpVersion <Version>]
[-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]
[-SkipHttpErrorCheck]
[-PreserveAuthorizationOnRedirect]
[-SkipHeaderValidation]
[<CommonParameters>] Invoke-RestMethod
[-Method <WebRequestMethod>]
[-FollowRelLink]
[-MaximumFollowRelLink <Int32>]
[-ResponseHeadersVariable <String>]
[-StatusCodeVariable <String>]
[-UseBasicParsing]
[-Uri] <Uri>
[-HttpVersion <Version>]
[-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]
[-SkipHttpErrorCheck]
[-PreserveAuthorizationOnRedirect]
[-SkipHeaderValidation]
[<CommonParameters>] Invoke-RestMethod
-CustomMethod <String>
[-FollowRelLink]
[-MaximumFollowRelLink <Int32>]
[-ResponseHeadersVariable <String>]
[-StatusCodeVariable <String>]
[-UseBasicParsing]
[-Uri] <Uri>
[-HttpVersion <Version>]
[-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]
[-SkipHttpErrorCheck]
[-PreserveAuthorizationOnRedirect]
[-SkipHeaderValidation]
[<CommonParameters>] Invoke-RestMethod
-CustomMethod <String>
[-FollowRelLink]
[-MaximumFollowRelLink <Int32>]
[-ResponseHeadersVariable <String>]
[-StatusCodeVariable <String>]
[-UseBasicParsing]
[-Uri] <Uri>
[-HttpVersion <Version>]
[-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]
[-SkipHttpErrorCheck]
[-PreserveAuthorizationOnRedirect]
[-SkipHeaderValidation]
[<CommonParameters>] Description
De Invoke-RestMethod cmdlet verzendt HTTP- en HTTPS-aanvragen naar REST-webservices (Representational State Transfer) die uitgebreid gestructureerde gegevens retourneren.
PowerShell formatteert het antwoord op basis van het gegevenstype. Voor een RSS- of ATOM-feed retourneert PowerShell de XML-knooppunten Item of Entry. Voor JavaScript Object Notation (JSON) of XML converteert PowerShell de inhoud naar [PSCustomObject] objecten of deserialisaties.
Notitie
Wanneer het REST-eindpunt meerdere objecten retourneert, worden de objecten ontvangen als een matrix. Als u de uitvoer doorsluist naar Invoke-RestMethod een andere opdracht, wordt deze als één [Object[]] object verzonden. De inhoud van die matrix wordt niet opgesomd voor de volgende opdracht in de pijplijn.
Deze cmdlet is geïntroduceerd in Windows PowerShell 3.0.
Vanaf PowerShell 7.0 ondersteunt proxyconfiguratie die Invoke-RestMethod is gedefinieerd door omgevingsvariabelen. Zie de sectie Notities van dit artikel.
Voorbeelden
Voorbeeld 1: De PowerShell RSS-feed ophalen
In dit voorbeeld wordt de Invoke-RestMethod cmdlet gebruikt 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 eigenschappen Title en pubDate van elke blog in een tabel weer te geven.
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 +0000Voorbeeld 2: een POST-aanvraag uitvoeren
In dit voorbeeld voert een gebruiker uit Invoke-RestMethod om een POST-aanvraag uit te voeren op een intranetwebsite in de organisatie van de gebruiker.
$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.csvDe referenties worden gevraagd en vervolgens opgeslagen in $Cred en de URL die toegang krijgt, wordt gedefinieerd in $Url.
De $Body variabele beschrijft de zoekcriteria, geeft CSV op als de uitvoermodus en geeft een tijdsperiode op voor geretourneerde gegevens die twee dagen geleden begint en een dag geleden eindigt. De hoofdvariabele geeft waarden op voor parameters die van toepassing zijn op de specifieke REST API waarmee Invoke-RestMethod wordt gecommuniceerd.
De Invoke-RestMethod opdracht wordt uitgevoerd met alle variabelen, waarbij een pad en bestandsnaam voor het resulterende CSV-uitvoerbestand worden opgegeven.
Voorbeeld 3: Relatiekoppelingen volgen
Sommige REST API's ondersteunen paginering via relationele koppelingen per RFC5988. In plaats van de header te parseren om de URL voor de volgende pagina op te halen, kunt u de cmdlet dit voor u laten doen. In dit voorbeeld worden de eerste twee pagina's met problemen uit de PowerShell GitHub-opslagplaats geretourneerd.
$url = 'https://api.github.com/repos/powershell/powershell/issues'
Invoke-RestMethod $url -FollowRelLink -MaximumFollowRelLink 2Voorbeeld 4: vereenvoudigde verzending van meerdelige/formuliergegevens
Voor sommige API's zijn indieningen vereist multipart/form-data voor het uploaden van bestanden en gemengde inhoud. In dit voorbeeld ziet u hoe u het profiel van een gebruiker bijwerkt.
$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 $FormVoor het profielformulier zijn de volgende velden vereist: firstName, lastName, email, avatar, birthdayen hobbies. De API verwacht een afbeelding voor de gebruikersprofielafbeelding die in het avatar veld moet worden opgegeven. De API accepteert ook meerdere hobbies vermeldingen die in hetzelfde formulier moeten worden ingediend.
Bij het maken van de $Form HashTable worden de sleutelnamen gebruikt als formulierveldnamen. Standaard worden de waarden van de HashTable geconverteerd naar tekenreeksen. Als er een System.IO.FileInfo waarde aanwezig is, wordt de bestandsinhoud verzonden. Als een verzameling zoals matrices of lijsten aanwezig is, wordt het formulierveld meerdere keren verzonden.
Door op de avatar sleutel te gebruikenGet-Item, wordt het FileInfo object ingesteld als de waarde. Het resultaat is dat de afbeeldingsgegevens voor jdoe.png worden verzonden.
Door een lijst op te geven aan de hobbies sleutel, wordt het hobbies veld eenmaal voor elk lijstitem in de inzendingen weergegeven.
Voorbeeld 5: meerdere headers doorgeven
API's vereisen vaak doorgegeven headers voor verificatie of validatie. In dit voorbeeld ziet u hoe u meerdere headers van een hash-table doorgeeft aan een REST API.
$headers = @{
'userId' = 'UserIDValue'
'token' = 'TokenValue'
}
Invoke-RestMethod -Uri $uri -Method Post -Headers $headers -Body $bodyVoorbeeld 6: Geretourneerde items in de pijplijn inventariseren
GitHub retourneert meerdere objecten per matrix. Als u de uitvoer doorsluist naar een andere opdracht, wordt deze als één object verzonden [Object[]].
Als u de objecten in de pijplijn wilt opsommen, sluist u de resultaten door naar Write-Output of verpakt u de cmdlet tussen haakjes. In het volgende voorbeeld wordt het aantal objecten geteld dat door GitHub wordt geretourneerd. Vervolgens wordt het aantal objecten geteld dat voor de pijplijn is geïnventariseerd.
$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
30Voorbeeld 7: Validatie van header overslaan
Standaard valideert de Invoke-RestMethod cmdlet de waarden van bekende headers die een standaard gedefinieerde waarde-indeling hebben. In het volgende voorbeeld ziet u hoe deze validatie een fout kan veroorzaken en hoe u de parameter SkipHeaderValidation kunt gebruiken om te voorkomen dat waarden worden gevalideerd voor eindpunten die ongeldig opgemaakte waarden tolereren.
$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}httpbin.org is een service die informatie retourneert over webaanvragen en antwoorden voor probleemoplossing. De $Uri variabele wordt toegewezen aan het /headers eindpunt van de service, die de headers van een aanvraag retourneert als de inhoud in het antwoord.
De If-Match aanvraagheader is gedefinieerd in RFC-7232 sectie 3.1 en vereist dat de waarde voor die header wordt gedefinieerd met omringende aanhalingstekens. Aan $InvalidHeaders de variabele wordt een hashtabel toegewezen waarbij de waarde van If-Match ongeldig is omdat deze is gedefinieerd als 12345 in plaats van "12345".
Als u aanroept Invoke-RestMethod met de ongeldige headers, wordt een foutrapportage geretourneerd dat de opgemaakte waarde ongeldig is. De aanvraag wordt niet verzonden naar het eindpunt.
Als u aanroept Invoke-RestMethod met de parameter SkipHeaderValidation , wordt de validatiefout genegeerd en wordt de aanvraag naar het eindpunt verzonden. Omdat het eindpunt niet-compatibele headerwaarden tolereert, retourneert de cmdlet het antwoordobject zonder fouten.
Voorbeeld 8: Een aanvraag verzenden met BEHULP van HTTP 2.0
In dit voorbeeld wordt een query uitgevoerd op een GitHub-probleem met behulp van het HTTP 2.0-protocol.
$uri = 'https://api.github.com/repos/microsoftdocs/powershell-docs/issues'
Invoke-RestMethod -Uri $uri -HttpVersion 2.0 -SkipCertificateCheckParameters
-AllowUnencryptedAuthentication
Hiermee kunt u referenties en geheimen verzenden via niet-versleutelde verbindingen. Standaard resulteert het opgeven van referentie of een verificatieoptie met een URI die niet begint met https:// een fout en wordt de aanvraag afgebroken om te voorkomen dat geheimen in tekst zonder opmaak worden gecommuniceerd via niet-versleutelde verbindingen. Als u dit gedrag op eigen risico wilt overschrijven, geeft u de parameter AllowUnencryptedAuthentication op.
Waarschuwing
Het gebruik van deze parameter is niet veilig en wordt niet aanbevolen. Het wordt alleen verstrekt voor compatibiliteit met verouderde systemen die geen versleutelde verbindingen kunnen bieden. Gebruik op eigen risico.
Deze functie is toegevoegd in PowerShell 6.0.0.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Authentication
Hiermee geeft u het expliciete verificatietype op dat moet worden gebruikt voor de aanvraag. De standaardwaarde is None. De parameter Authentication kan niet worden gebruikt met de parameter UseDefaultCredentials .
Beschikbare verificatieopties:
None: Dit is de standaardoptie wanneer verificatie niet is opgegeven. Er wordt geen expliciete verificatie gebruikt.Basic: Vereist referentie. De referenties worden gebruikt voor het verzenden van een RFC 7617 Basic Authentication-headerAuthorization: Basicin de indeling vanbase64(user:password).Bearer: vereist de parameter Token . Verzendt een RFC 6750-headerAuthorization: Bearermet het opgegeven token.OAuth: vereist de parameter Token . Verzendt een RFC 6750-headerAuthorization: Bearermet het opgegeven token.
Het opgeven van verificatie overschrijft alle Authorization headers die zijn opgegeven aan headers of opgenomen in WebSession.
Deze functie is toegevoegd in 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
Hiermee geeft u de hoofdtekst van de aanvraag op. De hoofdtekst is de inhoud van de aanvraag die volgt op de headers.
U kunt ook een body-waarde doorsnijden 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 POST-aanvraag is en de hoofdtekst een tekenreeks is, wordt de waarde links van het eerste gelijkteken (=) ingesteld als een sleutel in de formuliergegevens en wordt de resterende tekst ingesteld als de waarde. Als u meerdere sleutels wilt opgeven, gebruikt u een IDictionary-object , zoals een hash-tabel, voor de hoofdtekst.
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 PATCH) wordt de hoofdtekst ingesteld als de waarde van de aanvraagbody in de standaardindeling name=value met de waarden URL-codering.
Wanneer de invoer een System.Xml is. XmlNode-object en de XML-declaratie specificeren een codering, die codering wordt gebruikt voor de gegevens in de aanvraag, tenzij overschreven door de parameter ContentType .
Wanneer de hoofdtekst een formulier is of de uitvoer is van een andere Invoke-WebRequest aanroep, stelt PowerShell de aanvraaginhoud in op de formuliervelden.
De parameter Body kan ook een System.Net.Http.MultipartFormDataContent-object accepteren. Dit vereenvoudigt multipart/form-data aanvragen. Wanneer een MultipartFormDataContent-object wordt geleverd voor Body, worden alle inhoudsgerelateerde headers die worden geleverd aan de parameters ContentType, Headers of WebSession overschreven door de inhoudsheaders van het MultipartFormDataContent object. Deze functie is toegevoegd in PowerShell 6.0.0.
| Type: | Object |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | 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 waarmee het certificaat wordt ophaalt.
Als u een certificaat wilt zoeken, gebruikt Get-PfxCertificate u de Get-ChildItem cmdlet in het certificaatstation (Cert:). Als het certificaat niet geldig is of onvoldoende bevoegdheden heeft, mislukt de opdracht.
| Type: | X509Certificate |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CertificateThumbprint
Hiermee geeft u het digitale openbare sleutelcertificaat (X509) op van een gebruikersaccount dat gemachtigd is om de aanvraag te verzenden. Voer de vingerafdruk van het certificaat in.
Certificaten worden gebruikt in verificatie op basis van clientcertificaten. Certificaten kunnen alleen worden toegewezen aan lokale gebruikersaccounts, niet aan domeinaccounts.
Als u de vingerafdruk van het certificaat wilt zien, gebruikt u de Get-Item opdracht of Get-ChildItem om het certificaat te zoeken in Cert:\CurrentUser\My.
Notitie
Deze functie wordt momenteel alleen ondersteund op Windows-besturingssysteemplatforms.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ContentType
Hiermee geeft u het inhoudstype van de webaanvraag op.
Als de waarde voor ContentType de coderingsindeling (als charset) bevat, gebruikt de cmdlet die indeling om de hoofdtekst van de webaanvraag te coderen. Als het ContentType geen coderingsindeling opgeeft, wordt in plaats daarvan de standaardcoderingsindeling gebruikt. Een voorbeeld van een ContentType met een coderingsindeling is text/plain; charset=iso-8859-5, waarmee het Latijnse/Cyrillische alfabet wordt opgegeven.
Als deze parameter wordt weggelaten en de aanvraagmethode POST is, Invoke-RestMethod stelt u het inhoudstype in op application/x-www-form-urlencoded. Anders wordt het inhoudstype niet opgegeven in de aanroep.
ContentType wordt overschreven wanneer een MultipartFormDataContent object wordt opgegeven voor Hoofdtekst.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Credential
Hiermee geeft u een gebruikersaccount op dat gemachtigd is om de aanvraag te verzenden. Standaard is dit de huidige gebruiker.
Typ een gebruikersnaam, zoals User01 of Domain01\User01, of voer een PSCredential-object in dat is gegenereerd door de Get-Credential cmdlet.
Referenties kunnen alleen worden gebruikt of in combinatie met bepaalde opties voor verificatieparameters . Als deze alleen wordt gebruikt, worden alleen referenties aan de externe server verstrekt als de externe server een verificatievraag indient. Wanneer u de verificatieopties gebruikt, worden de referenties expliciet verzonden.
Referenties worden opgeslagen in een PSCredential-object en het wachtwoord wordt opgeslagen als een SecureString.
Notitie
Zie Hoe veilig is SecureString? voor meer informatie over SecureString-gegevensbeveiliging.
| Type: | PSCredential |
| Position: | Named |
| Default value: | Current user |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CustomMethod
Hiermee geeft u de aangepaste methode die wordt gebruikt voor de webaanvraag. Dit kan worden gebruikt met de aanvraagmethode die is vereist voor het eindpunt is geen beschikbare optie voor de methode. Method en CustomMethod kunnen niet samen worden gebruikt.
Voorbeeld:
Invoke-RestMethod -uri 'https://api.contoso.com/widget/' -CustomMethod 'TEST'
Hiermee wordt een TEST HTTP-aanvraag naar de API verzonden.
Deze functie is toegevoegd in PowerShell 6.0.0.
| Type: | String |
| Aliases: | CM |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DisableKeepAlive
Geeft aan dat de cmdlet de waarde KeepAlive in de HTTP-header instelt op False. KeepAlive is standaard Waar. KeepAlive brengt een permanente verbinding met de server tot stand om volgende aanvragen te vergemakkelijken.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FollowRelLink
Geeft aan dat de cmdlet relationele koppelingen moet volgen.
Sommige REST API's ondersteunen paginering via relationele koppelingen per RFC5988. In plaats van de header te parseren om de URL voor de volgende pagina op te halen, kunt u de cmdlet dit voor u laten doen. Als u wilt instellen hoe vaak relatiekoppelingen moeten worden gevolgd, gebruikt u de parameter MaximumFollowRelLink .
Wanneer u deze schakeloptie gebruikt, retourneert de cmdlet een verzameling pagina's met resultaten. Elke pagina met resultaten kan meerdere resultaatitems bevatten.
Deze functie is toegevoegd in PowerShell 6.0.0.
| Type: | SwitchParameter |
| Aliases: | FL |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Form
Converteert een woordenlijst naar een multipart/form-data inzending. Formulier mag niet worden gebruikt met Hoofdtekst.
Als ContentType wordt genegeerd.
De toetsen van de woordenlijst worden gebruikt als de namen van het formulierveld. Standaard worden formulierwaarden geconverteerd naar tekenreekswaarden.
Als de waarde een System.IO.FileInfo-object is, wordt de inhoud van het binaire bestand verzonden.
De naam van het bestand wordt verzonden als de filename. De MIME wordt ingesteld als application/octet-stream. Get-Item kan worden gebruikt om het leveren van het object System.IO.FileInfo te vereenvoudigen.
$Form = @{ resume = Get-Item 'c:\Users\jdoe\Documents\John Doe.pdf' }
Als de waarde een verzamelingstype is, zoals een matrix of lijst, wordt het veld for meerdere keren verzonden. De waarden van de lijst worden standaard behandeld als tekenreeksen. Als de waarde een System.IO.FileInfo-object is, wordt de inhoud van het binaire bestand verzonden. Geneste verzamelingen worden niet ondersteund.
$Form = @{ tags = 'Vacation', 'Italy', '2017' pictures = Get-ChildItem 'c:\Users\jdoe\Pictures\2017-Italy' }
In het bovenstaande voorbeeld wordt het tags veld drie keer in het formulier opgegeven, één keer voor elk van Vacation, Italyen 2017. Het pictures veld wordt ook eenmaal verzonden voor elk bestand in de 2017-Italy map. De binaire inhoud van de bestanden in die map wordt verzonden als de waarden.
Deze functie is toegevoegd in PowerShell 6.1.0.
| Type: | IDictionary |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Headers
Hiermee geeft u de headers van de webaanvraag. Voer een hash-tabel of woordenlijst in.
Inhoudsgerelateerde headers, zoals Content-Type , worden overschreven wanneer een MultipartFormDataContent object wordt opgegeven voor Hoofdtekst.
| Type: | IDictionary |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-HttpVersion
Hiermee geeft u de HTTP-versie die wordt gebruikt voor de aanvraag. De standaardwaarde is 1.1.
Geldige waarden zijn:
- 1.0
- 1.1
- 2,0
- 3,0
| Type: | Version |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InFile
Haalt de inhoud van de webaanvraag op uit een bestand.
Voer een pad en bestandsnaam in. Als u het pad weglaat, is de standaardwaarde de huidige locatie.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MaximumFollowRelLink
Hiermee geeft u op hoe vaak relatiekoppelingen moeten worden gevolgd als FollowRelLink wordt gebruikt. Er kan een kleinere waarde nodig zijn als de REST API wordt vertraagd vanwege te veel aanvragen. De standaardwaarde is [Int32]::MaxValue. Een waarde van 0 (nul) voorkomt het volgen van relatiekoppelingen.
| Type: | Int32 |
| Aliases: | ML |
| Position: | Named |
| Default value: | Int32.MaxValue |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MaximumRedirection
Hiermee geeft u op hoe vaak 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 alle omleiding.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MaximumRetryCount
Hiermee geeft u op hoe vaak PowerShell een verbinding opnieuw probeert uit te proberen wanneer een foutcode tussen 400 en 599, inclusief of 304 wordt ontvangen. Zie ook de parameter RetryIntervalSec voor het opgeven van het aantal seconden tussen nieuwe pogingen.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Method
Hiermee geeft u de methode die wordt gebruikt voor de webaanvraag. De aanvaardbare waarden voor deze parameter zijn:
DefaultDeleteGetHeadMergeOptionsPatchPostPutTrace
De parameter CustomMethod kan worden gebruikt voor aanvraagmethoden die hierboven niet worden vermeld.
| 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
Geeft aan dat de cmdlet geen proxy gebruikt om het doel te bereiken.
Wanneer u de proxy die is geconfigureerd in Internet Explorer of een proxy die is opgegeven in de omgeving, moet overslaan, gebruikt u deze schakeloptie.
Deze parameter is geïntroduceerd in PowerShell 6.0.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-OutFile
Slaat de antwoordtekst op in het opgegeven uitvoerbestand. Voer een pad en bestandsnaam in. Als u het pad weglaat, is de standaardwaarde de huidige locatie. De naam wordt behandeld als een letterlijk pad. Namen met vierkante haken ([]) moeten tussen enkele aanhalingstekens () worden geplaatst.'
Retourneert standaard Invoke-RestMethod de resultaten naar de pijplijn.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PassThru
Deze parameter is alleen geldig wanneer de parameter OutFile ook wordt gebruikt in de opdracht. De bedoeling is om de resultaten naar het bestand en de pijplijn te laten schrijven.
Notitie
Wanneer u de parameter PassThru gebruikt, wordt de uitvoer naar de pijplijn geschreven, maar wordt het bestand niet gemaakt. Zie PowerShell-probleem 15409 voor meer informatie.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | No output |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PreserveAuthorizationOnRedirect
Geeft aan dat de cmdlet de Authorization header moet behouden, indien aanwezig, tussen omleidingen.
Standaard verwijdert de cmdlet de Authorization header voordat deze wordt omgeleid. Als u deze parameter opgeeft, wordt deze logica uitgeschakeld voor gevallen waarin de header naar de omleidingslocatie moet worden verzonden.
Deze functie is toegevoegd in PowerShell 6.0.0.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Proxy
Gebruikt een proxyserver voor de aanvraag in plaats van rechtstreeks verbinding te maken met de internetbron. Voer de URI (Uniform Resource Identifier) van een netwerkproxyserver in.
Deze functie is toegevoegd in PowerShell 6.0.0.
| Type: | Uri |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ProxyCredential
Hiermee geeft u een gebruikersaccount op dat is gemachtigd voor het gebruik van de proxyserver die is opgegeven door de proxyparameter . Standaard is dit de huidige gebruiker.
Typ een gebruikersnaam, zoals User01 of Domain01\User01, User@Domain.Com, of voer een PSCredential object in, zoals een object dat wordt gegenereerd door de Get-Credential cmdlet.
Deze parameter is alleen geldig wanneer de proxyparameter ook wordt gebruikt in de opdracht. U kunt de parameters ProxyCredential en ProxyUseDefaultCredentials niet in dezelfde opdracht gebruiken.
| Type: | PSCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ProxyUseDefaultCredentials
Geeft aan dat de cmdlet de referenties van de huidige gebruiker gebruikt voor toegang tot de proxyserver die is opgegeven door de proxyparameter .
Deze parameter is alleen geldig wanneer de proxyparameter ook wordt gebruikt in de opdracht. U kunt de parameters ProxyCredential en ProxyUseDefaultCredentials niet in dezelfde opdracht gebruiken.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResponseHeadersVariable
Hiermee maakt u een variabele met een antwoordheaderwoordenlijst. Voer een variabelenaam in zonder het dollarteken ($). De sleutels van de woordenlijst bevatten de veldnamen en waarden van de antwoordheader die door de webserver worden geretourneerd.
Deze functie is toegevoegd in PowerShell 6.0.0.
| Type: | String |
| Aliases: | RHV |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Resume
Voert een poging uit om het downloaden van een gedeeltelijk bestand te hervatten. Voor de parameter Resume is de parameter OutFile vereist.
Hervatten werkt alleen op de grootte van het lokale bestand en het externe bestand en voert geen andere validatie uit dat het lokale bestand en het externe bestand hetzelfde zijn.
Als de lokale bestandsgrootte kleiner is dan de externe bestandsgrootte, probeert de cmdlet het downloaden van het bestand te hervatten en de resterende bytes toe te voegen aan het einde van het bestand.
Als de lokale bestandsgrootte hetzelfde is als de externe bestandsgrootte, wordt er geen actie ondernomen en wordt ervan uitgegaan dat het downloaden al is voltooid.
Als de lokale bestandsgrootte groter is dan de grootte van het externe bestand, wordt het lokale bestand overschreven en wordt het hele externe bestand volledig opnieuw gedownload. Dit gedrag is hetzelfde als het gebruik van OutFile zonder Cv.
Als de externe server het hervatten van downloaden niet ondersteunt, wordt het lokale bestand overschreven en wordt het hele externe bestand volledig opnieuw gedownload. Dit gedrag is hetzelfde als het gebruik van OutFile zonder Cv.
Als het lokale bestand niet bestaat, wordt het lokale bestand gemaakt en wordt het hele externe bestand volledig gedownload. Dit gedrag is hetzelfde als het gebruik van OutFile zonder Cv.
Deze functie is toegevoegd in PowerShell 6.1.0.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RetryIntervalSec
Hiermee geeft u het interval tussen nieuwe pogingen voor de verbinding wanneer een foutcode tussen 400 en 599, inclusief of 304 wordt ontvangen. De waarde moet tussen 1 en zijn [int]::MaxValue.
Zie ook de parameter MaximumRetryCount voor het opgeven van het aantal nieuwe pogingen.
| Type: | Int32 |
| Position: | Named |
| Default value: | 5 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SessionVariable
Hiermee maakt u een variabele die de webaanvraagsessie bevat. Voer een variabelenaam in zonder het dollarteken ($).
Wanneer u een sessievariabele opgeeft, Invoke-RestMethod maakt u een sessieobject voor webaanvragen en wijst u dit toe aan een variabele met de opgegeven naam in uw PowerShell-sessie. U kunt de variabele in uw sessie gebruiken zodra de opdracht is voltooid.
Vóór PowerShell 7.4 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 de status en gegevens te delen tussen webaanvragen.
Vanaf PowerShell 7.4 is de webaanvraagsessie permanent zolang de eigenschappen van de sessie niet worden overschreven in een volgende aanvraag. Wanneer dat zo is, maakt de cmdlet de sessie opnieuw met de nieuwe waarden. De permanente sessies verminderen de overhead voor herhaalde aanvragen, waardoor ze veel sneller worden.
Als u de webaanvraagsessie wilt gebruiken in volgende webaanvragen, geeft u de sessievariabele op in de waarde van de parameter WebSession . PowerShell gebruikt de gegevens in het sessieobject van de webaanvraag 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 in dezelfde opdracht gebruiken.
| Type: | String |
| Aliases: | SV |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SkipCertificateCheck
Hiermee worden certificaatvalidatiecontroles overgeslagen die alle validaties omvatten, zoals vervaldatum, intrekking, vertrouwde basisinstantie, enzovoort.
Waarschuwing
Het gebruik van deze parameter is niet veilig en wordt niet aanbevolen. Deze switch is alleen bedoeld om te worden gebruikt voor bekende hosts die een zelfondertekend certificaat gebruiken voor testdoeleinden. Gebruik op eigen risico.
Deze functie is toegevoegd in PowerShell 6.0.0.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SkipHeaderValidation
Geeft aan dat de cmdlet headers aan de aanvraag moet toevoegen zonder validatie.
Deze schakeloptie moet worden gebruikt voor sites waarvoor headerwaarden zijn vereist die niet voldoen aan de normen. Als u deze schakeloptie opgeeft, wordt validatie uitgeschakeld, zodat de waarde niet kan worden doorgegeven. Wanneer dit is opgegeven, worden alle headers zonder validatie toegevoegd.
Hiermee wordt validatie uitgeschakeld voor waarden die zijn doorgegeven aan de parameters ContentType, Headers en UserAgent .
Deze functie is toegevoegd in PowerShell 6.0.0.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SkipHttpErrorCheck
Deze parameter zorgt ervoor dat de cmdlet HTTP-foutstatussen negeert en reacties blijft verwerken. De foutreacties worden naar de pijplijn geschreven alsof ze zijn geslaagd.
Deze parameter is geïntroduceerd in PowerShell 7.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SslProtocol
Hiermee stelt u de SSL/TLS-protocollen in die zijn toegestaan voor de webaanvraag. Standaard zijn alle SSL/TLS-protocollen die door het systeem worden ondersteund, toegestaan. SslProtocol maakt het mogelijk om te beperken tot specifieke protocollen voor nalevingsdoeleinden.
Deze waarden worden gedefinieerd als een opsomming op basis van een vlag. U kunt meerdere waarden combineren om meerdere vlaggen in te stellen met behulp van deze parameter. De waarden kunnen worden doorgegeven aan de parameter SslProtocol als een matrix met waarden of als een door komma's gescheiden tekenreeks van deze waarden. De cmdlet combineert de waarden met behulp van een binaire-OR-bewerking. Het doorgeven van waarden als een matrix is de eenvoudigste optie en stelt u ook in staat om tabvoltooiing te gebruiken voor de waarden. Mogelijk kunt u niet op alle platforms meerdere waarden opgeven.
Notitie
Op niet-Windows-platformen is het mogelijk niet mogelijk om of Tls12 als optie te leverenTls. Ondersteuning voor Tls13 is niet beschikbaar voor alle besturingssystemen en moet per besturingssysteem worden geverifieerd.
Deze functie is toegevoegd in PowerShell 6.0.0 en ondersteuning voor Tls13 is toegevoegd in PowerShell 7.1.
| Type: | WebSslProtocol |
| Accepted values: | Default, Tls, Tls11, Tls12, Tls13 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-StatusCodeVariable
Hiermee maakt u een variabele met een HTTP-statuscoderesultaat van de aanvraag. Voer een variabelenaam in zonder het dollarteken ($).
De parameter kan succesberichten of foutberichten identificeren wanneer deze worden gebruikt met de parameter SkipHttpErrorCheck .
Voer de naam van de variabele van de parameter in als een tekenreeks, zoals -StatusCodeVariable "scv".
Deze parameter is geïntroduceerd in PowerShell 7.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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) wordt geretourneerd of een time-out optreedt. Als uw aanvraag een hostnaam bevat waarvoor omzetting 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: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Token
Het OAuth- of Bearer-token dat moet worden opgenomen in de aanvraag. Token is vereist voor bepaalde verificatieopties . Het kan niet onafhankelijk worden gebruikt.
Token gebruikt een SecureString die het token bevat. Als u het token wilt opgeven, gebruikt u het volgende handmatig:
Invoke-RestMethod -Uri $uri -Authentication OAuth -Token (Read-Host -AsSecureString)
Deze parameter is geïntroduceerd in PowerShell 6.0.
| Type: | SecureString |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TransferEncoding
Hiermee geeft u een waarde op voor de http-antwoordheader voor overdrachtcodering. De aanvaardbare waarden voor deze parameter zijn:
- Gesegmenteerd
- Comprimeren
- Deflate
- Gzip
- Identiteit
| 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
Hiermee geeft u de URI (Uniform Resource Identifier) van de internetbron 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 |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UseBasicParsing
Deze parameter is afgeschaft. Vanaf PowerShell 6.0.0 gebruiken alle webaanvragen alleen basisparsering. Deze parameter is alleen opgenomen voor achterwaartse compatibiliteit en elk gebruik ervan heeft geen invloed op de werking van de cmdlet.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UseDefaultCredentials
Geeft aan dat de cmdlet de referenties van de huidige gebruiker gebruikt om de webaanvraag te verzenden. Dit kan niet worden gebruikt met verificatie of referentie en wordt mogelijk niet op alle platforms ondersteund.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UserAgent
Hiermee geeft u een tekenreeks voor de gebruikersagent voor de webaanvraag.
De standaardgebruikersagent is vergelijkbaar met Mozilla/5.0 (Windows NT 10.0; Microsoft Windows 10.0.15063; en-US) PowerShell/6.0.0 met kleine variaties voor elk besturingssysteem en platform.
Als u een website wilt testen met de standaardtekenreeks voor de gebruikersagent die door de meeste internetbrowsers wordt gebruikt, gebruikt u de eigenschappen van de klasse PSUserAgent , zoals Chrome, FireFox, InternetExplorer, Opera en Safari.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WebSession
Hiermee geeft u een webaanvraagsessie op. 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. Inhoudsgerelateerde headers, zoals Content-Type, worden ook overschreven wanneer een MultipartFormDataContent-object wordt opgegeven voor Hoofdtekst.
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 de status en gegevens te delen tussen webaanvragen.
Als u een webaanvraagsessie wilt maken, voert u een variabelenaam in, zonder een dollarteken, in de waarde van de parameter SessionVariable van een Invoke-RestMethod opdracht. Invoke-RestMethod maakt de sessie en slaat deze op in de variabele. Gebruik in volgende opdrachten de variabele als de waarde van de parameter WebSession .
U kunt de parameters SessionVariable en WebSession niet in dezelfde opdracht gebruiken.
| Type: | WebRequestSession |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Invoerwaarden
U kunt de hoofdtekst van een webaanvraag doorsnijden naar deze cmdlet.
Uitvoerwaarden
Wanneer de aanvraag een geheel getal retourneert, retourneert deze cmdlet dat gehele getal.
Wanneer de aanvraag een tekenreeks retourneert, retourneert deze cmdlet die tekenreeks.
Wanneer de aanvraag geldige XML retourneert, retourneert deze cmdlet deze als een XmlDocument.
PSObject
Wanneer de aanvraag JSON-tekenreeksen retourneert, retourneert deze cmdlet een PSObject dat de gegevens vertegenwoordigt.
Notities
PowerShell bevat de volgende aliassen voor Invoke-RestMethod:
- Alle platformen:
irm
Sommige functies zijn mogelijk niet op alle platforms beschikbaar.
Vanwege wijzigingen in .NET Core 3.1 gebruiken PowerShell 7.0 en hoger de eigenschap HttpClient.DefaultProxy om de proxyconfiguratie te bepalen.
De waarde van deze eigenschap is afhankelijk van uw platform:
- Voor Windows: leest proxyconfiguratie uit omgevingsvariabelen of, als deze niet zijn gedefinieerd, uit de proxy-instellingen van de gebruiker.
- Voor macOS: leest proxyconfiguratie uit omgevingsvariabelen of, als deze niet zijn gedefinieerd, uit de proxy-instellingen van het systeem.
- Voor Linux: hiermee leest u de proxyconfiguratie uit omgevingsvariabelen of, als deze niet zijn gedefinieerd, initialiseert deze eigenschap een niet-geconfigureerd exemplaar dat alle adressen omzeilt.
De omgevingsvariabelen die worden gebruikt voor DefaultProxy initialisatie op Windows- en Unix-platforms zijn:
HTTP_PROXY: de hostnaam of het IP-adres van de proxyserver die wordt gebruikt voor HTTP-aanvragen.HTTPS_PROXY: de hostnaam of het IP-adres van de proxyserver die wordt gebruikt voor HTTPS-aanvragen.ALL_PROXY: de hostnaam of het IP-adres van de proxyserver die wordt gebruikt voor HTTP- en HTTPS-aanvragen voor het gevalHTTP_PROXYdatHTTPS_PROXYniet is gedefinieerd.NO_PROXY: een door komma's gescheiden lijst met hostnamen die moeten worden uitgesloten van proxying.