Invoke-WebRequest

Sintassi

StandardMethod (impostazione predefinita).

Invoke-WebRequest
    [-Uri] <Uri>
    [-UseBasicParsing]
    [-HttpVersion <Version>]
    [-WebSession <WebRequestSession>]
    [-SessionVariable <String>]
    [-AllowUnencryptedAuthentication]
    [-Authentication <WebAuthenticationType>]
    [-Credential <PSCredential>]
    [-UseDefaultCredentials]
    [-CertificateThumbprint <String>]
    [-Certificate <X509Certificate>]
    [-SkipCertificateCheck]
    [-SslProtocol <WebSslProtocol>]
    [-Token <SecureString>]
    [-UserAgent <String>]
    [-DisableKeepAlive]
    [-ConnectionTimeoutSeconds <Int32>]
    [-OperationTimeoutSeconds <Int32>]
    [-Headers <IDictionary>]
    [-SkipHeaderValidation]
    [-AllowInsecureRedirect]
    [-MaximumRedirection <Int32>]
    [-MaximumRetryCount <Int32>]
    [-PreserveAuthorizationOnRedirect]
    [-RetryIntervalSec <Int32>]
    [-Method <WebRequestMethod>]
    [-PreserveHttpMethodOnRedirect]
    [-UnixSocket <UnixDomainSocketEndPoint>]
    [-Proxy <Uri>]
    [-ProxyCredential <PSCredential>]
    [-ProxyUseDefaultCredentials]
    [-Body <Object>]
    [-Form <IDictionary>]
    [-ContentType <String>]
    [-TransferEncoding <String>]
    [-InFile <String>]
    [-OutFile <String>]
    [-PassThru]
    [-Resume]
    [-SkipHttpErrorCheck]
    [<CommonParameters>]

StandardMethodNoProxy

Invoke-WebRequest
    [-Uri] <Uri>
    [-UseBasicParsing]
    [-HttpVersion <Version>]
    [-WebSession <WebRequestSession>]
    [-SessionVariable <String>]
    [-AllowUnencryptedAuthentication]
    [-Authentication <WebAuthenticationType>]
    [-Credential <PSCredential>]
    [-UseDefaultCredentials]
    [-CertificateThumbprint <String>]
    [-Certificate <X509Certificate>]
    [-SkipCertificateCheck]
    [-SslProtocol <WebSslProtocol>]
    [-Token <SecureString>]
    [-UserAgent <String>]
    [-DisableKeepAlive]
    [-ConnectionTimeoutSeconds <Int32>]
    [-OperationTimeoutSeconds <Int32>]
    [-Headers <IDictionary>]
    [-SkipHeaderValidation]
    [-AllowInsecureRedirect]
    [-MaximumRedirection <Int32>]
    [-MaximumRetryCount <Int32>]
    [-PreserveAuthorizationOnRedirect]
    [-RetryIntervalSec <Int32>]
    [-Method <WebRequestMethod>]
    [-PreserveHttpMethodOnRedirect]
    [-UnixSocket <UnixDomainSocketEndPoint>]
    [-NoProxy]
    [-Body <Object>]
    [-Form <IDictionary>]
    [-ContentType <String>]
    [-TransferEncoding <String>]
    [-InFile <String>]
    [-OutFile <String>]
    [-PassThru]
    [-Resume]
    [-SkipHttpErrorCheck]
    [<CommonParameters>]

CustomMethod

Invoke-WebRequest
    [-Uri] <Uri>
    -CustomMethod <String>
    [-UseBasicParsing]
    [-HttpVersion <Version>]
    [-WebSession <WebRequestSession>]
    [-SessionVariable <String>]
    [-AllowUnencryptedAuthentication]
    [-Authentication <WebAuthenticationType>]
    [-Credential <PSCredential>]
    [-UseDefaultCredentials]
    [-CertificateThumbprint <String>]
    [-Certificate <X509Certificate>]
    [-SkipCertificateCheck]
    [-SslProtocol <WebSslProtocol>]
    [-Token <SecureString>]
    [-UserAgent <String>]
    [-DisableKeepAlive]
    [-ConnectionTimeoutSeconds <Int32>]
    [-OperationTimeoutSeconds <Int32>]
    [-Headers <IDictionary>]
    [-SkipHeaderValidation]
    [-AllowInsecureRedirect]
    [-MaximumRedirection <Int32>]
    [-MaximumRetryCount <Int32>]
    [-PreserveAuthorizationOnRedirect]
    [-RetryIntervalSec <Int32>]
    [-PreserveHttpMethodOnRedirect]
    [-UnixSocket <UnixDomainSocketEndPoint>]
    [-Proxy <Uri>]
    [-ProxyCredential <PSCredential>]
    [-ProxyUseDefaultCredentials]
    [-Body <Object>]
    [-Form <IDictionary>]
    [-ContentType <String>]
    [-TransferEncoding <String>]
    [-InFile <String>]
    [-OutFile <String>]
    [-PassThru]
    [-Resume]
    [-SkipHttpErrorCheck]
    [<CommonParameters>]

