Invoke-RestMethod

Reference

Modul:: Microsoft.PowerShell.Utility

Odešle požadavek HTTP nebo HTTPS do webové služby RESTful.

Syntaxe

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

Rutina Invoke-RestMethod odesílá požadavky HTTP a HTTPS do webových služeb REST (Representational State Transfer), které vrací bohatě strukturovaná data.

Windows PowerShell formátuje odpověď na základě datového typu. V případě informačního kanálu RSS nebo ATOM vrátí Windows PowerShell uzly XML položky nebo položky. V případě javascriptového zápisu objektu (JSON) nebo XML převede Windows PowerShell (nebo deserializuje) obsah na objekty.

Tato rutina je zavedena ve Windows PowerShellu 3.0.

Poznámka

Ve výchozím nastavení se kód skriptu na webové stránce může spustit, když je stránka analyzována, aby se naplnila vlastnost ParsedHtml. K potlačení použijte přepínač -UseBasicParsing.

Příklady

Příklad 1: Získání informačního kanálu RSS PowerShellu

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

Tento příkaz používá rutinu Invoke-RestMethod k získání informací z informačního kanálu RSS blogu PowerShellu. Příkaz používá rutinu k zobrazení hodnot nadpisu a vlastnosti pubDate každého blogu v tabulce.

Příklad 2

V následujícím příkladu uživatel spustí Invoke-RestMethod k provedení požadavku POST na intranetovém webu v organizaci uživatele.

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

Příklad 3: Předání více hlaviček

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

Rozhraní API často vyžadují předané hlavičky pro ověřování, ověřování atd.

Tento příklad ukazuje, jak předat více hlaviček z hash-table do rozhraní REST API.

Parametry

-Body

Určuje text požadavku. Text je obsah požadavku, který následuje za hlavičkami. Můžete také roušit hodnotu těla do Invoke-RestMethod.

Parametr -Body lze použít k zadání seznamu parametrů dotazu nebo zadání obsahu odpovědi.

Když je vstupem požadavek GET a tělo je IDictionary (obvykle hashovací tabulka), tělo se přidá do identifikátoru URI jako parametry dotazu. U jiných typů požadavků (například POST) se text nastaví jako hodnota textu požadavku ve standardním formátu name=value.

upozornění: Podrobný výstup těla POST skončí with -1-byte payload, i když je velikost těla známá a odeslána v hlavičce Content-Length HTTP.

Pokud je tělo formuláře nebo výstupem jiného volání Invoke-WebRequest, Windows PowerShell nastaví obsah požadavku na pole formuláře.

Například:

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

Typ:	Object
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	True
Přijmout zástupné znaky:	False

-Certificate

Určuje klientský certifikát, který se používá pro zabezpečený webový požadavek. Zadejte proměnnou obsahující certifikát nebo příkaz nebo výraz, který certifikát získá.

Pokud chcete najít certifikát, použijte Get-PfxCertificate nebo použijte rutinu Get-ChildItem na jednotce Certificate (Cert:). Pokud certifikát není platný nebo nemá dostatečnou autoritu, příkaz selže.

Typ:	X509Certificate
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-CertificateThumbprint

Určuje certifikát digitálního veřejného klíče (X509) uživatelského účtu, který má oprávnění k odeslání žádosti. Zadejte kryptografický otisk certifikátu.

Certifikáty se používají při ověřování na základě klientských certifikátů. Mohou být mapovány pouze na místní uživatelské účty; nefungují s doménovými účty.

Pokud chcete získat kryptografický otisk certifikátu, použijte příkaz Get-Item nebo Get-ChildItem na jednotce Windows PowerShellu (Cert:).

Typ:	String
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-ContentType

Určuje typ obsahu webového požadavku.

Pokud tento parametr vynecháte a metoda požadavku je POST, Invoke-RestMethod nastaví typ obsahu na "application/x-www-form-urlencoded". V opačném případě není ve volání zadán typ obsahu.

Typ:	String
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-Credential

Určuje uživatelský účet, který má oprávnění k odeslání požadavku. Výchozí hodnota je aktuální uživatel.

Zadejte uživatelské jméno, například "User01" nebo "Domain01\User01", nebo zadejte PSCredential objekt, například objekt vygenerovaný rutinou Get-Credential.

Typ:	PSCredential
Position:	Named
Default value:	Current user
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-DisableKeepAlive

Nastaví hodnotu KeepAlive v hlavičce HTTP na False. Ve výchozím nastavení KeepAlive true. KeepAlive vytvoří trvalé připojení k serveru, aby se usnadnily následné požadavky.

Typ:	SwitchParameter
Position:	Named
Default value:	KeepAlive
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-Headers

