Invoke-RestMethod

Modul:

Microsoft.PowerShell.Utility Module

HTTP- vagy HTTPS-kérést küld egy RESTful webszolgáltatásnak.

Syntax

Default (Alapértelmezett)

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

A Invoke-RestMethod parancsmag HTTP- és HTTPS-kéréseket küld az Representational State Transfer (REST) webszolgáltatásoknak, amelyek gazdagon strukturált adatokat adnak vissza.

A PowerShell az adattípusnak megfelelően formázja a választ. RSS- vagy ATOM-hírcsatornák esetén a PowerShell az Elem vagy a Bejegyzés XML-csomópontot adja vissza. JavaScript Object Notation (JSON) vagy XML esetén a PowerShell átalakítja vagy deszerializálja a tartalmat [pscustomobject] objektumokká. A JSON-adatok nem engedélyezik a megjegyzéseket.

Figyelmeztetés

Alapértelmezés szerint Invoke-RestMethod elemzi a weblap tartalmát. Előfordulhat, hogy a weblap szkriptkódja a lap elemzésekor fut. A kapcsolóval elkerülheti a -UseBasicParsing szkriptkódok végrehajtását.

Ezt a parancsmagot a Windows PowerShell 3.0-ban vezettük be. Ez a parancs az irm alias használatával futtatható.

Példák

1. példa: A PowerShell RSS-hírcsatornájának lekérése

Invoke-RestMethod -Uri https://devblogs.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

Ez a parancs a Invoke-RestMethod parancsmagot használja a PowerShell blog RSS-hírcsatornájának információinak lekéréséhez. A parancs a Format-Table parancsmaggal jeleníti meg a Cím értékeit, és pubDate tulajdonságait egy táblázatban lévő blogon.

2. példa

Az alábbi példában egy felhasználó Invoke-RestMethod futtat egy POST-kérés végrehajtásához egy intranetes webhelyen a felhasználó szervezetében.

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

3. példa: Több fejléc átadása

Ez a példa bemutatja, hogyan adhat át több fejlécet egy hash-table-ról egy REST API-nak.

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

Az API-k gyakran megkövetelik az átment fejléceket a hitelesítéshez, az ellenőrzéshez stb.

3. példa: Űrlapadatok beküldése

A tartalom egy űrlap, vagy egy másik Invoke-WebRequest hívás kimenete esetén a PowerShell a kérést az űrlapmezőkhöz igazítja.

Például:

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

4. példa: A visszaadott elemek felsorolása a folyamatban

A GitHub több objektumot ad vissza egy tömbhöz. Ha a kimenetet egy másik parancsra irányítja, a rendszer egyetlen [Object[]]objektumként küldi el.

Ha az objektumokat be szeretné sorolni a folyamatba, irányítsa az eredményeket a Write-Output-hoz, vagy zárójelbe helyezze a parancsot. Az alábbi példa a GitHub által visszaadott objektumok számát számolja. Ezután megszámolja a csővezetékhez enumerált objektumok számát.

$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

Paraméterek

-Body

A kérelem törzsét adja meg. A törzs a fejléceket követő kérés tartalma. A törzsértéket a Invoke-RestMethodrészére is át lehet irányítani.

A Törzs paraméter a lekérdezési paraméterek listájának megadására vagy a lekérdezés tartalmának megadására használható.

kérés. Ha a bemenet egy GET kérés, és a törzs egy IDictionary (általában egy kivonattáblázat), akkor a törzset lekérdezési paraméterekként hozzáadják az URI-hoz. Más kéréstípusok (például POST) esetén a törzs a kérelem törzsének értékeként van beállítva a standard name=value formátumban.

Figyelmeztetés

A POST-törzs részletes kimenete with -1-byte payloadvégződik, annak ellenére, hogy a törzs mérete is ismert, és a Content-Length HTTP-fejlécben lesz elküldve.

Paramétertulajdonságok

Típus:	Object
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

(All)

Position:	Named
Kötelező:	False
Folyamatból származó érték:	True
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-Certificate

Megadja a biztonságos webkérelemhez használt ügyféltanúsítványt. Adjon meg egy változót, amely tartalmaz egy tanúsítványt, vagy egy parancsot vagy kifejezést, amely lekéri a tanúsítványt.

Tanúsítvány kereséséhez használja a Get-PfxCertificate, vagy használja a Get-ChildItem parancsmagot a Tanúsítvány (Cert:) meghajtón. Ha a tanúsítvány érvénytelen, vagy nem rendelkezik megfelelő jogosultságtal, a parancs meghiúsul.

Paramétertulajdonságok

Típus:	X509Certificate
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

(All)

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-CertificateThumbprint