CustomMethodNoProxy

Invoke-WebRequest
    [-Uri] <Uri>
    -CustomMethod <String>
    [-UseBasicParsing]
    [-HttpVersion <Version>]
    [-WebSession <WebRequestSession>]
    [-SessionVariable <String>]
    [-AllowUnencryptedAuthentication]
    [-Authentication <WebAuthenticationType>]
    [-Credential <PSCredential>]
    [-UseDefaultCredentials]
    [-CertificateThumbprint <String>]
    [-Certificate <X509Certificate>]
    [-SkipCertificateCheck]
    [-SslProtocol <WebSslProtocol>]
    [-Token <SecureString>]
    [-UserAgent <String>]
    [-DisableKeepAlive]
    [-ConnectionTimeoutSeconds <Int32>]
    [-OperationTimeoutSeconds <Int32>]
    [-Headers <IDictionary>]
    [-SkipHeaderValidation]
    [-AllowInsecureRedirect]
    [-MaximumRedirection <Int32>]
    [-MaximumRetryCount <Int32>]
    [-PreserveAuthorizationOnRedirect]
    [-RetryIntervalSec <Int32>]
    [-PreserveHttpMethodOnRedirect]
    [-UnixSocket <UnixDomainSocketEndPoint>]
    [-NoProxy]
    [-Body <Object>]
    [-Form <IDictionary>]
    [-ContentType <String>]
    [-TransferEncoding <String>]
    [-InFile <String>]
    [-OutFile <String>]
    [-PassThru]
    [-Resume]
    [-SkipHttpErrorCheck]
    [<CommonParameters>]

Descrizione

Esempio

Esempio 1: Inviare una richiesta Web

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

Esempio 2: Usare un servizio Web con stato

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

Esempio 3: Ottenere collegamenti da una pagina Web

(Invoke-WebRequest -Uri "https://aka.ms/pscore6-docs").Links.Href

Esempio 4: Scrivere contenuto della risposta in un file usando la codifica definita nella pagina richiesta

$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()
}

Esempio 5: Inviare un file multipart/form-data

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

Esempio 6: Invio semplificato di dati multipart/form-data

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

Esempio 7: Intercettare messaggi non riusciti da Invoke-WebRequest

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

404

Esempio 8: Scaricare più file contemporaneamente

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

Esempio 9: ignorare la convalida dell'intestazione

$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      : {}

Esempio 10: Inviare una richiesta con HTTP 2.0

(Invoke-WebRequest -Uri 'https://aka.ms/pscore6-docs' -HttpVersion 2.0).Links.Href

Esempio 11: Inviare una richiesta a un'applicazione socket Unix

Invoke-WebRequest -Uri "http://localhost/v1.40/images/json/" -UnixSocket "/var/run/docker.sock"

Parametri

-AllowInsecureRedirect

Consente il reindirizzamento da HTTPS a HTTP. Per impostazione predefinita, qualsiasi richiesta reindirizzata da HTTPS a HTTP genera un errore e la richiesta viene interrotta per impedire la comunicazione involontaria in testo normale su connessioni non crittografate. Per eseguire l'override di questo comportamento a proprio rischio, usare il parametro AllowInsecureRedirect.

Questo parametro è stato aggiunto in PowerShell 7.4.

Proprietà dei parametri

Set di parametri

-AllowUnencryptedAuthentication

Consente l'invio di credenziali e segreti su connessioni non crittografate. Per impostazione predefinita, fornire non crittografate. Per ignorare questo comportamento a proprio rischio, specificare il parametro AllowUnencryptedAuthentication.

