Compartilhar via

Invoke-WebRequest

Módulo:
Microsoft.PowerShell.Utility Module

Obtém conteúdo de uma página da web na Internet.

Sintaxe

StandardMethod (Padrão) 

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

Description

O cmdlet Invoke-WebRequest envia solicitações HTTP e HTTPS para uma página da Web ou serviço Web. Ele analisa a resposta e retorna conjuntos de links, imagens e outros elementos HTML significativos.

Esse cmdlet foi introduzido no PowerShell 3.0.

A partir do PowerShell 7.0, Invoke-WebRequest dá suporte à configuração de proxy definida por variáveis de ambiente. Consulte a seção Anotações deste artigo.

Importante

Os exemplos neste artigo fazem referência a hosts no domínio contoso.com. Esse é um domínio fictício usado pela Microsoft para exemplos. Os exemplos são projetados para mostrar como usar os cmdlets. No entanto, como os sites de contoso.com não existem, os exemplos não funcionam. Adapte os exemplos aos hosts em seu ambiente.

A partir do PowerShell 7.4, a codificação de caracteres para solicitações usa como padrão UTF-8 em vez de ASCII. Se você precisar de uma codificação diferente, deverá definir o atributo charset no cabeçalho Content-Type.

Exemplos

Exemplo 1: Enviar uma solicitação da Web

Este exemplo usa o cmdlet Invoke-WebRequest para enviar uma solicitação da Web para o site 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   5280

O primeiro comando emite a solicitação e salva a resposta na variável $Response.

O segundo comando obtém qualquer InputField em que a propriedade Name é como "* Value". Os resultados filtrados são canalizados para Select-Object para selecionar as propriedades de Nome do e Valor.

Exemplo 2: usar um serviço Web com estado

Este exemplo mostra como usar o cmdlet Invoke-WebRequest com um serviço Web com estado.

$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

A primeira chamada para Invoke-WebRequest envia uma solicitação de entrada. O comando especifica um valor de Session para o valor do parâmetro SessionVariable. Quando o comando é concluído, a variável $LoginResponse contém um BasicHtmlWebResponseObject e a variável $Session contém um objeto WebRequestSession. Isso registra o usuário no site.

A segunda chamada para Invoke-WebRequest busca o perfil do usuário, o que exige que o usuário seja conectado ao site. Os dados de sessão armazenados na variável $Session fornecem cookies de sessão para o site criado durante o logon.

Este exemplo obtém os links em uma página da Web. Ele usa o cmdlet Invoke-WebRequest para obter o conteúdo da página da Web. Em seguida, ele usa a propriedade Links da BasicHtmlWebResponseObject que Invoke-WebRequest retorna e a propriedade Href de cada link.

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

Exemplo 4: gravar conteúdo de resposta em um arquivo usando a codificação definida na página solicitada

Este exemplo usa o cmdlet Invoke-WebRequest para recuperar o conteúdo da página da Web de uma página de documentação do PowerShell.

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

O primeiro comando recupera a página e salva o objeto de resposta na variável $Response.

O segundo comando cria um StreamWriter a ser usado para gravar o conteúdo da resposta em um arquivo. A propriedade codificação do objeto de resposta é usada para definir a codificação do arquivo.

Os últimos comandos gravam a propriedade Content no arquivo e descartam o StreamWriter.

Observe que a propriedade de Codificação de será nula se a solicitação da Web não retornar conteúdo de texto.

Exemplo 5: Enviar um arquivo multipart/form-data

Este exemplo usa o cmdlet Invoke-WebRequest carregar um arquivo como um envio multipart/form-data. O arquivo C:\document.txt é enviado como o campo de formulário document com o Content-Type de text/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'

Exemplo 6: Envio simplificado de várias partes/Form-Data

Algumas APIs exigem envios multipart/form-data para carregar arquivos e conteúdo misto. Este exemplo demonstra a atualização de um perfil de usuário.

$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

O formulário de perfil requer estes campos: firstName, lastName, email, avatar, birthdaye hobbies. A API espera que uma imagem da foto do perfil do usuário seja fornecida no campo avatar. A API também aceita várias entradas de hobbies a serem enviadas no mesmo formulário.

Ao criar o $Form HashTable, os nomes de chave são usados como nomes de campo de formulário. Por padrão, os valores do HashTable são convertidos em cadeias de caracteres. Se um System.IO.FileInfo valor estiver presente, o conteúdo do arquivo será enviado. Se uma coleção como matrizes ou listas estiverem presentes, o campo de formulário será enviado várias vezes.