Egy olyan felhasználói fiók digitális nyilvános kulcsú tanúsítványát (X509) adja meg, amely jogosult a kérés elküldésére. Adja meg a tanúsítvány ujjlenyomatát.

A tanúsítványok az ügyféltanúsítvány-alapú hitelesítésben használatosak. A tanúsítványok csak helyi felhasználói fiókokhoz rendelhetők le, tartományi fiókokhoz nem.

A tanúsítvány ujjlenyomatának megtekintéséhez a Get-Item vagy Get-ChildItem paranccsal keresse meg a tanúsítványt a Cert:\CurrentUser\My.

Paramétertulajdonságok

Típus:	String
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

(All)

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-ContentType

Megadja a webes kérelem tartalomtípusát.

Ha ContentType értéke tartalmazza a kódolási formátumot (charset), a parancsmag ezt a formátumot használja a webes kérelem törzsének kódolásához. Ha a ContentType nem ad meg kódolási formátumot, a rendszer ehelyett az alapértelmezett kódolási formátumot használja. A kódolási formátummal rendelkező ContentType például text/plain; charset=iso-8859-5, amely a latin/cirill betűs betűkészlet et adja meg.

Ha kihagyja a paramétert, a tartalomtípus a használt HTTP-módszer alapján eltérő lehet:

• POST metódus esetén a tartalomtípus application/x-www-form-urlencoded
• PUT metódus esetén a tartalomtípus application/json
• Más metódusok esetén a tartalomtípus nincs megadva a kérelemben

Ha a InFile paramétert használja egy fájl feltöltéséhez, állítsa be a tartalom típusát. A típusnak általában application/octet-streamkell lennie. A tartalomtípust azonban a végpont követelményei alapján kell beállítania.

Paramétertulajdonságok

Típus:	String
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

(All)

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-Credential

Olyan felhasználói fiókot ad meg, amely rendelkezik a kérés elküldéséhez szükséges engedéllyel. Az alapértelmezett az aktuális felhasználó.

Írjon be egy felhasználónevet, például User01 vagy Domain01\User01, vagy adjon meg egy PSCredential objektumot, amelyet a Get-Credential parancsmag generál.

A hitelesítő adatokat egy PSCredential objektum tárolja, a jelszó pedig SecureString.

Megjegyzés:

További információért a SecureString adatvédelemről lásd: Mennyire biztonságos a SecureString?.

Paramétertulajdonságok

Típus:	PSCredential
Alapértelmezett érték:	Current user
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

(All)

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-DisableKeepAlive

A HTTP-fejlécben lévő KeepAlive értékét False (Hamis) értékre állítja. Alapértelmezés szerint KeepAlive igaz. KeepAlive állandó kapcsolatot létesít a kiszolgálóval a további kérések megkönnyítése érdekében.

Paramétertulajdonságok

Típus:	SwitchParameter
Alapértelmezett érték:	False
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

(All)

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-Headers

Meghatározza a webes kérelem fejléceit. Írjon be egy kivonattáblát vagy szótárt.

A UserAgent fejlécek beállításához használja a UserAgent paramétert. Ez a paraméter nem használható UserAgent vagy cookie fejlécek megadására.

Paramétertulajdonságok

Típus:	IDictionary
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

(All)

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-InFile

Lekéri a webes kérelem törzsének tartalmát egy fájlból. Adjon meg egy elérési utat és egy fájlnevet. Ha kihagyja az elérési utat, az alapértelmezett hely az aktuális hely.

A kérés tartalomtípusát is be kell állítania. Egy fájl feltöltéséhez például meg kell adnia a tartalom típusát. A típusnak általában application/octet-streamkell lennie. A tartalomtípust azonban a végpont követelményei alapján kell beállítania.

Paramétertulajdonságok

Típus:	String
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

(All)

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-MaximumRedirection

Meghatározza, hogy a Windows PowerShell hányszor irányítja át a kapcsolatot egy másodlagos egységes erőforrás-azonosítóhoz (URI), mielőtt a kapcsolat meghiúsul. Az alapértelmezett érték 5. A 0 (nulla) érték megakadályozza az összes átirányítást.

Paramétertulajdonságok

Típus:	Int32
Alapértelmezett érték:	5
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

(All)

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-Method

A webes kérelemhez használt metódust adja meg. A paraméter elfogadható értékei a következők:

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

Paramétertulajdonságok

Típus:	WebRequestMethod
Alapértelmezett érték:	Default
Elfogadott értékek:	Default, Get, Head, Post, Put, Delete, Trace, Options, Merge, Patch
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

(All)

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-OutFile

