Invoke-WebRequest
Získá obsah z webové stránky na internetu.
Syntax
Invoke-WebRequest
[-UseBasicParsing]
[-Uri] <Uri>
[-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>]
[-Method <WebRequestMethod>]
[-Proxy <Uri>]
[-ProxyCredential <PSCredential>]
[-ProxyUseDefaultCredentials]
[-Body <Object>]
[-Form <IDictionary>]
[-ContentType <String>]
[-TransferEncoding <String>]
[-InFile <String>]
[-OutFile <String>]
[-PassThru]
[-Resume]
[-SkipHttpErrorCheck]
[-PreserveAuthorizationOnRedirect]
[-SkipHeaderValidation]
[<CommonParameters>] Invoke-WebRequest
[-UseBasicParsing]
[-Uri] <Uri>
[-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>]
[-Method <WebRequestMethod>]
-NoProxy
[-Body <Object>]
[-Form <IDictionary>]
[-ContentType <String>]
[-TransferEncoding <String>]
[-InFile <String>]
[-OutFile <String>]
[-PassThru]
[-Resume]
[-SkipHttpErrorCheck]
[-PreserveAuthorizationOnRedirect]
[-SkipHeaderValidation]
[<CommonParameters>] Invoke-WebRequest
[-UseBasicParsing]
[-Uri] <Uri>
[-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>]
-CustomMethod <String>
[-Proxy <Uri>]
[-ProxyCredential <PSCredential>]
[-ProxyUseDefaultCredentials]
[-Body <Object>]
[-Form <IDictionary>]
[-ContentType <String>]
[-TransferEncoding <String>]
[-InFile <String>]
[-OutFile <String>]
[-PassThru]
[-Resume]
[-SkipHttpErrorCheck]
[-PreserveAuthorizationOnRedirect]
[-SkipHeaderValidation]
[<CommonParameters>] Invoke-WebRequest
[-UseBasicParsing]
[-Uri] <Uri>
[-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>]
-CustomMethod <String>
-NoProxy
[-Body <Object>]
[-Form <IDictionary>]
[-ContentType <String>]
[-TransferEncoding <String>]
[-InFile <String>]
[-OutFile <String>]
[-PassThru]
[-Resume]
[-SkipHttpErrorCheck]
[-PreserveAuthorizationOnRedirect]
[-SkipHeaderValidation]
[<CommonParameters>] Description
Rutina Invoke-WebRequest odesílá požadavky HTTP a HTTPS na webovou stránku nebo webovou službu. Analyzuje odpověď a vrací kolekce odkazů, obrázků a dalších důležitých prvků HTML.
Tato rutina byla představena v PowerShellu 3.0.
Počínaje PowerShellem 7.0 Invoke-WebRequest podporuje konfiguraci proxy serveru definovanou proměnnými prostředí. Viz část Poznámky tohoto článku.
Důležité
Příklady v tomto článku odkazují na hostitele v doméně contoso.com . Jedná se o fiktivní doménu používanou Microsoftem pro příklady. Příklady jsou navržené tak, aby ukázaly, jak tyto rutiny používat.
Vzhledem k tomu, že contoso.com weby neexistují, příklady nefungují. Přizpůsobte příklady hostitelům ve vašem prostředí.
Příklady
Příklad 1: Odeslání webové žádosti
Tento příklad používá rutinu Invoke-WebRequest k odeslání webového požadavku na web Bing.com.
$Response = Invoke-WebRequest -URI https://www.bing.com/search?q=how+many+feet+in+a+mile
$Response.InputFields | Where-Object {
$_.name -like "* Value*"
} | Select-Object Name, Value
name value
---- -----
From Value 1
To Value 5280První příkaz vydá požadavek a uloží odpověď do $Response proměnné.
Druhý příkaz získá jakýkoli InputField , kde name vlastnost je like "* Value". Filtrované výsledky se předají tak, aby Select-Object vybrali vlastnosti Název a Hodnota .
Příklad 2: Použití stavové webové služby
Tento příklad ukazuje, jak použít rutinu Invoke-WebRequest se stavovou webovou službou.
$LoginParameters = @{
Uri = 'https://www.contoso.com/login/'
SessionVariable = 'Session'
Method = 'POST'
Body = @{
User = 'jdoe'
Password = 'P@S$w0rd!'
}
}
$LoginResponse = Invoke-WebRequest @LoginParameters
$ProfileResponse = Invoke-WebRequest 'https://www.contoso.com/profile/' -WebSession $SessionPrvní volání, které Invoke-WebRequest odešle žádost o přihlášení. Příkaz určuje hodnotu pro hodnotu SessionParametr SessionVariable . Po dokončení $LoginResponse příkazu obsahuje proměnná BasicHtmlWebResponseObject a $Session proměnná obsahuje WebRequestSession objekt. Tím se uživatel přihlásí na web.
Druhé volání pro Invoke-WebRequest načtení profilu uživatele, které vyžaduje přihlášení uživatele k webu. Data relace uložená v $Session proměnné poskytují soubory cookie relace webu vytvořenému během přihlášení.
Příklad 3: Získání odkazů z webové stránky
Tento příklad získá odkazy na webovou stránku. Používá rutinu Invoke-WebRequest k získání obsahu webové stránky. Pak používá Links vlastnost BasicHtmlWebResponseObject , která Invoke-WebRequest vrací, a Href vlastnost každého odkazu.
(Invoke-WebRequest -Uri "https://aka.ms/pscore6-docs").Links.HrefPříklad 4: Zápis obsahu odpovědi do souboru pomocí kódování definovaného na požadované stránce
Tento příklad používá rutinu Invoke-WebRequest k načtení obsahu webové stránky stránky dokumentace PowerShellu.
$Response = Invoke-WebRequest -Uri "https://aka.ms/pscore6-docs"
$Stream = [System.IO.StreamWriter]::new('.\docspage.html', $false, $Response.Encoding)
try {
$Stream.Write($Response.Content)
} finally {
$Stream.Dispose()
}První příkaz načte stránku a uloží objekt odpovědi do $Response proměnné.
Druhý příkaz vytvoří StreamWriter , který se použije k zápisu obsahu odpovědi do souboru. Vlastnost Kódování objektu odpovědi slouží k nastavení kódování souboru.
Poslední několik příkazů zapisuje vlastnost Content do souboru a pak odstraní StreamWriter.
Všimněte si, že vlastnost Kódování má hodnotu null, pokud webový požadavek nevrací textový obsah.
Příklad 5: Odeslání vícedílového/form-datového souboru
Tento příklad používá rutinu Invoke-WebRequest k nahrání souboru jako multipart/form-data odeslání. Soubor c:\document.txt je odeslán jako pole document formuláře s Content-Typetext/plain
$FilePath = 'c:\document.txt'
$FieldName = 'document'
$ContentType = 'text/plain'
$FileStream = [System.IO.FileStream]::new($filePath, [System.IO.FileMode]::Open)
$FileHeader = [System.Net.Http.Headers.ContentDispositionHeaderValue]::new('form-data')
$FileHeader.Name = $FieldName
$FileHeader.FileName = Split-Path -leaf $FilePath
$FileContent = [System.Net.Http.StreamContent]::new($FileStream)
$FileContent.Headers.ContentDisposition = $FileHeader
$FileContent.Headers.ContentType = [System.Net.Http.Headers.MediaTypeHeaderValue]::Parse($ContentType)
$MultipartContent = [System.Net.Http.MultipartFormDataContent]::new()
$MultipartContent.Add($FileContent)
$Response = Invoke-WebRequest -Body $MultipartContent -Method 'POST' -Uri 'https://api.contoso.com/upload'Příklad 6: Zjednodušené odeslání více částí/dat formuláře
Některá rozhraní API vyžadují multipart/form-data odeslání k nahrání souborů a smíšeného obsahu. Tento příklad ukazuje aktualizaci profilu uživatele.
$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-WebRequest -Uri $Uri -Method Post -Form $FormFormulář profilu vyžaduje tato pole: firstName, lastName, email, avatarbirthdaya hobbies. Rozhraní API očekává, že obrázek obrázku profilu uživatele se do pole zadá avatar . Rozhraní API také přijímá více hobbies položek, které se mají odeslat ve stejném formuláři.
Při vytváření $Form HashTable se názvy klíčů používají jako názvy polí formuláře. Ve výchozím nastavení se hodnoty HashTable převedou na řetězce. Pokud je k dispozici hodnota System.IO.FileInfo, obsah souboru se odešle. Pokud existuje kolekce, jako jsou pole nebo seznamy, je pole formuláře odesláno několikrát.
Pomocí Get-Item klíče avatarFileInfo je objekt nastaven jako hodnota. Výsledkem je odeslání dat jdoe.png obrázku.
Když do klíče zadáte seznam hobbies , hobbies pole se v odesílaných položkách zobrazí jednou pro každou položku seznamu.
Příklad 7: Zachycení zpráv, které nejsou úspěšné z invoke-WebRequest
Když Invoke-WebRequest se zobrazí zpráva HTTP bez úspěchu (404, 500 atd.), nevrátí žádný výstup a vyvolá ukončující chybu. Chcete-li zachytit chybu a zobrazit StatusCode , můžete uzavřít spuštění do try/catch bloku.
try
{
$Response = Invoke-WebRequest -Uri "www.microsoft.com/unkownhost"
# This will only execute if the Invoke-WebRequest is successful.
$StatusCode = $Response.StatusCode
} catch {
$StatusCode = $_.Exception.Response.StatusCode.value__
}
$StatusCode
404Ukončovací chyba je zachycena catch blokem, který načte StatusCode z objektu Exception .
Příklad 8: Stažení více souborů najednou
Rutina Invoke-WebRequest může stáhnout jenom jeden soubor najednou. Následující příklad používá Start-ThreadJob k vytvoření více úloh vlákna ke stažení více souborů najednou.
$baseUri = 'https://github.com/PowerShell/PowerShell/releases/download'
$files = @(
@{
Uri = "$baseUri/v7.3.0-preview.5/PowerShell-7.3.0-preview.5-win-x64.msi"
OutFile = 'PowerShell-7.3.0-preview.5-win-x64.msi'
},
@{
Uri = "$baseUri/v7.3.0-preview.5/PowerShell-7.3.0-preview.5-win-x64.zip"
OutFile = 'PowerShell-7.3.0-preview.5-win-x64.zip'
},
@{
Uri = "$baseUri/v7.2.5/PowerShell-7.2.5-win-x64.msi"
OutFile = 'PowerShell-7.2.5-win-x64.msi'
},
@{
Uri = "$baseUri/v7.2.5/PowerShell-7.2.5-win-x64.zip"
OutFile = 'PowerShell-7.2.5-win-x64.zip'
}
)
$jobs = @()
foreach ($file in $files) {
$jobs += Start-ThreadJob -Name $file.OutFile -ScriptBlock {
$params = $using:file
Invoke-WebRequest @params
}
}
Write-Host "Downloads started..."
Wait-Job -Job $jobs
foreach ($job in $jobs) {
Receive-Job -Job $job
}Příklad 9: Přeskočení ověření hlavičky
Ve výchozím nastavení Invoke-WebRequest rutina ověřuje hodnoty známých hlaviček, které mají formát hodnot definovaných standardy. Následující příklad ukazuje, jak toto ověření může vyvolat chybu a jak můžete použít parametr SkipHeaderValidation , abyste se vyhnuli ověřování hodnot pro koncové body, které tolerovat neplatné formátované hodnoty.
$Uri = 'https://httpbin.org/headers'
$InvalidHeaders = @{
'If-Match' = '12345'
}
Invoke-WebRequest -Uri $Uri -Headers $InvalidHeaders
Invoke-WebRequest -Uri $Uri -Headers $InvalidHeaders -SkipHeaderValidation
Invoke-WebRequest: The format of value '12345' is invalid.
StatusCode : 200
StatusDescription : OK
Content : {
"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": �
RawContent : HTTP/1.1 200 OK
Date: Mon, 08 Aug 2022 16:24:24 GMT
Connection: keep-alive
Server: gunicorn/19.9.0
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application�
Headers : {[Date, System.String[]], [Connection, System.String[]], [Server, System.String[]], [Access-Control-Allow-Origin, System.String[]]�}
Images : {}
InputFields : {}
Links : {}
RawContentLength : 249
RelationLink : {} httpbin.org je služba, která vrací informace o webových požadavcích a odpovědích na řešení potíží. Proměnná $Uri se přiřadí koncovému /headers bodu služby, který vrátí hlavičky požadavku jako obsah v odpovědi.
Hlavička If-Match požadavku je definována v dokumentu RFC-7232 oddílu 3.1 a vyžaduje, aby byla hodnota pro tuto hlavičku definována s okolními uvozovkami. Proměnná $InvalidHeaders má přiřazenou tabulku hash, kde je hodnota If-Match neplatná, protože je definována jako 12345 místo "12345".
Volání Invoke-WebRequest s neplatnými záhlavími vrátí chybovou zprávu, že formátovaná hodnota je neplatná. Požadavek se do koncového bodu neodesílají.
Volání Invoke-WebRequest s parametrem SkipHeaderValidation ignoruje chybu ověření a odešle požadavek do koncového bodu. Vzhledem k tomu, že koncový bod tolerovat nekompatibilní hodnoty hlaviček, vrátí rutina objekt odpovědi bez chyby.
Parametry
-AllowUnencryptedAuthentication
Umožňuje odesílání přihlašovacích údajů a tajných kódů přes nešifrovaná připojení. Ve výchozím nastavení zadáte přihlašovací údaje nebo jakoukoli možnost ověřování pomocí identifikátoru URI , který nezačíná https:// chybou, a požadavek se přeruší, aby se zabránilo neúmyslné komunikaci tajných kódů v prostém textu přes nešifrovaná připojení. Pokud chcete toto chování přepsat na vlastní riziko, zadejte parametr AllowUnencryptedAuthentication .
Upozorňující
Použití tohoto parametru není bezpečné a nedoporučuje se. Poskytuje se pouze kvůli kompatibilitě se staršími systémy, které nemohou poskytovat šifrovaná připojení. Používejte na vlastní nebezpečí.
Tato funkce byla přidána v PowerShellu 6.0.0.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Authentication
Určuje explicitní typ ověřování, který se má použít pro požadavek. Výchozí hodnota je Žádná. Parametr ověřování nelze použít s parametrem UseDefaultCredentials .
Dostupné možnosti ověřování:
None: Toto je výchozí možnost, pokud není zadáno ověřování . Nepoužívá se žádné explicitní ověřování.Basic: Vyžaduje přihlašovací údaje. Přihlašovací údaje se odesílají jako hlavička základníhobase64(user:password)ověřováníAuthorization: BasicRFC 7617 ve formátu .Bearer: Vyžaduje parametr Token . Odešle hlavičku RFC 6750Authorization: Bearerse zadaným tokenem.OAuth: Vyžaduje parametr Token . Odešle hlavičku RFC 6750Authorization: Bearerse zadaným tokenem.
Zadávání ověřování přepíše všechna Authorization záhlaví zadaná do hlaviček nebo zahrnutá ve službě WebSession.
Tato funkce byla přidána v PowerShellu 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
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-WebRequest.
Parametr Body lze použít k zadání seznamu parametrů dotazu nebo k určení obsahu odpovědi.
Pokud je vstupem požadavek POST a text je Řetězec, hodnota vlevo od prvního znaménka rovná se (=) se nastaví jako klíč v datech formuláře a zbývající text se nastaví jako hodnota. Chcete-li zadat více klíčů, použijte pro text objekt IDictionary, například tabulku hash.
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 PATCH) se text nastaví jako hodnota textu požadavku ve standardním name=value formátu s hodnotami zakódovanými adresou URL.
Pokud je vstup System.Xml.XmlNode objekt a deklarace XML určuje kódování, toto kódování se používá pro data v požadavku, pokud není přepsán parametrem ContentType.
Parametr Body také přijímá System.Net.Http.MultipartFormDataContent objekt. To usnadňuje multipart/form-data žádosti. Při MultipartFormDataContent objektu je zadána text, všechny content související hlavičky zadané ContentType, Headers nebo WebSession parametry je přepsána hlavičkami Content MultipartFormDataContent objektu. Tato funkce byla přidána v PowerShellu 6.0.0.
| Type: | Object |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | 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.
| Type: | X509Certificate |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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ů. Certifikáty lze mapovat pouze na místní uživatelské účty, nikoli účty domény.
Pokud chcete zobrazit kryptografický otisk certifikátu, použijte Get-Item příkaz nebo Get-ChildItem vyhledejte certifikát v Cert:\CurrentUser\Mysouboru .
Poznámka:
Tato funkce se podporuje jenom na platformách operačního systému Windows.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ContentType
Určuje typ obsahu webového požadavku.
Pokud hodnota ContentType obsahuje formát kódování (as charset), rutina tento formát použije k kódování textu webového požadavku. Pokud ContentType nezadá formát kódování, použije se místo toho výchozí formát kódování. Příkladem ContentType s formátem kódování je text/plain; charset=iso-8859-5, který určuje latinku nebo cyrilickou abecedu.
Pokud tento parametr vynecháte a metoda požadavku je POST, Invoke-WebRequest nastaví typ obsahu na application/x-www-form-urlencoded. V opačném případě není ve volání zadán typ obsahu.
ContentType se přepíše, pokud je objekt MultipartFormDataContent zadán pro Body.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Credential
Určuje uživatelský účet, který má oprávnění k odeslání požadavku. Ve výchozím nastavení je to aktuální uživatel.
Zadejte uživatelské jméno, například User01 nebo Domain01\User01, nebo zadejte objekt PSCredential vygenerovaný rutinouGet-Credential.
Přihlašovací údaje lze použít samostatně nebo ve spojení s určitými možnostmi parametru ověřování . Pokud se používá samostatně, poskytuje přihlašovací údaje jenom vzdálenému serveru, pokud vzdálený server odešle požadavek na výzvu ověření. Při použití s možnostmi ověřování se přihlašovací údaje explicitně odesílají.
Přihlašovací údaje jsou uloženy v objektu PSCredential a heslo je uloženo jako SecureString.
Poznámka:
Další informace o ochraně dat SecureString naleznete v tématu Jak zabezpečený je SecureString?.
| Type: | PSCredential |
| Position: | Named |
| Default value: | Current user |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CustomMethod
Určuje vlastní metodu použitou pro webový požadavek. To se dá použít, pokud metoda požadavku vyžadovaná koncovým bodem není k dispozici v metodě. Metody a CustomMethod nelze použít společně.
Tento příklad vytvoří TEST požadavek HTTP na rozhraní API:
Invoke-WebRequest -uri 'https://api.contoso.com/widget/' -CustomMethod 'TEST'
Tato funkce byla přidána v PowerShellu 6.0.0.
| Type: | String |
| Aliases: | CM |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DisableKeepAlive
Označuje, že rutina nastaví hodnotu KeepAlive v hlavičce HTTP na False. KeepAlive má ve výchozím nastavení hodnotu True. KeepAlive vytvoří trvalé připojení k serveru, aby se usnadnily následné požadavky.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Form
Převede slovník na multipart/form-data odeslání. Formulář nelze použít s textem.
Pokud se použije ContentType , bude ignorován.
Klíče slovníku se používají jako názvy polí formuláře. Ve výchozím nastavení se hodnoty formuláře převedou na řetězcové hodnoty.
Pokud je hodnota System.IO.FileInfo objekt, pak se odešle obsah binárního souboru. Název souboru se odešle jako vlastnost názvu souboru . Typ MIME je nastaven jako application/octet-stream. Get-Item lze použít ke zjednodušení poskytování System.IO.FileInfo objektu.
$Form = @{ resume = Get-Item 'c:\Users\jdoe\Documents\John Doe.pdf' }
Pokud je hodnota typu kolekce, například Pole nebo Seznamy, pole pro pole se odešle několikrát. Hodnoty seznamu jsou ve výchozím nastavení považovány za řetězce. Pokud je hodnota System.IO.FileInfo objekt, pak se odešle obsah binárního souboru. Vnořené kolekce nejsou podporované.
$Form = @{ tags = 'Vacation', 'Italy', '2017' pictures = Get-ChildItem 'c:\Users\jdoe\Pictures\2017-Italy' }
V předchozím příkladu tags je pole zadáno třikrát ve formuláři, jednou pro každý z Vacation, Italya 2017. Pole pictures se také odešle jednou pro každý soubor ve 2017-Italy složce. Binární obsah souborů v této složce se odesílají jako hodnoty.
Tato funkce byla přidána v PowerShellu 6.1.0.
| Type: | IDictionary |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Headers
Určuje hlavičky webového požadavku. Zadejte tabulku hash nebo slovník.
Hlavičky související s obsahem, jako Content-Type jsou přepsány při multipartFormDataContent objektu je zadán pro Body.
| Type: | IDictionary |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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í.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MaximumRedirection
Určuje, kolikrát 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í.
| Type: | Int32 |
| Position: | Named |
| Default value: | 5 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MaximumRetryCount
Určuje, kolikrát PowerShell opakuje připojení, když se obdrží kód selhání mezi 400 a 599 (včetně) nebo 304. Viz také parametr RetryIntervalSec pro určení počtu opakování.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Method
Určuje metodu použitou pro webový požadavek. Tento parametr přijímá tyto hodnoty:
DefaultDeleteGetHeadMergeOptionsPatchPostPutTrace
Parametr CustomMethod lze použít pro metody požadavku, které nejsou uvedeny výše.
| 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
Označuje, že rutina by neměla k dosažení cíle používat proxy server. Pokud potřebujete obejít proxy server nakonfigurovaný v prostředí, použijte tento přepínač. Tato funkce byla přidána v PowerShellu 6.0.0.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-OutFile
Určuje výstupní soubor, pro který tato rutina uloží tělo odpovědi. Zadejte cestu a název souboru.
Pokud cestu vynecháte, výchozí je aktuální umístění. Název se považuje za cestu literálu.
Názvy obsahující hranaté závorky ([]) musí být uzavřeny v jednoduchých uvozovkách (').
Ve výchozím nastavení Invoke-WebRequest vrátí výsledky do kanálu. Pokud chcete výsledky odeslat do souboru a do kanálu, použijte parametr Passthru .
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PassThru
Označuje, že rutina kromě zápisu do souboru vrací výsledky. Tento parametr je platný pouze v případě, že se v příkazu používá také parametr OutFile .
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PreserveAuthorizationOnRedirect
Označuje, že rutina by měla zachovat hlavičku Authorization ( pokud je k dispozici) napříč přesměrováními.
Rutina ve výchozím nastavení před přesměrováním Authorization záhlaví odstraní. Zadání tohoto parametru zakáže tuto logiku pro případy, kdy se hlavička musí odeslat do umístění přesměrování.
Tato funkce byla přidána v PowerShellu 6.0.0.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Proxy
Určuje proxy server pro požadavek místo přímého připojení k internetovému prostředku. Zadejte identifikátor URI síťového proxy serveru.
| Type: | Uri |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ProxyCredential
Určuje uživatelský účet, který má oprávnění používat proxy server určený parametrem proxy . Ve výchozím nastavení je to aktuální uživatel.
Zadejte uživatelské jméno, například User01 nebo nebo zadejte objekt PSCredential, například objekt vygenerovaný rutinou Get-CredentialDomain01\User01.
Tento parametr je platný pouze v případě, že se v příkazu používá také parametr Proxy . Ve stejném příkazu nemůžete použít parametry ProxyCredential a ProxyUseDefaultCredentials .
| Type: | PSCredential |
| Position: | Named |
| Default value: | Current user |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ProxyUseDefaultCredentials
Označuje, že rutina 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žívá také parametr Proxy . Ve stejném příkazu nemůžete použít parametry ProxyCredential a ProxyUseDefaultCredentials .
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Resume
Provede pokus o obnovení stahování částečného souboru. Resume vyžaduje OutFile.
Resume funguje jenom s velikostí místního souboru a vzdáleného souboru a neprovádí žádné další ověření, že místní soubor a vzdálený soubor jsou stejné.
Pokud je velikost místního souboru menší než velikost vzdáleného souboru, rutina se pokusí pokračovat ve stahování souboru a připojí zbývající bajty na konec souboru.
Pokud je velikost místního souboru stejná jako velikost vzdáleného souboru, pak se neprovedou žádné akce a rutina předpokládá, že stahování je už hotové.
Pokud je velikost místního souboru větší než velikost vzdáleného souboru, místní soubor se přepíše a celý vzdálený soubor se znovu stáhne. Toto chování je stejné jako použití outfile bez obnovení.
Pokud vzdálený server nepodporuje obnovení stahování, místní soubor se přepíše a celý vzdálený soubor se znovu stáhne. Toto chování je stejné jako použití outfile bez obnovení.
Pokud místní soubor neexistuje, vytvoří se místní soubor a stáhne se celý vzdálený soubor. Toto chování je stejné jako použití outfile bez obnovení.
Tato funkce byla přidána v PowerShellu 6.1.0.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RetryIntervalSec
Určuje interval mezi opakovanými pokusy o připojení, když se obdrží kód chyby mezi 400 a 599 včetně nebo 304. Viz také parametr MaximumRetryCount pro určení počtu opakování. Hodnota musí být mezi 1 a [int]::MaxValue.
| Type: | Int32 |
| Position: | Named |
| Default value: | 5 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SessionVariable
Určuje proměnnou, pro kterou tato rutina vytvoří relaci webového požadavku a uloží ji do hodnoty.
Zadejte název proměnné bez symbolu dolaru ($).
Když zadáte proměnnou relace, Invoke-WebRequest vytvoří objekt relace webového požadavku a přiřadí ho proměnné se zadaným názvem v relaci PowerShellu. Proměnnou v relaci můžete použít hned po dokončení příkazu.
Před PowerShellem 7.4 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.
Počínaje PowerShellem 7.4 je relace webového požadavku trvalá, pokud se v následném požadavku nepřepíše vlastnosti relace. Když jsou, rutina znovu vytvoří relaci s novými hodnotami. Trvalé relace snižují režijní náklady na opakované požadavky, což je výrazně rychlejší.
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 . PowerShell při navazování nového připojení používá data v objektu relace webového požadavku. 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 nemůžete použít parametry SessionVariable a WebSession .
| Type: | String |
| Aliases: | SV |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SkipCertificateCheck
Přeskočí kontroly ověření certifikátu. To zahrnuje všechna ověření, jako je vypršení platnosti, odvolání, důvěryhodná kořenová autorita atd.
Upozorňující
Použití tohoto parametru není bezpečné a nedoporučuje se. Tento přepínač je určený pouze pro známé hostitele, kteří používají certifikát podepsaný svým držitelem pro účely testování. Používejte na vlastní nebezpečí.
Tato funkce byla přidána v PowerShellu 6.0.0.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SkipHeaderValidation
Označuje, že rutina by měla do požadavku přidat hlavičky bez ověření.
Tento přepínač by se měl používat pro weby, které vyžadují hodnoty hlaviček, které nevyhovují standardům. Zadáním tohoto přepínače zakážete ověření, aby se hodnota předala nezaškrtnutou. Po zadání se všechny hlavičky přidají bez ověření.
Tento přepínač zakáže ověřování hodnot předaných parametrům ContentType, Headers a UserAgent .
Tato funkce byla přidána v PowerShellu 6.0.0.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SkipHttpErrorCheck
Tento parametr způsobí, že rutina ignoruje stavy chyb HTTP a bude dál zpracovávat odpovědi. Odpovědi na chyby se zapíšou do kanálu stejně, jako kdyby byly úspěšné.
Tento parametr byl představen v PowerShellu 7.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SslProtocol
Nastaví protokoly SSL/TLS, které jsou pro webový požadavek přípustné. Ve výchozím nastavení jsou povolené protokoly SSL/TLS podporované systémem. SslProtocol umožňuje omezit na konkrétní protokoly pro účely dodržování předpisů.
Tyto hodnoty jsou definovány jako výčet založený na příznaku. Pomocí tohoto parametru můžete zkombinovat více hodnot a nastavit více příznaků. Hodnoty lze předat parametru SslProtocol jako pole hodnot nebo jako řetězec oddělený čárkami těchto hodnot. Rutina kombinuje hodnoty pomocí operace binárního operátoru OR. Předání hodnot jako pole je nejjednodušší možností a také umožňuje použít pro hodnoty dokončování tabulátoru. Možná nebudete moct definovat více možností na všech platformách.
Poznámka:
Na jiných platformách než Windows nemusí být možné poskytovat Tls ani Tls12 jako možnost. Tls13 Podpora není dostupná ve všech operačních systémech a bude nutné ji ověřit na základě jednotlivých operačních systémů.
Tato funkce byla přidána v PowerShellu 6.0.0 a byla přidána podpora pro Tls13 PowerShell 7.1.
| Type: | WebSslProtocol |
| Accepted values: | Default, Tls, Tls11, Tls12 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | Int32 |
| Position: | Named |
| Default value: | 0 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Token
Token OAuth nebo Bearer, který se má zahrnout do požadavku. Token je vyžadován určitými možnostmi ověřování . Nejde ho používat nezávisle.
Token přebírá SecureString token obsahující token. Pokud chcete token zadat ručně, použijte následující:
Invoke-WebRequest -Uri $uri -Authentication OAuth -Token (Read-Host -AsSecureString)
Tento parametr byl představen v PowerShellu 6.0.
| Type: | SecureString |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TransferEncoding
Určuje hodnotu hlavičky odpovědi HTTP kódování přenosu. Tento parametr přijímá tyto hodnoty:
ChunkedCompressDeflateGZipIdentity
| 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
Určuje identifikátor URI (Uniform Resource Identifier) internetového prostředku, do kterého se odešle webový požadavek. Zadejte identifikátor URI. Tento parametr podporuje pouze PROTOKOL HTTP nebo HTTPS.
Tento parametr je povinný. Identifikátor URI názvu parametru je volitelný.
| Type: | Uri |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UseBasicParsing
Tento parametr je zastaralý. Počínaje PowerShellem 6.0.0 používají všechny webové požadavky pouze základní analýzu. Tento parametr je součástí pouze zpětné kompatibility a jakékoli jeho použití nemá žádný vliv na provoz rutiny.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UseDefaultCredentials
Označuje, že rutina používá přihlašovací údaje aktuálního uživatele k odeslání webové žádosti. Tuto možnost nelze použít s ověřováním nebo přihlašovacími údaji a nemusí být podporována na všech platformách.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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 10.0; Microsoft Windows 10.0.15063; en-US) PowerShell/6.0.0 mírným změnám 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 třídy PSUserAgent , jako je Chrome, FireFox, InternetExplorer, Opera a Safari.
Například následující příkaz používá řetězec uživatelského agenta pro Aplikaci Internet Explorer: Invoke-WebRequest -Uri https://website.com/ -UserAgent ([Microsoft.PowerShell.Commands.PSUserAgent]::InternetExplorer)
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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. Hlavičky související s obsahem, například Content-Type, jsou také přepsány při MultipartFormDataContent objektu body.
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 vytvořit relaci webového požadavku, zadejte název proměnné bez znaku dolaru do hodnoty parametru Invoke-WebRequest SessionVariable příkazu. Invoke-WebRequest 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 nemůžete použít parametry SessionVariable a WebSession .
| Type: | WebRequestSession |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Vstupy
Do této rutiny můžete převést text webového požadavku.
Výstupy
Tato rutina vrátí objekt odpovědi představující výsledek webového požadavku.
Poznámky
PowerShell obsahuje následující aliasy pro Invoke-WebRequest:
- Všechny platformy:
iwr
Počínaje PowerShellem 6.0.0 Invoke-WebRequest podporuje pouze základní analýzu.
Další informace naleznete v tématu BasicHtmlWebResponseObject.
Kvůli změnám v .NET Core 3.1 používá PowerShell 7.0 a vyšší vlastnost HttpClient.DefaultProxy k určení konfigurace proxy serveru.
Hodnota této vlastnosti je určena vaší platformou:
- Pro Windows: Načte konfiguraci proxy serveru z proměnných prostředí. Pokud tyto proměnné nejsou definovány, je vlastnost odvozena z nastavení proxy serveru uživatele.
- Pro macOS: Čte konfiguraci proxy serveru z proměnných prostředí. Pokud tyto proměnné nejsou definovány, je vlastnost odvozena z nastavení proxy serveru systému.
- Pro Linux: Načte konfiguraci proxy serveru z proměnných prostředí. Pokud tyto proměnné nejsou definovány vlastnost inicializuje nekonfigurovanou instanci, která obchází všechny adresy.
Proměnné prostředí používané k DefaultProxy inicializaci na platformách se systémem Windows a Unix jsou:
HTTP_PROXY: název hostitele nebo IP adresa proxy serveru používaného u požadavků HTTP.HTTPS_PROXY: název hostitele nebo IP adresa proxy serveru používaného u požadavků HTTPS.ALL_PROXY: název hostitele nebo IP adresa proxy serveru používaného v požadavcích HTTP a HTTPS v případěHTTP_PROXY, žeHTTPS_PROXYnejsou definovány.NO_PROXY: Čárkami oddělený seznam názvů hostitelů, které by měly být vyloučeny z proxy serveru.
Související odkazy
Váš názor
Připravujeme: V průběhu roku 2024 budeme postupně vyřazovat problémy z GitHub coby mechanismus zpětné vazby pro obsah a nahrazovat ho novým systémem zpětné vazby. Další informace naleznete v tématu: https://aka.ms/ContentUserFeedback.
Odeslat a zobrazit názory pro