Usando Get-Item na chave avatar, o objeto FileInfo é definido como o valor. O resultado é que os dados de imagem de jdoe.png são enviados.

Ao fornecer uma lista para a chave hobbies, o campo hobbies está presente nos envios uma vez para cada item de lista.

Exemplo 7: capturar mensagens sem êxito de Invoke-WebRequest

Quando Invoke-WebRequest encontra uma mensagem HTTP sem êxito (404, 500 etc.), ela não retorna nenhuma saída e gera um erro de encerramento. Para capturar o erro e exibir o StatusCode você pode colocar a execução em um bloco de try/catch.

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

O erro de término é capturado pelo bloco catch, que recupera o StatusCode do objeto Exception.

Exemplo 8: Baixar vários arquivos ao mesmo tempo

O cmdlet Invoke-WebRequest só pode baixar um arquivo por vez. O exemplo a seguir usa Start-ThreadJob para criar vários trabalhos de thread para baixar vários arquivos ao mesmo tempo.

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

Exemplo 9: Ignorar validação de cabeçalho

Por padrão, o cmdlet Invoke-WebRequest valida os valores de cabeçalhos conhecidos que têm um formato de valor definido por padrões. O exemplo a seguir mostra como essa validação pode gerar um erro e como você pode usar o parâmetro SkipHeaderValidation para evitar a validação de valores para pontos de extremidade que toleram valores formatados inválidos.

$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 é um serviço que retorna informações sobre solicitações da Web e respostas para solução de problemas. A variável $Uri é atribuída ao endpoint /headers do serviço, que retorna os cabeçalhos de uma solicitação como conteúdo em sua resposta.

O cabeçalho de solicitação If-Match é definido na RFC-7232 seção 3.1 e requer que o valor desse cabeçalho seja definido entre aspas. A variável $InvalidHeaders recebe uma tabela de hash em que o valor de If-Match é inválido porque é definido como 12345 em vez de "12345".

Chamar Invoke-WebRequest com os cabeçalhos inválidos retorna um relatório de erro informando que o valor formatado é inválido. A solicitação não é enviada para o ponto de extremidade.

Chamar Invoke-WebRequest com o parâmetro SkipHeaderValidation ignora a falha de validação e envia a solicitação para o endpoint. Como o ponto de extremidade tolera valores de cabeçalho não compatíveis, o cmdlet retorna o objeto de resposta sem erro.

Exemplo 10: Enviar uma solicitação usando HTTP 2.0

Este exemplo obtém os links em uma página da Web usando o protocolo HTTP 2.0. Ele usa o cmdlet Invoke-WebRequest para obter o conteúdo da página da Web. Em seguida, ele usa a propriedade Links da BasicHtmlWebResponseObject que Invoke-WebRequest retorna e a propriedade Href de cada link.

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

Exemplo 11: Enviar uma solicitação para um aplicativo de soquete Unix

Alguns aplicativos, como o Docker, expõem um soquete Unix para comunicação. Este exemplo consulta uma lista de imagens do Docker usando a API do Docker. O cmdlet se conecta ao daemon do Docker usando o soquete Unix.

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

Parâmetros

-AllowInsecureRedirect

Permite redirecionamento de HTTPS para HTTP. Por padrão, qualquer solicitação redirecionada de HTTPS para HTTP resulta em um erro e a solicitação é anulada para impedir a comunicação sem querer em texto sem formatação por conexões não criptografadas. Para substituir esse comportamento por sua conta e risco, use o parâmetro AllowInsecureRedirect.

Esse parâmetro foi adicionado no PowerShell 7.4.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:False
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-AllowUnencryptedAuthentication

Permite o envio de credenciais e segredos em conexões não criptografadas. Por padrão, fornecer de Credencial ou qualquer opção de Autenticação de com um Uri que não começa com https:// resulta em um erro e a solicitação é anulada para impedir a comunicação intencional de segredos em texto sem formatação por conexões não criptografadas. Para substituir esse comportamento por sua conta e risco, forneça o parâmetro AllowUnencryptedAuthentication.

Aviso

O uso desse parâmetro não é seguro e não é recomendado. Ele é fornecido apenas para compatibilidade com sistemas herdados que não podem fornecer conexões criptografadas. Use por sua conta e risco.

Esse recurso foi adicionado ao PowerShell 6.0.0.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:False
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Authentication

Especifica o tipo de autenticação explícita a ser usado para a solicitação. O padrão é None. O parâmetro de Autenticação não pode ser usado com o parâmetro UseDefaultCredentials.