Menti a válasz törzsét a megadott kimeneti fájlban. Adjon meg egy elérési utat és egy fájlnevet. Ha kihagyja az elérési utat, az alapértelmezett hely az aktuális hely.

Alapértelmezés szerint Invoke-RestMethod visszaadja az eredményeket a feldolgozási sornak.

Paramétertulajdonságok

Típus:	String
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

(All)

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-PassThru

Ez a paraméter csak akkor érvényes, ha az OutFile paramétert is használja a parancs. A szándék az, hogy az eredményeket a fájlba és a csővezetékbe írja.

Megjegyzés:

Ha a PassThru paramétert használja, a kimenet a csővezetékbe kerül, de a fájl üres. További információ: PowerShell-probléma #15409.

Paramétertulajdonságok

Típus:	SwitchParameter
Alapértelmezett érték:	No output
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

(All)

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-Proxy

A kéréshez proxykiszolgálót használ ahelyett, hogy közvetlenül az internetes erőforráshoz csatlakozik. Adja meg egy hálózati proxykiszolgáló URI-ját.

Paramétertulajdonságok

Típus:	Uri
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

(All)

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-ProxyCredential

Olyan felhasználói fiókot ad meg, amely jogosult a Proxy paraméter által megadott proxykiszolgáló használatára. Az alapértelmezett az aktuális felhasználó.

Írjon be egy felhasználónevet (például "User01" vagy "Domain01\User01"), vagy írjon be egy PSCredential objektumot, például a Get-Credential parancsmag által létrehozott objektumot.

Ez a paraméter csak akkor érvényes, ha a parancsban a Proxy paramétert is használja. Nem használhatja a ProxyCredential és ProxyUseDefaultCredentials paramétereket ugyanabban a parancsban.

Paramétertulajdonságok

Típus:	PSCredential
Alapértelmezett érték:	Current user
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

(All)

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-ProxyUseDefaultCredentials

Az aktuális felhasználó hitelesítő adataival fér hozzá a Proxy paraméter által megadott proxykiszolgálóhoz.

Ez a paraméter csak akkor érvényes, ha a parancsban a Proxy paramétert is használja. Nem használhatja a ProxyCredential és ProxyUseDefaultCredentials paramétereket ugyanabban a parancsban.

Paramétertulajdonságok

Típus:	SwitchParameter
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

(All)

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-SessionVariable

Létrehoz egy változót, amely tartalmazza a webes kérelem munkamenetét. Adjon meg egy változónevet a dollárjel ($) szimbólum nélkül.

Amikor megad egy munkamenet-változót, Invoke-RestMethod létrehoz egy webkérelem-munkamenet-objektumot, és hozzárendeli azt egy, a PowerShell-munkamenetben megadott névvel rendelkező változóhoz. A változót a parancs befejeződése után használhatja a munkamenetben.

A távoli munkamenettől eltérően a webkérés munkamenete nem egy állandó kapcsolat. Ez egy objektum, amely információkat tartalmaz a kapcsolatról és a kérésről, beleértve a cookie-kat, a hitelesítő adatokat, a maximális átirányítási értéket és a felhasználói ügynök sztringjét. Ezzel megoszthatja az állapotot és az adatokat a webes kérések között.

A webkérelem-munkamenet későbbi webes kérelmekben való használatához adja meg a munkamenet változóját a WebSession paraméter értékében. A PowerShell a webkérelem munkamenet-objektumában lévő adatokat használja az új kapcsolat létrehozásakor. Ha felül szeretne bírálni egy értéket a webes kérelem munkamenetében, használjon egy parancsmagparamétert, például UserAgent vagy Hitelesítő adatok. A paraméterértékek elsőbbséget élveznek a webes kérelem munkamenetében lévő értékekkel szemben.

Nem használhatja a SessionVariable és WebSession paramétereket ugyanabban a parancsban.

Paramétertulajdonságok

Típus:	String
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	False
DontShow:	False
Aliasok:	SV

Paraméterkészletek

(All)

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-TimeoutSec

Megadja, hogy mennyi ideig lehet függőben a kérelem, mielőtt túllépi az időkorlátot. Adjon meg egy értéket másodpercek alatt. Az alapértelmezett érték, 0, meghatározatlan időtartamot ad meg.

A DNS-lekérdezések visszaérése vagy időtúllépése akár 15 másodpercet is igénybe vehet. Ha a kérés tartalmaz egy feloldást igénylő gazdagépnevet, és a TimeoutSec értékét nullánál nagyobbra, de 15 másodpercnél rövidebbre állítja be, az 15 másodpercet vagy többet is igénybe vehet a WebException kiváltása előtt, és a kérés túllépi az időkorlátot.

Paramétertulajdonságok

Típus:	Int32
Alapértelmezett érték:	0
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