Určuje hlavičky webového požadavku. Zadejte tabulku hash nebo slovník.

Chcete-li nastavit hlavičky UserAgent, použijte parametr -UserAgent. Tento parametr nelze použít k zadání hlavičky UserAgent nebo cookie.

Typ:	IDictionary
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-InFile

Získá obsah webového požadavku ze souboru.

Zadejte cestu a název souboru. Pokud cestu vynecháte, výchozí je aktuální umístění.

Typ:	String
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-MaximumRedirection

Určuje, kolikrát Windows PowerShell přesměruje připojení na alternativní identifikátor URI (Uniform Resource Identifier), než se připojení nezdaří. Výchozí hodnota je 5. Hodnota 0 (nula) zabraňuje veškerému přesměrování.

Typ:	Int32
Position:	Named
Default value:	5
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-Method

Určuje metodu použitou pro webový požadavek. Přijatelné hodnoty pro tento parametr jsou:

Výchozí
Vymazat
Dostat
Hlava
Sloučit
Volby
Záplata
Post
Dát
Stopa

Typ:	WebRequestMethod
Přípustné hodnoty:	Default, Get, Head, Post, Put, Delete, Trace, Options, Merge, Patch
Position:	Named
Default value:	Default
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-OutFile

Uloží tělo odpovědi do zadaného výstupního souboru. Zadejte cestu a název souboru. Pokud cestu vynecháte, výchozí je aktuální umístění.

Ve výchozím nastavení Invoke-RestMethod vrátí výsledky do kanálu. Pokud chcete výsledky odeslat do souboru a do kanálu, použijte parametr -Passthru.

Typ:	String
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-PassThru

Vrátí výsledky kromě jejich zápisu do souboru. Tento parametr je platný pouze v případě, že se v příkazu použije také parametr -OutFile.

Typ:	SwitchParameter
Position:	Named
Default value:	No output
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-Proxy

Místo přímého připojení k internetovému prostředku používá proxy server pro požadavek. Zadejte identifikátor URI síťového proxy serveru.

Typ:	Uri
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-ProxyCredential

Určuje uživatelský účet, který má oprávnění používat proxy server určený parametrem -Proxy. Výchozí hodnota je aktuální uživatel.

Zadejte uživatelské jméno, například "User01" nebo "Domain01\User01", nebo zadejte PSCredential objekt, například objekt vygenerovaný rutinou Get-Credential.

Tento parametr je platný pouze v případě, že se v příkazu použije také parametr -Proxy. Ve stejném příkazu nelze použít parametry -ProxyCredential a -ProxyUseDefaultCredentials.

Typ:	PSCredential
Position:	Named
Default value:	Current user
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-ProxyUseDefaultCredentials

Používá přihlašovací údaje aktuálního uživatele pro přístup k proxy serveru určenému parametrem -Proxy.

Tento parametr je platný pouze v případě, že se v příkazu použije také parametr -Proxy. Ve stejném příkazu nelze použít parametry -ProxyCredential a -ProxyUseDefaultCredentials.

Typ:	SwitchParameter
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-SessionVariable

Vytvoří relaci webového požadavku a uloží ji do hodnoty zadané proměnné. Zadejte název proměnné bez symbolu dolaru ($).

Když zadáte proměnnou relace, Invoke-RestMethod vytvoří objekt relace webového požadavku a přiřadí ho proměnné se zadaným názvem v relaci Windows PowerShellu. Proměnnou v relaci můžete použít hned po dokončení příkazu.

Na rozdíl od vzdálené relace není relace webového požadavku trvalým připojením. Jedná se o objekt, který obsahuje informace o připojení a požadavku, včetně souborů cookie, přihlašovacích údajů, maximální hodnoty přesměrování a řetězce uživatelského agenta. Můžete ho použít ke sdílení stavu a dat mezi webovými požadavky.

Pokud chcete použít relaci webového požadavku v následných webových požadavcích, zadejte proměnnou relace v hodnotě parametru -WebSession. Windows PowerShell používá data v objektu relace webového požadavku při navazování nového připojení. Pokud chcete přepsat hodnotu v relaci webového požadavku, použijte parametr rutiny, například -UserAgent nebo -Credential. Hodnoty parametrů mají přednost před hodnotami v relaci webového požadavku.

Ve stejném příkazu nelze použít parametry -SessionVariable a -WebSession.

Typ:	String
Aliasy:	SV
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-TimeoutSec

Určuje, jak dlouho může požadavek čekat, než vyprší časový limit. Zadejte hodnotu v sekundách. Výchozí hodnota 0 určuje neomezený časový limit.