Opções de autenticação disponíveis:

  • None: Essa é a opção padrão quando a Autenticação não é fornecida. Nenhuma autenticação explícita é usada.
  • Basic: requer Credencial . As credenciais são enviadas como um cabeçalho Authorization: Basic de Autenticação Básica rfc 7617 no formato de base64(user:password).
  • Bearer: requer o parâmetro Token. Envia um cabeçalho rfc 6750 Authorization: Bearer com o token fornecido.
  • OAuth: requer o parâmetro Token. Envia um cabeçalho rfc 6750 Authorization: Bearer com o token fornecido.

Fornecer Autenticação substitui quaisquer cabeçalhos Authorization fornecidos para Headers ou incluídos em WebSession.

Esse recurso foi adicionado ao PowerShell 6.0.0.

Propriedades do parâmetro

Tipo:WebAuthenticationType
Valor padrão:None
Valores aceitos:None, Basic, Bearer, OAuth
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Body

Especifica o corpo da solicitação. O corpo da solicitação é o conteúdo que segue os cabeçalhos. Você também pode redirecionar um valor de corpo para Invoke-WebRequest.

O parâmetro Body pode ser usado para especificar uma lista de parâmetros de consulta ou especificar o conteúdo da resposta. Para parâmetros de consulta, o cmdlet usa o método System.Net.WebUtility.UrlEncode para codificar os pares chave-valor. Para obter mais informações sobre a codificação de cadeias de caracteres para URLs, consulte a referência do método UrlEncode().

Quando a entrada é uma solicitação POST e o corpo é um String, o valor à esquerda do primeiro sinal igual (=) é definido como uma chave nos dados do formulário e o texto restante é definido como o valor. Para especificar várias chaves, use um objeto IDictionary, como uma tabela de hash, para Body.

Quando a entrada é uma solicitação GET e o corpo é um IDictionary (normalmente, uma tabela de hash), o corpo é adicionado ao URI como parâmetros de consulta. Para outros tipos de solicitação (como PATCH), o corpo é definido como o valor do corpo da solicitação no formato de name=value padrão com os valores codificados em URL.

Quando a entrada é um objeto System.Xml.XmlNode e a declaração XML especifica uma codificação, essa codificação é usada para os dados na solicitação, a menos que seja substituída pelo parâmetro ContentType.

O parâmetro Body também aceita um objeto System.Net.Http.MultipartFormDataContent. Isso facilita multipart/form-data solicitações. Quando um objeto MultipartFormDataContent é fornecido para Body, todos os cabeçalhos relacionados ao conteúdo fornecidos ao ContentType, Headersou webSession parâmetros são substituídos pelos cabeçalhos content do objeto MultipartFormDataContent. Esse recurso foi adicionado ao PowerShell 6.0.0.

Propriedades do parâmetro

Tipo:Object
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Certificate

Especifica o certificado do cliente usado para uma solicitação da Web segura. Insira uma variável que contenha um certificado ou um comando ou expressão que obtém o certificado.

Para localizar um certificado, use Get-PfxCertificate ou use o cmdlet Get-ChildItem na unidade Certificado (Cert:). Se o certificado não for válido ou não tiver autoridade suficiente, o comando falhará.

Propriedades do parâmetro

Tipo:X509Certificate
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-CertificateThumbprint

Especifica o certificado de chave pública digital (X509) de uma conta de usuário que tem permissão para enviar a solicitação. Insira a impressão digital do certificado.

Os certificados são usados na autenticação baseada em certificado do cliente. Os certificados só podem ser mapeados apenas para contas de usuário locais, não para contas de domínio.

Para ver a impressão digital do certificado, use o comando Get-Item ou Get-ChildItem para localizar o certificado no Cert:\CurrentUser\My.

Observação

Esse recurso só tem suporte em plataformas do sistema operacional Windows.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-ConnectionTimeoutSeconds

Especifica quanto tempo a solicitação pode ficar pendente antes de atingir o tempo limite. Insira um valor em segundos. O valor padrão, 0, especifica um tempo limite indefinido.

Uma consulta DNS (Sistema de Nomes de Domínio) pode levar até 15 segundos para retornar ou atingir o tempo limite. Se sua solicitação contiver um nome de host que exija resolução e você definir ConnectionTimeoutSeconds com um valor maior que zero, mas menor que 15 segundos, poderá levar 15 segundos ou mais até uma WebException ser emitida e a solicitação exceder o tempo limite.

Esse parâmetro substituiu o parâmetro TimeoutSec no PowerShell 7.4. Você pode usar TimeoutSec como alias para ConnectionTimeoutSeconds.

Propriedades do parâmetro

Tipo:Int32
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:TimeoutSec

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-ContentType