Questa funzionalità è stata aggiunta in PowerShell 6.0.0.

Proprietà dei parametri

Set di parametri

-Authentication

Specifica il tipo di autenticazione esplicito da utilizzare per la richiesta. L'impostazione predefinita è None (Nessuna). Il parametro Authentication non può essere usato con il parametro UseDefaultCredentials.

Opzioni di autenticazione disponibili:

• None: Questa è l'opzione predefinita quando non viene fornita l'autenticazione . Non viene usata alcuna autenticazione esplicita.
• Basic: richiede la credenziale . Le credenziali vengono inviate come intestazione RFC 7617 Basic Authentication Authorization: Basic nel formato di base64(user:password).
• Bearer: richiede il parametro token di. Invia un'intestazione RFC 6750 Authorization: Bearer con il token fornito.
• OAuth: richiede il parametro token di. Invia un'intestazione RFC 6750 Authorization: Bearer con il token fornito.

L'inserimento di autenticazione esegue l'override di qualsiasi intestazione Authorization fornita alle intestazioni di o inclusa in WebSession.

Questa funzionalità è stata aggiunta in PowerShell 6.0.0.

Proprietà dei parametri

Set di parametri

-Body

Specifica il corpo della richiesta. Il corpo è il contenuto della richiesta che segue le intestazioni. È anche possibile inviare tramite pipe un valore del corpo a Invoke-WebRequest.

Il parametro corpo può essere usato per specificare un elenco di parametri di query o specificare il contenuto della risposta. Per i parametri di query, il cmdlet usa il metodo System.Net.WebUtility.UrlEncode per codificare le coppie chiave-valore. Per altre informazioni sulle stringhe di codifica per gli URL, vedere riferimento al metodo UrlEncode().

Quando l'input è una richiesta POST e il corpo è un String, il valore a sinistra del primo segno di uguale (=) viene impostato come chiave nei dati del modulo e il testo rimanente viene impostato come valore. Per specificare più chiavi, utilizzare un oggetto IDictionary, ad esempio una tabella hash, per l'Body.

Quando l'input è una richiesta GET e il corpo è un IDictionary (in genere, una tabella hash), il corpo viene aggiunto all'URI come parametri di query. Per altri tipi di richiesta, ad esempio PATCH, il corpo viene impostato come valore del corpo della richiesta nel formato standard name=value con i valori con codifica URL.

Quando l'input è un oggetto System.Xml.XmlNode e la dichiarazione XML specifica una codifica, tale codifica viene utilizzata per i dati nella richiesta, a meno che non venga sottoposto a override dal parametro ContentType.

Il parametro Body accetta anche un System.Net.Http.MultipartFormDataContent oggetto . Ciò facilita le multipart/form-data richieste. Quando viene fornito un oggetto MultipartFormDataContent per Body, tutte le intestazioni correlate al contenuto fornite ai parametri ContentType, Headers o WebSession vengono sostituite dalle intestazioni Content dell'oggetto MultipartFormDataContent . Questa funzionalità è stata aggiunta in PowerShell 6.0.0.

Proprietà dei parametri

Set di parametri

-Certificate

Specifica il certificato client usato per una richiesta Web sicura. Immettere una variabile contenente un certificato o un comando o un'espressione che ottiene il certificato.

Per trovare un certificato, utilizzare Get-PfxCertificate oppure il cmdlet Get-ChildItem nell'unità Certificate (Cert:). Se il certificato non è valido o non dispone di un'autorità sufficiente, il comando ha esito negativo.

Proprietà dei parametri

Set di parametri

-CertificateThumbprint

Specifica il certificato di chiave pubblica digitale (X509) di un account utente autorizzato a inviare la richiesta. Immettere l'impronta digitale del certificato.

I certificati vengono usati nell'autenticazione basata su certificati client. I certificati possono essere mappati solo agli account utente locali, non agli account di dominio.

Per visualizzare l'impronta digitale del certificato, usare il comando Get-Item o Get-ChildItem per trovare il certificato in Cert:\CurrentUser\My.

Proprietà dei parametri

Set di parametri

-ConnectionTimeoutSeconds

Specifica per quanto tempo la richiesta può essere in sospeso prima del timeout. Immettere un valore in secondi. Il valore predefinito, 0, specifica un timeout indefinito.