(All)

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-TransferEncoding

Megadja az átvitelkódoló HTTP-válaszfejléc értékét. A paraméter elfogadható értékei a következők:

• Chunked
• Compress
• Deflate
• GZip
• Identity

Paramétertulajdonságok

Típus:	String
Alapértelmezett érték:	None
Elfogadott értékek:	chunked, compress, deflate, gzip, identity
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

(All)

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-Uri

Annak az internetes erőforrásnak az egységes erőforrás-azonosítóját (URI) adja meg, amelyre a webes kérést küldi. Ez a paraméter támogatja a HTTP, HTTPS, FTP és FILE értékeket.

Ez a paraméter kötelező. A paraméter neve (Uri) megadása nem kötelező.

Paramétertulajdonságok

Típus:	Uri
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

(All)

Position:	0
Kötelező:	True
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-UseBasicParsing

Azt jelzi, hogy a parancsmag alapszintű elemzést használ. A parancsmag egy sztring objektum nyers HTML-kódját adja vissza.

Paramétertulajdonságok

Típus:	SwitchParameter
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

(All)

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-UseDefaultCredentials

Az aktuális felhasználó hitelesítő adataival küldi el a webes kérelmet.

Paramétertulajdonságok

Típus:	SwitchParameter
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

(All)

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-UserAgent

Meghatároz egy user agent karakterláncot a webes kéréshez.

Az alapértelmezett felhasználói ügynök hasonló az Mozilla/5.0 (Windows NT 10.0; Microsoft Windows 10.0.15063; en-US) PowerShell/6.0.0, és az egyes operációs rendszerek és platformok esetében kisebb eltéréseket mutat.

Ha a legtöbb internetböngésző által használt szabványos felhasználói ügynök sztringgel szeretne tesztelni egy webhelyet, használja a PSUserAgent osztály tulajdonságait, például Chrome, Firefox, InternetExplorer, Opera és Safari.

Paramétertulajdonságok

Típus:	String
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

(All)

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-WebSession

Webkérelem-munkamenetet határoz meg. Adja meg a változó nevét, beleértve a dollárjelet ($).

Ha felül szeretne bírálni egy értéket a webes kérelem munkamenetében, használjon egy parancsmagparamétert, például UserAgent vagy Hitelesítő adatok. A paraméterértékek elsőbbséget élveznek a webes kérelem munkamenetében lévő értékekkel szemben.

A távoli munkamenettől eltérően a webkérés munkamenete nem egy állandó kapcsolat. Ez egy objektum, amely információkat tartalmaz a kapcsolatról és a kérésről, beleértve a cookie-kat, a hitelesítő adatokat, a maximális átirányítási értéket és a felhasználói ügynök sztringjét. Ezzel megoszthatja az állapotot és az adatokat a webes kérések között.

Webkérelem-munkamenet létrehozásához írjon be egy változónevet dollárjel nélkül a SessionVariable paraméter értékébe egy Invoke-RestMethod parancsban. Invoke-RestMethod létrehozza a munkamenetet, és megmenti a változóban. A következő parancsokban használja a változót a WebSession paraméter értékeként.

Nem használhatja a SessionVariable és WebSession paramétereket ugyanabban a parancsban.

Paramétertulajdonságok

Típus:	WebRequestSession
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

(All)

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

CommonParameters

Ez a parancsmag a következő gyakori paramétereket támogatja: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction és -WarningVariable. További információért lásd about_CommonParameters.

Bevitelek

Object

Erre a parancsmagra egy webes kérés törzsét is becsúszthatja.

Kimenetek

Int64

Amikor a kérelem egész számot ad vissza, ez a parancsmag visszaadja az egész számot.

String

Amikor a kérés egy sztringet ad vissza, ez a parancsmag visszaadja ezt a sztringet.

XmlDocument

Amikor a kérelem érvényes XML-t ad vissza, ez a parancsmag XmlDocumentformájában adja vissza.

PSObject

Amikor a kérelem JSON-sztringeket ad vissza, ez a parancsmag egy PSObject ad vissza, amely az adatokat jelöli.

Jegyzetek

A Windows PowerShell a Invoke-RestMethodkövetkező aliasait tartalmazza:

• irm

Amikor a REST-végpont több objektumot ad vissza, az objektumok tömbként lesznek fogadva. Ha a kimenetet Invoke-RestMethod egy másik parancsba továbbítja, az egyetlen [Object[]] objektumként lesz elküldve. A tömb tartalma nem lesz felsorolva a folyamatparancs következő lépéséhez.

Kapcsolódó hivatkozások

• JSON-konvertálás
• ConvertFrom-Json
• Invoke-WebRequest