Especifica o tipo de conteúdo da solicitação da Web.

Se o valor de ContentType contiver o formato de codificação (como charset), o cmdlet usará esse formato para codificar o corpo da solicitação da Web. Se o ContentType não especificar um formato de codificação, o formato de codificação padrão será usado. Um exemplo de contentType com um formato de codificação é text/plain; charset=iso-8859-5, que especifica o alfabeto latino/cirílico.

Se você omitir o parâmetro, o tipo de conteúdo poderá ser diferente com base no método HTTP que você usa:

  • Para um método POST, o tipo de conteúdo é application/x-www-form-urlencoded
  • Para um método PUT, o tipo de conteúdo é application/json
  • Para outros métodos, o tipo de conteúdo não é especificado na solicitação

Se você estiver usando o parâmetro InFile para carregar um arquivo, defina o tipo de conteúdo. Normalmente, o tipo deve ser application/octet-stream. No entanto, você precisa definir o tipo de conteúdo com base nos requisitos do ponto de extremidade.

ContentType é substituído quando o Body é um objeto MultipartFormDataContent.

A partir do PowerShell 7.4, se você usar esse parâmetro e o parâmetro Headers para definir o cabeçalho Content-Type, o valor especificado no parâmetro ContentType será usado.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Credential

Especifica uma conta de usuário que tem permissão para enviar a solicitação. O padrão é o usuário atual.

Digite um nome de usuário, como user01 ou Domain01\User01, ou insira um objeto PSCredential gerado pelo cmdlet Get-Credential.

de Credencial pode ser usado sozinho ou em conjunto com determinadas opções de parâmetro de Autenticação. Quando usado sozinho, ele só fornece credenciais para o servidor remoto se o servidor remoto envia uma solicitação de desafio de autenticação. Quando usadas com opções de de Autenticação, as credenciais são enviadas explicitamente.

As credenciais são armazenadas em um objeto PSCredential e a senha é armazenada como um SecureString.

Observação

Para obter mais informações sobre a proteção de dados do SecureString, consulte Quão seguro é o SecureString?.

Propriedades do parâmetro

Tipo:PSCredential
Valor padrão:Current user
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-CustomMethod

Especifica um método personalizado usado para a solicitação da Web. Isso poderá ser usado se o Método de Solicitação exigido pelo ponto de extremidade não for uma opção disponível no método . Método e CustomMethod não podem ser usados juntos.

Este exemplo faz uma solicitação HTTP TEST para a API:

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

Esse recurso foi adicionado ao PowerShell 6.0.0.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:CENTÍMETRO

Conjuntos de parâmetros

CustomMethod
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False
CustomMethodNoProxy
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-DisableKeepAlive

Indica que o cmdlet define o valor KeepAlive no cabeçalho HTTP como False. Por padrão, KeepAlive é True. KeepAlive estabelece uma conexão persistente com o servidor para facilitar as solicitações subsequentes.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:False
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Form

Converte um dicionário em um envio multipart/form-data. Form pode não ser usado com Body. Se contentType for usado, ele será ignorado.

As chaves do dicionário são utilizadas como nomes dos campos do formulário. Por padrão, os valores de formulário são convertidos em valores de cadeia de caracteres.

Se o valor for um objeto System.IO.FileInfo, o conteúdo do arquivo binário será enviado. O nome do arquivo é enviado como a propriedade nome de arquivo. O tipo MIME é definido como application/octet-stream. Get-Item pode ser usado para simplificar o fornecimento do objeto System.IO.FileInfo.

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

Se o valor for um tipo de coleção, como Matrizes ou Listas, o campo for enviado várias vezes. Os valores da lista são tratados como cadeias de caracteres por padrão. Se o valor for um objeto System.IO.FileInfo, o conteúdo do arquivo binário será enviado. Não há suporte para coleções aninhadas.

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

No exemplo acima, o campo tags é fornecido três vezes no formulário, uma vez para cada Vacation, Italye 2017. O campo pictures também é enviado uma vez para cada arquivo na pasta 2017-Italy. O conteúdo binário dos arquivos nessa pasta é enviado como os valores.

Esse recurso foi adicionado ao PowerShell 6.1.0.

Propriedades do parâmetro

Tipo:IDictionary
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Headers

Especifica os cabeçalhos da solicitação da Web. Insira uma tabela hash ou um dicionário.

Cabeçalhos relacionados ao conteúdo, como Content-Type são substituídos quando um objeto MultipartFormDataContent é fornecido para Body.