La restituzione o il timeout di una query DNS (Domain Name System) può richiedere fino a 15 secondi. Se la richiesta contiene un nome host che richiede la risoluzione e si imposta ConnectionTimeoutSeconds su un valore maggiore di zero, ma inferiore a 15 secondi, possono essere necessari 15 secondi o più prima che venga generata una WebException e il timeout della richiesta.

Questo parametro ha sostituito il parametro TimeoutSec in PowerShell 7.4. È possibile usare TimeoutSec come alias per ConnectionTimeoutSeconds.

Proprietà dei parametri

Set di parametri

-ContentType

Specifica il tipo di contenuto della richiesta Web.

Se il valore per ContentType contiene il formato di codifica (come charset), il cmdlet usa tale formato per codificare il corpo della richiesta Web. Se il ContentType non specifica un formato di codifica, viene invece usato il formato di codifica predefinito. Un esempio di ContentType con un formato di codifica è text/plain; charset=iso-8859-5, che specifica l'alfabeto latino/cirillico.

Se si omette il parametro , il tipo di contenuto può essere diverso in base al metodo HTTP usato:

• Per un metodo POST, il tipo di contenuto è application/x-www-form-urlencoded
• Per un metodo PUT, il tipo di contenuto è application/json
• Per altri metodi, il tipo di contenuto non viene specificato nella richiesta

Se si usa il parametro InFile per caricare un file, è necessario impostare il tipo di contenuto. In genere, il tipo deve essere application/octet-stream. È tuttavia necessario impostare il tipo di contenuto in base ai requisiti dell'endpoint.

ContentType viene sottoposto a override quando il Body è un oggetto MultipartFormDataContent.

A partire da PowerShell 7.4, se si usa questo parametro e il parametro Headers per definire l'intestazione Content-Type, viene usato il valore specificato nel parametro ContentType.

Proprietà dei parametri

Set di parametri

-Credential

Specifica un account utente che dispone dell'autorizzazione per inviare la richiesta. Il valore predefinito è l'utente corrente.

Digitare un nome utente, ad esempio User01 o Domain01\User01oppure immettere un oggetto PSCredential generato dal cmdlet Get-Credential.

Le credenziali possono essere usate da sole o in combinazione con determinate opzioni di parametro di autenticazione . Se usato da solo, fornisce le credenziali al server remoto solo se il server remoto invia una richiesta di verifica di autenticazione. Se usato con le opzioni di autenticazione , le credenziali vengono inviate in modo esplicito.

Le credenziali vengono archiviate in un oggetto PSCredential e la password viene archiviata come SecureString.

Proprietà dei parametri

Set di parametri

-CustomMethod

Specifica un metodo personalizzato utilizzato per la richiesta Web. Questa opzione può essere usata se il metodo di richiesta richiesto dall'endpoint non è un'opzione disponibile nel metodo . Il metodo e il metodo personalizzato non possono essere usati insieme.

Questo esempio effettua una TEST richiesta HTTP all'API:

Invoke-WebRequest -Uri 'https://api.contoso.com/widget/' -CustomMethod 'TEST'

Questa funzionalità è stata aggiunta in PowerShell 6.0.0.

Proprietà dei parametri

Set di parametri

-DisableKeepAlive

Indica che il cmdlet imposta il valore KeepAlive nell'intestazione HTTP su False. Per impostazione predefinita, KeepAlive è True. KeepAlive stabilisce una connessione permanente al server per facilitare le richieste successive.

Proprietà dei parametri

Set di parametri

-Form

Converte un dizionario in una sottomissione multipart/form-data. Modulo non può essere utilizzato con Corpo. Se viene usato ContentType , viene ignorato.

Le chiavi del dizionario vengono utilizzate come nomi di campo del modulo. Per impostazione predefinita, i valori del modulo vengono convertiti in valori stringa.

Se il valore è un oggetto System.IO.FileInfo, il contenuto del file binario viene inviato. Il nome del file viene inviato come proprietà filename . Il tipo MIME viene impostato come application/octet-stream. Get-Item può essere usato per semplificare la fornitura dell'oggetto System.IO.FileInfo.

$Form = @{
    resume = Get-Item 'C:\Users\jdoe\Documents\John Doe.pdf'
}