Vrácení nebo vypršení časového limitu dotazu DNS (Domain Name System) může trvat až 15 sekund. Pokud váš požadavek obsahuje název hostitele, který vyžaduje překlad, a nastavíte hodnotu TimeoutSec na hodnotu větší než nula, ale méně než 15 sekund, může trvat 15 sekund nebo déle, než se vyvolá výjimka WebException a vyprší časový limit požadavku.

Typ:	Int32
Position:	Named
Default value:	0
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-TransferEncoding

Určuje hodnotu hlavičky odpovědi HTTP kódování přenosu. Přijatelné hodnoty pro tento parametr jsou:

Blokového
Komprimovat
Vyfouknout
GZip
Identita

Typ:	String
Přípustné hodnoty:	chunked, compress, deflate, gzip, identity
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-Uri

Určuje identifikátor URI (Uniform Resource Identifier) internetového prostředku, do kterého se odešle webový požadavek. Tento parametr podporuje hodnoty HTTP, HTTPS, FTP a FILE.

Tento parametr je povinný. Název parametru (-Uri) je volitelný.

Typ:	Uri
Position:	0
Default value:	None
Vyžadováno:	True
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-UseBasicParsing

Označuje, že rutina používá základní analýzu. Rutina vrátí nezpracovaný kód HTML v objektu String.

Typ:	SwitchParameter
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-UseDefaultCredentials

Použije přihlašovací údaje aktuálního uživatele k odeslání webové žádosti.

Typ:	SwitchParameter
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-UserAgent

Určuje řetězec uživatelského agenta pro webový požadavek.

Výchozí uživatelský agent je podobný "Mozilla/5.0 (Windows NT; Windows NT 6.1; en-US) WindowsPowerShell/3.0" s mírnými variacemi pro každý operační systém a platformu.

K otestování webu se standardním řetězcem uživatelského agenta, který používá většina internetových prohlížečů, použijte vlastnosti PSUserAgent třídy, jako je Chrome, FireFox, Internet Explorer, Opera a Safari.

Například následující příkaz používá řetězec uživatelského agenta pro internet.

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

Typ:	String
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-WebSession

Určuje relaci webové žádosti. Zadejte název proměnné, včetně znaku dolaru ($).

Pokud chcete přepsat hodnotu v relaci webového požadavku, použijte parametr rutiny, například -UserAgent nebo -Credential. Hodnoty parametrů mají přednost před hodnotami v relaci webového požadavku.

Pokud chcete vytvořit relaci webového požadavku, zadejte do hodnoty parametru -SessionVariable příkazu Invoke-RestMethod název proměnné (bez znaku dolaru). Invoke-RestMethod vytvoří relaci a uloží ji do proměnné. V dalších příkazech použijte proměnnou jako hodnotu parametru -WebSession.

Ve stejném příkazu nelze použít parametry -SessionVariable a -WebSession.

Typ:	WebRequestSession
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

Vstupy

Object

Text webového požadavku můžete převést na Invoke-RestMethod.

Výstupy

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

Výstup rutiny závisí na formátu načteného obsahu.

PSObject

Pokud požadavek vrátí řetězce JSON, Invoke-RestMethod vrátí objekt PSObject, který představuje řetězce.

Sdílet prostřednictvím

Invoke-RestMethod

Syntaxe

Description

Příklady

Příklad 1: Získání informačního kanálu RSS PowerShellu

Příklad 2

Příklad 3: Předání více hlaviček

Parametry

-Body

-Certificate

-CertificateThumbprint

-ContentType

-Credential

-DisableKeepAlive

-Headers

-InFile

-MaximumRedirection

-Method

-OutFile

-PassThru

-Proxy

-ProxyCredential

-ProxyUseDefaultCredentials

-SessionVariable

-TimeoutSec

-TransferEncoding

-Uri

-UseBasicParsing

-UseDefaultCredentials

-UserAgent

-WebSession

Vstupy

Výstupy

Další materiály

Sdílet prostřednictvím

Invoke-RestMethod

Syntaxe

Description

Příklady

Příklad 1: Získání informačního kanálu RSS PowerShellu

Příklad 2

Příklad 3: Předání více hlaviček

Parametry

-Body

-Certificate

-CertificateThumbprint

-ContentType

-Credential

-DisableKeepAlive

-Headers

-InFile

-MaximumRedirection

-Method

-OutFile

-PassThru

-Proxy

-ProxyCredential

-ProxyUseDefaultCredentials

-SessionVariable

-TimeoutSec

-TransferEncoding

-Uri

-UseBasicParsing

-UseDefaultCredentials

-UserAgent

-WebSession

Vstupy

Výstupy

Související odkazy

Další materiály