A partir do PowerShell 7.4, se você usar este parâmetro para definir o cabeçalho Content-Type e usar o parâmetro ContentType, o valor especificado no parâmetro ContentType será utilizado.

Propriedades do parâmetro

Tipo:IDictionary
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-HttpVersion

Especifica a versão HTTP usada para a solicitação. O padrão é 1.1.

Os valores válidos são:

  • 1,0
  • 1.1
  • 2.0
  • 3.0

Propriedades do parâmetro

Tipo:Version
Valor padrão:1.1
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-InFile

Obtém o conteúdo do corpo da solicitação da Web de um arquivo. Insira um caminho e um nome de arquivo. Se você omitir o caminho, o padrão será o local atual.

Você também precisa definir o tipo de conteúdo da solicitação. Por exemplo, para carregar um arquivo, você deve definir o tipo de conteúdo. Normalmente, o tipo deve ser application/octet-stream. No entanto, você precisa definir o tipo de conteúdo com base nos requisitos do ponto de extremidade.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-MaximumRedirection

Especifica quantas vezes o PowerShell redireciona uma conexão para um URI (Uniform Resource Identifier) alternativo antes que a conexão falhe. O valor padrão é 5. Um valor de 0 (zero) impede todo o redirecionamento.

Propriedades do parâmetro

Tipo:Int32
Valor padrão:5
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-MaximumRetryCount

Especifica quantas vezes o PowerShell tenta novamente uma conexão quando um código de falha entre 400 e 599, inclusive ou 304 é recebido. Veja também o parâmetro RetryIntervalSec para especificar o intervalo entre novas tentativas.

Propriedades do parâmetro

Tipo:Int32
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Method

Especifica o método usado para a solicitação da Web. Os valores aceitáveis para este parâmetro são:

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

O parâmetro CustomMethod pode ser usado para métodos de solicitação não listados acima.

Propriedades do parâmetro

Tipo:WebRequestMethod
Valor padrão:None
Valores aceitos:Default, Get, Head, Post, Put, Delete, Trace, Options, Merge, Patch
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

StandardMethod
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False
StandardMethodNoProxy
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-NoProxy

Indica que o cmdlet não deve usar um proxy para chegar ao destino. Quando precisar ignorar o proxy configurado no ambiente, use essa opção. Esse recurso foi adicionado ao PowerShell 6.0.0.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:False
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

StandardMethodNoProxy
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False
CustomMethodNoProxy
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-OperationTimeoutSeconds

Esse tempo limite se aplica a leituras de dados dentro de um fluxo, não ao tempo de fluxo como um todo. O valor padrão, 0, especifica um tempo limite indefinido.

Definir o valor como 30 segundos significa que qualquer atraso de mais de 30 segundos entre os dados no fluxo encerra a solicitação. Um arquivo grande que leva vários minutos para ser baixado não será encerrado, a menos que o fluxo fique parado por mais de 30 segundos.

Propriedades do parâmetro

Tipo:Int32
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-OutFile

Por padrão, Invoke-WebRequest retorna os resultados para o pipeline. Quando você usa o parâmetro OutFile, os resultados são salvos no arquivo especificado e não retornados ao pipeline. Insira um caminho e um nome de arquivo. Para enviar os resultados para um arquivo e para o pipeline, adicione o parâmetro PassThru.