Se il valore è un tipo di raccolta, ad esempio Matrici o Elenchi, il campo per viene inviato più volte. I valori dell'elenco vengono considerati come stringhe per impostazione predefinita. Se il valore è un oggetto System.IO.FileInfo, il contenuto del file binario viene inviato. Le raccolte annidate non sono supportate.

$Form = @{
    tags     = 'Vacation', 'Italy', '2017'
    pictures = Get-ChildItem 'C:\Users\jdoe\Pictures\2017-Italy\'
}

Nell'esempio precedente il tags campo viene fornito tre volte nel modulo, una volta per ognuno di Vacation, Italye 2017. Il pictures campo viene inoltre inviato una volta per ogni file nella 2017-Italy cartella . Il contenuto binario dei file in tale cartella viene inviato come valori.

Questa funzionalità è stata aggiunta in PowerShell 6.1.0.

Proprietà dei parametri

Set di parametri

-Headers

Specifica le intestazioni della richiesta web. Immettere una tabella hash o un dizionario.

Le intestazioni correlate al contenuto, ad esempio Content-Type vengono sottoposte a override quando viene fornito un oggetto MultipartFormDataContent per Body.

A partire da PowerShell 7.4, se si utilizza questo parametro per definire l'intestazione Content-Type e il parametro ContentType, viene usato il valore specificato nel parametro ContentType.

Proprietà dei parametri

Set di parametri

-HttpVersion

Specifica la versione HTTP usata per la richiesta. Il valore predefinito è 1.1.

I valori validi sono:

• 1.0
• 1.1
• 2.0
• 3.0

Proprietà dei parametri

Set di parametri

-InFile

Ottiene il contenuto del corpo della richiesta Web da un file. Immettere un percorso e un nome file. Se si omette il percorso, il valore predefinito è il percorso corrente.

È anche necessario impostare il tipo di contenuto della richiesta. Ad esempio, per caricare un file è necessario impostare il tipo di contenuto. In genere, il tipo deve essere application/octet-stream. È tuttavia necessario impostare il tipo di contenuto in base ai requisiti dell'endpoint.

Proprietà dei parametri

Set di parametri

-MaximumRedirection

Specifica quante volte PowerShell reindirizza una connessione a un URI (Uniform Resource Identifier) alternativo prima che la connessione non riesca. Il valore predefinito è 5. Il valore 0 (zero) impedisce tutto il reindirizzamento.

Proprietà dei parametri

Set di parametri

-MaximumRetryCount

Specifica quante volte PowerShell ritenta una connessione quando viene ricevuto un codice di errore compreso tra 400 e 599 inclusi o 304. Si veda anche il parametro RetryIntervalSec per specificare l'intervallo tra i tentativi.

Proprietà dei parametri

Set di parametri

-Method

Specifica il metodo utilizzato per la richiesta Web. I valori accettabili per questo parametro sono:

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

Il parametro CustomMethod può essere usato per i metodi di richiesta non elencati in precedenza.

Proprietà dei parametri

Set di parametri

-NoProxy

Indica che il cmdlet non deve usare un proxy per raggiungere la destinazione. Quando è necessario ignorare il proxy configurato nell'ambiente, usare questa opzione. Questa funzionalità è stata aggiunta in PowerShell 6.0.0.

Proprietà dei parametri

Set di parametri

-OperationTimeoutSeconds

Questo timeout si applica ai dati letti all'interno di un flusso, non al tempo di flusso nel suo complesso. Il valore predefinito, 0, specifica un timeout indefinito.

L'impostazione del valore su 30 secondi indica che qualsiasi ritardo di più di 30 secondi tra i dati nel flusso termina la richiesta. Un file di grandi dimensioni che richiede diversi minuti per il download non terminerà a meno che il flusso non si blocchi per più di 30 secondi.

Proprietà dei parametri

Set di parametri

-OutFile

Per impostazione predefinita, Invoke-WebRequest restituisce i risultati alla pipeline. Quando si usa il parametro OutFile, i risultati vengono salvati nel file specificato e non restituiti alla pipeline. Immettere un percorso e un nome file. Per inviare i risultati a un file e alla pipeline, aggiungere il parametro PassThru.

Se si omette il percorso, il valore predefinito è il percorso corrente. Il nome viene trattato come un percorso letterale. I nomi contenenti parentesi quadre ([]) devono essere racchiusi tra virgolette singole (').

A partire da PowerShell 7.4, è possibile specificare un percorso di cartella senza il nome file. Quando si esegue questa operazione, il comando usa il nome file dell'ultimo segmento dell'URI risolto dopo qualsiasi reindirizzamento. Quando si specifica un percorso di cartella per OutFile, non è possibile usare il parametro Resume.

Proprietà dei parametri

Set di parametri

-PassThru

Indica che il cmdlet restituisce i risultati, oltre a scriverli in un file. Questo parametro è valido solo quando nel comando viene usato anche il parametro outfile.

Proprietà dei parametri

Set di parametri

-PreserveAuthorizationOnRedirect

Indica che il cmdlet deve mantenere l'intestazione Authorization, se presente, tra reindirizzamenti.

Per impostazione predefinita, il cmdlet rimuove l'intestazione Authorization prima del reindirizzamento. Se si specifica questo parametro, questa logica viene disabilitata per i casi in cui l'intestazione deve essere inviata al percorso di reindirizzamento.

Questa funzionalità è stata aggiunta in PowerShell 6.0.0.

Proprietà dei parametri

Set di parametri

-PreserveHttpMethodOnRedirect

Indica che il cmdlet deve mantenere il metodo della richiesta tra reindirizzamenti.

Per impostazione predefinita, il cmdlet modifica il metodo in GET quando viene reindirizzato. Se si specifica questo parametro, questa logica viene disabilitata per assicurarsi che il metodo previsto possa essere usato con il reindirizzamento.

Questa funzionalità è stata aggiunta in PowerShell 7.4.

Proprietà dei parametri

Set di parametri

-Proxy

Specifica un server proxy per la richiesta, anziché connettersi direttamente alla risorsa Internet. Immettere l'URI di un server proxy di rete.

Proprietà dei parametri

Set di parametri

-ProxyCredential

Specifica un account utente autorizzato a usare il server proxy specificato dal parametro Proxy . Il valore predefinito è l'utente corrente.

Digitare un nome utente, ad esempio o oppure immettere un oggetto PSCredential , ad esempio quello generato dal cmdlet .

Questo parametro è valido solo quando nel comando viene usato anche il parametro proxy. Non è possibile usare i parametri ProxyCredential e ProxyUseDefaultCredentials nello stesso comando.

Proprietà dei parametri

Set di parametri

-ProxyUseDefaultCredentials

Indica che il cmdlet usa le credenziali dell'utente corrente per accedere al server proxy specificato dal parametro Proxy .

Questo parametro è valido solo quando nel comando viene usato anche il parametro proxy. Non è possibile usare i parametri ProxyCredential e ProxyUseDefaultCredentials nello stesso comando.

Proprietà dei parametri

Set di parametri

-Resume

Esegue un tentativo con il massimo impegno per continuare il download di un file parziale. Resume richiede OutFile.

Resume opera solo sulle dimensioni del file locale e del file remoto e non esegue altre convalide che il file locale e il file remoto siano uguali.

Se le dimensioni del file locale sono inferiori alle dimensioni del file remoto, il cmdlet tenta di riprendere il download del file e di accodare i byte rimanenti alla fine del file.

Se le dimensioni del file locale corrispondono alle dimensioni del file remoto, non viene eseguita alcuna azione e il cmdlet presuppone che il download sia già stato completato.

Se le dimensioni del file locale sono maggiori delle dimensioni del file remoto, il file locale viene sovrascritto e l'intero file remoto viene scaricato nuovamente. Questo comportamento equivale all'uso di OutFile senza Resume.

Se il server remoto non supporta la ripresa del download, il file locale viene sovrascritto e l'intero file remoto viene scaricato nuovamente. Questo comportamento equivale all'uso di OutFile senza Resume.

Se il file locale non esiste, viene creato il file locale e viene scaricato l'intero file remoto. Questo comportamento equivale all'uso di OutFile senza Resume.

Questa funzionalità è stata aggiunta in PowerShell 6.1.0.

Proprietà dei parametri

Set di parametri

-RetryIntervalSec

Specifica l'intervallo tra i tentativi di connessione quando viene ricevuto un codice di errore compreso tra 400 e 599 inclusi o 304. Vedere anche Parametro MaximumRetryCount per specificare il numero di tentativi. Il valore deve essere compreso tra 1 e [int]::MaxValue.

Quando il codice di errore è 429 e la risposta include la proprietà Retry-After nelle relative intestazioni, il cmdlet usa tale valore per l'intervallo di ripetizione dei tentativi, anche se questo parametro è specificato.

Proprietà dei parametri

Set di parametri

-SessionVariable

Specifica una variabile per cui questo cmdlet crea una sessione di richiesta Web e la salva nel valore . Immettere un nome di variabile senza il simbolo del dollaro ($).

Quando si specifica una variabile di sessione, Invoke-WebRequest crea un oggetto sessione di richiesta Web e lo assegna a una variabile con il nome specificato nella sessione di PowerShell. È possibile usare la variabile nella sessione non appena il comando viene completato.

Prima di PowerShell 7.4, la sessione di richiesta Web non è una connessione permanente. Si tratta di un oggetto che contiene informazioni sulla connessione e sulla richiesta, inclusi cookie, credenziali, il valore massimo di reindirizzamento e la stringa dell'agente utente. È possibile usarlo per condividere lo stato e i dati tra le richieste Web.

A partire da PowerShell 7.4, la sessione di richiesta Web è persistente, purché le proprietà della sessione non vengano sottoposte a override in una richiesta successiva. Quando le condizioni sono soddisfatte, il cmdlet ricrea la sessione con i nuovi valori. Le sessioni persistenti riducono il sovraccarico per le richieste ripetute, rendendole molto più veloci.

Per usare la sessione di richiesta Web nelle richieste Web successive, specificare la variabile di sessione nel valore del parametro WebSession. PowerShell usa i dati nell'oggetto sessione di richiesta Web quando si stabilisce la nuova connessione. Per eseguire l'override di un valore nella sessione di richiesta Web, usare un parametro cmdlet, ad esempio UserAgent o Credenziali. I valori dei parametri hanno la precedenza sui valori nella sessione di richiesta Web.

Non è possibile usare i parametri SessionVariable e WebSession nello stesso comando.

Proprietà dei parametri

Set di parametri

-SkipCertificateCheck

Ignora i controlli di convalida dei certificati. Sono incluse tutte le convalide, ad esempio scadenza, revoca, autorità radice attendibile e così via.

Questa funzionalità è stata aggiunta in PowerShell 6.0.0.

Proprietà dei parametri

Set di parametri

-SkipHeaderValidation

Indica che il cmdlet deve aggiungere intestazioni alla richiesta senza alcuna convalida.

Questa opzione deve essere usata per i siti che richiedono valori di intestazione non conformi agli standard. Specificando questa opzione, la convalida viene disabilitata per consentire il passaggio del valore non controllato. Quando specificato, tutte le intestazioni vengono aggiunte senza convalida.

Questa opzione disabilita la convalida per i valori passati ai parametri ContentType, Headers e UserAgent .

Questa funzionalità è stata aggiunta in PowerShell 6.0.0.

Proprietà dei parametri

Set di parametri

-SkipHttpErrorCheck

Questo parametro fa sì che il cmdlet ignori gli stati di errore HTTP e continui a elaborare le risposte. Le risposte di errore vengono scritte nella pipeline esattamente come se avessero esito positivo.

Questo parametro è stato introdotto in PowerShell 7.

Proprietà dei parametri

Set di parametri

-SslProtocol

Imposta i protocolli SSL/TLS consentiti per la richiesta Web. Per impostazione predefinita, tutti i protocolli SSL/TLS supportati dal sistema sono consentiti. SslProtocol consente di limitare protocolli specifici a scopo di conformità.

Questi valori sono definiti come un'enumerazione basata su flag. È possibile combinare più valori per impostare più flag usando questo parametro. I valori possono essere passati al parametro SslProtocol come matrice di valori o come stringa delimitata da virgole di tali valori. Il cmdlet combina i valori usando un'operazione binary-OR. Il passaggio di valori come array è l'opzione più semplice e consente anche di usare il completamento automatico con il tasto tab sui valori. Potrebbe non essere possibile definire più opzioni in tutte le piattaforme.

Questa funzionalità è stata aggiunta in PowerShell 6.0.0 e il supporto per Tls13 è stato aggiunto in PowerShell 7.1.

Proprietà dei parametri

Set di parametri

-Token

Il token OAuth o Bearer da includere nella richiesta. Token è richiesto da alcune opzioni di Autenticazione. Non può essere usato in modo indipendente.

Il token accetta un SecureString oggetto contenente il token. Per fornire il token manualmente, usare quanto segue:

Invoke-WebRequest -Uri $uri -Authentication OAuth -Token (Read-Host -AsSecureString)

Questo parametro è stato introdotto in PowerShell 6.0.

Proprietà dei parametri

Set di parametri

-TransferEncoding

Specifica un valore per l'intestazione della risposta HTTP di codifica del trasferimento. I valori accettabili per questo parametro sono:

• Chunked
• Compress
• Deflate
• GZip
• Identity

Proprietà dei parametri

Set di parametri

-UnixSocket

Specifica il nome del socket Unix a cui connettersi. Questo parametro è supportato nei sistemi basati su Unix e Windows versione 1803 e successive. Per ulteriori informazioni sul supporto di Windows per i socket Unix, vedere l'articolo del blog Interoperabilità Windows/WSL con AF_UNIX.

Questo parametro è stato aggiunto in PowerShell 7.4.

Proprietà dei parametri

Set di parametri

-Uri

Specifica l'URI (Uniform Resource Identifier) della risorsa Internet a cui viene inviata la richiesta Web. Immettere un URI. Questo parametro supporta solo HTTP o HTTPS.

Questo parametro è obbligatorio. Il nome del parametro Uri è facoltativo.

Proprietà dei parametri

Set di parametri

-UseBasicParsing

Questo parametro è stato deprecato. A partire da PowerShell 6.0.0, tutte le richieste Web usano solo l'analisi di base. Questo parametro è incluso solo per la compatibilità con le versioni precedenti e qualsiasi uso di esso non ha alcun effetto sull'operazione del cmdlet.

Proprietà dei parametri

Set di parametri

-UseDefaultCredentials

Indica che il cmdlet usa le credenziali dell'utente corrente per inviare la richiesta Web. Non può essere usato con Authentication o Credential e potrebbe non essere supportato in tutte le piattaforme.

Proprietà dei parametri

Set di parametri

-UserAgent

Specifica una stringa dell'agente utente per la richiesta Web.

L'agente utente predefinito è simile a Mozilla/5.0 (Windows NT 10.0; Microsoft Windows 10.0.15063; en-US) PowerShell/6.0.0 con lievi variazioni per ogni sistema operativo e piattaforma.

Per testare un sito Web con la stringa dell'agente utente standard usata dalla maggior parte dei browser Internet, utilizzare le proprietà della classe PSUserAgent , ad esempio Chrome, Firefox, InternetExplorer, Opera e Safari.

Ad esempio, il comando seguente usa la stringa dell'agente utente per Internet Explorer: Invoke-WebRequest -Uri https://website.com/ -UserAgent ([Microsoft.PowerShell.Commands.PSUserAgent]::InternetExplorer)

Proprietà dei parametri

Set di parametri

-WebSession

Specifica una sessione di richiesta Web. Immettere il nome della variabile, incluso il segno di dollaro ($).

Per eseguire l'override di un valore nella sessione di richiesta Web, usare un parametro cmdlet, ad esempio UserAgent o Credenziali. I valori dei parametri hanno la precedenza sui valori nella sessione di richiesta Web. Anche le intestazioni correlate al contenuto, ad esempio Content-Type, vengono sottoposte a override quando viene fornito un oggetto MultipartFormDataContent per Body.

A differenza di una sessione remota, la sessione di richiesta Web non è una connessione permanente. Si tratta di un oggetto che contiene informazioni sulla connessione e sulla richiesta, inclusi cookie, credenziali, il valore massimo di reindirizzamento e la stringa dell'agente utente. È possibile usarlo per condividere lo stato e i dati tra le richieste Web.

Per creare una sessione di richiesta Web, immettere un nome di variabile, senza un segno di dollaro, nel valore del parametro SessionVariable di un comando Invoke-WebRequest. Invoke-WebRequest crea la sessione e la salva nella variabile . Nei comandi successivi usare la variabile come valore del parametro webSession.

Non è possibile usare i parametri SessionVariable e WebSession nello stesso comando.

Proprietà dei parametri

Set di parametri

CommonParameters

Input

Object

Output

BasicHtmlWebResponseObject

Note

Collegamenti correlati

• Invoke-RestMethod
• ConvertFrom-Json
• ConvertTo-Json