Se você omitir o caminho, o padrão será o local atual. O nome é tratado como um caminho de literal. Os nomes que contêm colchetes ([]) devem ser colocados entre aspas simples (').

A partir do PowerShell 7.4, você pode especificar um caminho de pasta sem o nome do arquivo. Quando você faz isso, o comando usa o nome do arquivo do último segmento do URI resolvido após quaisquer redirecionamentos. Quando você especifica um caminho de pasta para OutFile, não é possível usar o parâmetro Resume.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-PassThru

Indica que o cmdlet retorna os resultados, além de escrevê-los em um arquivo. Esse parâmetro é válido somente quando o parâmetro OutFile também é usado no comando.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:False
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-PreserveAuthorizationOnRedirect

Indica que o cmdlet deve preservar o cabeçalho Authorization, quando presente, durante redirecionamentos.

Por padrão, o cmdlet remove o cabeçalho Authorization antes de redirecionar. Especificar esse parâmetro desabilita essa lógica para casos em que o cabeçalho precisa ser enviado para o local de redirecionamento.

Esse recurso foi adicionado ao PowerShell 6.0.0.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:False
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-PreserveHttpMethodOnRedirect

Indica que o cmdlet deve manter o método da solicitação durante os redirecionamentos.

Por padrão, o cmdlet altera o método para GET quando redirecionado. Especificar esse parâmetro desabilita essa lógica para garantir que o método pretendido possa ser usado com redirecionamento.

Esse recurso foi adicionado ao PowerShell 7.4.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:False
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Proxy

Especifica um servidor proxy para a solicitação, em vez de se conectar diretamente ao recurso da Internet. Insira o URI de um servidor proxy de rede.

Propriedades do parâmetro

Tipo:Uri
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

StandardMethod
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False
CustomMethod
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-ProxyCredential

Especifica uma conta de usuário que tem permissão para usar o servidor proxy especificado pelo parâmetro proxy. O padrão é o usuário atual.

Digite um nome de usuário, como User01 ou Domain01\User01, ou insira um objeto PSCredential, como um gerado pelo cmdlet Get-Credential.

Esse parâmetro é válido somente quando o parâmetro Proxy também é usado no comando. Você não pode usar os parâmetros ProxyCredential e ProxyUseDefaultCredentials no mesmo comando.

Propriedades do parâmetro

Tipo:PSCredential
Valor padrão:Current user
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

StandardMethod
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False
CustomMethod
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-ProxyUseDefaultCredentials

Indica que o cmdlet usa as credenciais do usuário atual para acessar o servidor proxy especificado pelo parâmetro proxy do .

Esse parâmetro é válido somente quando o parâmetro Proxy também é usado no comando. Você não pode usar os parâmetros ProxyCredential e ProxyUseDefaultCredentials no mesmo comando.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:False
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

StandardMethod
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False
CustomMethod
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Resume

Executa uma tentativa máxima de retomar o download de um arquivo parcial. Retomar requer OutFile.

Resume opera apenas com base no tamanho do arquivo local e do arquivo remoto e não executa nenhuma outra verificação para garantir que o arquivo local e o arquivo remoto sejam os mesmos.

Se o tamanho do arquivo local for menor que o tamanho do arquivo remoto, o cmdlet tentará retomar o download do arquivo e acrescentar os bytes restantes ao final do arquivo.

Se o tamanho do arquivo local for o mesmo que o tamanho do arquivo remoto, nenhuma ação será executada e o cmdlet assumirá que o download já foi concluído.

Se o tamanho do arquivo local for maior que o tamanho do arquivo remoto, o arquivo local será substituído e todo o arquivo remoto será baixado novamente. Esse comportamento é o mesmo que usar OutFile sem Resume.

Se o servidor remoto não der suporte à retomada do download, o arquivo local será substituído e todo o arquivo remoto será baixado novamente. Esse comportamento é o mesmo que usar OutFile sem Resume.

Se o arquivo local não existir, o arquivo local será criado e todo o arquivo remoto será baixado. Esse comportamento é o mesmo que usar OutFile sem Resume.

Esse recurso foi adicionado ao PowerShell 6.1.0.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:False
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-RetryIntervalSec

Especifica o intervalo entre novas tentativas para a conexão quando um código de falha entre 400 e 599, inclusive ou 304 é recebido. Consulte também parâmetro MaximumRetryCount para especificar o número de repetições. O valor deve estar entre 1 e [int]::MaxValue.

Quando o código de falha é 429 e a resposta inclui a propriedade Retry-After em seus cabeçalhos, o cmdlet usa esse valor para o intervalo de repetição, mesmo se esse parâmetro for especificado.

Propriedades do parâmetro

Tipo:Int32
Valor padrão:5
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-SessionVariable

Especifica uma variável para a qual esse cmdlet cria uma sessão de solicitação da Web e a salva no valor. Insira um nome de variável sem o símbolo de cifrão ($).

Quando você especifica uma variável de sessão, Invoke-WebRequest cria um objeto de sessão de solicitação da Web e o atribui a uma variável com o nome especificado na sessão do PowerShell. Você pode usar a variável em sua sessão assim que o comando for concluído.

Antes do PowerShell 7.4, a sessão de solicitação da Web não é uma conexão persistente. É um objeto que contém informações sobre a conexão e a solicitação, incluindo cookies, credenciais, o valor máximo de redirecionamento e a cadeia de caracteres do agente do usuário. Você pode usá-lo para compartilhar o estado e os dados entre solicitações da Web.

A partir do PowerShell 7.4, a sessão de solicitação da Web é persistente, desde que as propriedades da sessão não sejam substituídas em uma solicitação subsequente. Quando essas condições forem atendidas, o cmdlet recriará a sessão com os novos valores. As sessões persistentes reduzem a sobrecarga para solicitações repetidas, tornando-as muito mais rápidas.

Para usar a sessão de solicitação web em solicitações web subsequentes, especifique a variável de sessão no valor do parâmetro WebSession. O PowerShell usa os dados no objeto de sessão de solicitação da Web ao estabelecer a nova conexão. Para substituir um valor na sessão de solicitação da Web, use um parâmetro de cmdlet, como UserAgent ou Credencial. Os valores de parâmetro têm precedência sobre valores na sessão de solicitação da Web.

Você não pode usar os parâmetros SessionVariable e WebSession no mesmo comando.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:SV

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-SkipCertificateCheck

Ignora as verificações de validação de certificado. Isso inclui todas as validações, como expiração, revogação, autoridade raiz confiável etc.

Aviso

O uso desse parâmetro não é seguro e não é recomendado. Essa opção destina-se apenas para uso em hosts conhecidos que usam um certificado autoassinado para fins de teste. Use por sua conta e risco.

Esse recurso foi adicionado ao PowerShell 6.0.0.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:False
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-SkipHeaderValidation

Indica que o cmdlet deve adicionar cabeçalhos à solicitação sem validação.

Essa opção deve ser usada para sites que exigem valores de cabeçalho que não estão em conformidade com os padrões. Especificar essa opção desabilita a validação para permitir que o valor seja passado desmarcado. Quando especificado, todos os cabeçalhos são adicionados sem validação.

Essa opção desabilita a validação de valores passados para os parâmetros ContentType, Headers e UserAgent.

Esse recurso foi adicionado ao PowerShell 6.0.0.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:False
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-SkipHttpErrorCheck

Esse parâmetro faz com que o cmdlet ignore os status de erro HTTP e continue a processar respostas. As respostas de erro são gravadas no pipeline como se tivessem sido bem-sucedidas.

Esse parâmetro foi introduzido no PowerShell 7.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:False
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-SslProtocol

Define os protocolos SSL/TLS que são permitidos para a solicitação da Web. Por padrão, todos os protocolos SSL/TLS compatíveis com o sistema são permitidos. SslProtocol permite limitar a protocolos específicos para fins de conformidade.

Esses valores são definidos como uma enumeração baseada em sinalizador. Você pode combinar vários valores para definir vários sinalizadores usando esse parâmetro. Os valores podem ser passados para o parâmetro SslProtocol como uma matriz de valores ou como uma cadeia de caracteres separada por vírgulas desses valores. O cmdlet combina os valores usando uma operação binária-OR. Passar valores como uma matriz é a opção mais simples e também permite usar o preenchimento com Tab nos valores. Talvez você não consiga definir várias opções em todas as plataformas.

Observação

Em plataformas não Windows, talvez não seja possível fornecer Tls ou Tls12 como uma opção. O suporte para Tls13 não está disponível em todos os sistemas operacionais e precisará ser verificado por sistema operacional.

Esse recurso foi adicionado ao PowerShell 6.0.0 e o suporte para Tls13 foi adicionado ao PowerShell 7.1.

Propriedades do parâmetro

Tipo:WebSslProtocol
Valor padrão:None
Valores aceitos:Default, Tls, Tls11, Tls12
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Token

O token OAuth ou Bearer a ser incluído na solicitação. Token é exigido por determinadas opções de Authentication. Ele não pode ser usado de forma independente.

Token usa um SecureString que contém o token. Para fornecer o token manualmente, use o seguinte:

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

Esse parâmetro foi introduzido no PowerShell 6.0.

Propriedades do parâmetro

Tipo:SecureString
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-TransferEncoding

Especifica um valor para o cabeçalho de resposta HTTP de codificação de transferência. Os valores aceitáveis para este parâmetro são:

  • Chunked
  • Compress
  • Deflate
  • GZip
  • Identity

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Valores aceitos:chunked, compress, deflate, gzip, identity
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-UnixSocket

Especifica o nome do soquete Unix ao qual se conectar. Esse parâmetro tem suporte em sistemas baseados em Unix e no Windows versão 1803 e posterior. Para obter mais informações sobre o suporte do Windows a soquetes Unix, consulte a postagem no blog Interoperabilidade do Windows/WSL com AF_UNIX.

Esse parâmetro foi adicionado no PowerShell 7.4.

Propriedades do parâmetro

Tipo:UnixDomainSocketEndPoint
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Uri

Especifica o URI (Uniform Resource Identifier) do recurso de Internet para o qual a solicitação da Web é enviada. Insira um URI. Esse parâmetro dá suporte apenas a HTTP ou HTTPS.

Este parâmetro é obrigatório. O nome do parâmetro Uri é opcional.

Propriedades do parâmetro

Tipo:Uri
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:0
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-UseBasicParsing

Esse parâmetro foi preterido. A partir do PowerShell 6.0.0, todas as solicitações da Web usam somente análise básica. Esse parâmetro é incluído apenas para compatibilidade com versões anteriores e qualquer uso dele não tem efeito sobre a operação do cmdlet.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:False
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-UseDefaultCredentials

Indica que o cmdlet usa as credenciais do usuário atual para enviar a solicitação da Web. Isso não pode ser usado com Authentication ou Credential e pode não ser aceito em todas as plataformas.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:False
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-UserAgent

Especifica um string de agente de usuário para a requisição web.

O agente de usuário padrão é semelhante a Mozilla/5.0 (Windows NT 10.0; Microsoft Windows 10.0.15063; en-US) PowerShell/6.0.0 com pequenas variações para cada sistema operacional e plataforma.

Para testar um site com a cadeia de caracteres de agente de usuário padrão usada pela maioria dos navegadores da Internet, use as propriedades da classe PSUserAgent, como Chrome, Firefox, InternetExplorer, Opera e Safari.

Por exemplo, o seguinte comando usa a cadeia de caracteres do agente de usuário para o Internet Explorer: Invoke-WebRequest -Uri https://website.com/ -UserAgent ([Microsoft.PowerShell.Commands.PSUserAgent]::InternetExplorer)

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-WebSession

Especifica uma sessão de solicitação da Web. Insira o nome da variável, incluindo o sinal de dólar ($).

Para substituir um valor na sessão de solicitação da Web, use um parâmetro de cmdlet, como UserAgent ou Credencial. Os valores de parâmetro têm precedência sobre valores na sessão de solicitação da Web. Cabeçalhos relacionados ao conteúdo, como Content-Type, também são substituídos quando um objeto MultipartFormDataContent é fornecido para Body.

Ao contrário de uma sessão remota, a sessão de solicitação da Web não é uma conexão persistente. É um objeto que contém informações sobre a conexão e a solicitação, incluindo cookies, credenciais, o valor máximo de redirecionamento e a cadeia de caracteres do agente do usuário. Você pode usá-lo para compartilhar o estado e os dados entre solicitações da Web.

Para criar uma sessão de requisição web, insira um nome de variável, sem um sinal de dólar, no valor do parâmetro SessionVariable de um comando Invoke-WebRequest. Invoke-WebRequest cria a sessão e a salva na variável. Nos comandos subsequentes, use a variável como o valor do parâmetro WebSession.

Você não pode usar os parâmetros SessionVariable e WebSession no mesmo comando.

Propriedades do parâmetro

Tipo:WebRequestSession
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

Object

Você pode canalizar o corpo de uma solicitação da Web para este cmdlet.

Saídas

BasicHtmlWebResponseObject

Esse cmdlet retorna o objeto de resposta que representa o resultado da solicitação da Web.

Observações

O PowerShell inclui os seguintes aliases para Invoke-WebRequest:

  • Todas as plataformas:
    • iwr

A partir do PowerShell 6.0.0 Invoke-WebRequest dá suporte apenas à análise básica.

Para obter mais informações, consulte BasicHtmlWebResponseObject.

Devido a alterações no .NET Core 3.1, o PowerShell 7.0 e superior usam a propriedade HttpClient.DefaultProxy para determinar a configuração do proxy.

O valor dessa propriedade é determinado pela plataforma:

  • para Windows: lê a configuração de proxy de variáveis de ambiente. Se essas variáveis não forem definidas, a propriedade será derivada das configurações de proxy do usuário.
  • Para macOS: lê a configuração de proxy de variáveis de ambiente. Se essas variáveis não forem definidas, a propriedade será derivada das configurações de proxy do sistema.
  • para linux: lê a configuração de proxy de variáveis de ambiente. Se essas variáveis não forem definidas, a propriedade inicializará uma instância não configurada que ignora todos os endereços.

As variáveis de ambiente usadas para a inicialização do DefaultProxy em plataformas baseadas em Windows e Unix são:

  • HTTP_PROXY: o nome do host ou o endereço IP do servidor proxy usado em solicitações HTTP.
  • HTTPS_PROXY: o nome do host ou o endereço IP do servidor proxy usado em solicitações HTTPS.
  • ALL_PROXY: o nome do host ou endereço IP do servidor proxy usado em solicitações HTTP e HTTPS caso HTTP_PROXY ou HTTPS_PROXY não sejam definidos.
  • NO_PROXY: uma lista separada por vírgulas de nomes de host que devem ser excluídos do proxying.

O PowerShell 7.4 adicionou suporte para o algoritmo de compactação Brotli.