Invoke-RestMethod

Sintaxe

Default (Default)

Invoke-RestMethod
    [-Method <WebRequestMethod>]
    [-UseBasicParsing]
    [-Uri] <Uri>
    [-WebSession <WebRequestSession>]
    [-SessionVariable <String>]
    [-Credential <PSCredential>]
    [-UseDefaultCredentials]
    [-CertificateThumbprint <String>]
    [-Certificate <X509Certificate>]
    [-UserAgent <String>]
    [-DisableKeepAlive]
    [-TimeoutSec <Int32>]
    [-Headers <IDictionary>]
    [-MaximumRedirection <Int32>]
    [-Proxy <Uri>]
    [-ProxyCredential <PSCredential>]
    [-ProxyUseDefaultCredentials]
    [-Body <Object>]
    [-ContentType <String>]
    [-TransferEncoding <String>]
    [-InFile <String>]
    [-OutFile <String>]
    [-PassThru]
    [<CommonParameters>]

Description

Exemplos

Exemplo 1: Obter o feed RSS do PowerShell

Invoke-RestMethod -Uri https://devblogs.microsoft.com/powershell/feed/ |
  Format-Table -Property Title, pubDate

Title                                                                pubDate
-----                                                                -------
Join the PowerShell 10th Anniversary Celebration!                    Tue, 08 Nov 2016 23:00:04 +0000
DSC Resource Kit November 2016 Release                               Thu, 03 Nov 2016 00:19:07 +0000
PSScriptAnalyzer Community Call - Oct 18, 2016                       Thu, 13 Oct 2016 17:52:35 +0000
New Home for In-Box DSC Resources                                    Sat, 08 Oct 2016 07:13:10 +0000
New Social Features on Gallery                                       Fri, 30 Sep 2016 23:04:34 +0000
PowerShellGet and PackageManagement in PowerShell Gallery and GitHub Thu, 29 Sep 2016 22:21:42 +0000
PowerShell Security at DerbyCon                                      Wed, 28 Sep 2016 01:13:19 +0000
DSC Resource Kit September Release                                   Thu, 22 Sep 2016 00:25:37 +0000
PowerShell DSC and implicit remoting broken in KB3176934             Tue, 23 Aug 2016 15:07:50 +0000
PowerShell on Linux and Open Source!                                 Thu, 18 Aug 2016 15:32:02 +0000

Exemplo 2

$Cred = Get-Credential

# Next, allow the use of self-signed SSL certificates.

[System.Net.ServicePointManager]::ServerCertificateValidationCallback = { $true }

# Create variables to store the values consumed by the Invoke-RestMethod command.
# The search variable contents are later embedded in the body variable.

$Server = 'server.contoso.com'
$Url = "https://${server}:8089/services/search/jobs/export"
$Search = "search index=_internal | reverse | table index,host,source,sourcetype,_raw"

# The cmdlet handles URL encoding. The body variable describes the search criteria, specifies CSV as
# the output mode, and specifies a time period for returned data that starts two days ago and ends
# one day ago. The body variable specifies values for parameters that apply to the particular REST
# API with which Invoke-RestMethod is communicating.

$Body = @{
    search = $Search
    output_mode = "csv"
    earliest_time = "-2d@d"
    latest_time = "-1d@d"
}

# Now, run the Invoke-RestMethod command with all variables in place, specifying a path and file
# name for the resulting CSV output file.

Invoke-RestMethod -Method Post -Uri $url -Credential $Cred -Body $body -OutFile output.csv

{"preview":true,"offset":0,"result":{"sourcetype":"contoso1","count":"9624"}}

{"preview":true,"offset":1,"result":{"sourcetype":"contoso2","count":"152"}}

{"preview":true,"offset":2,"result":{"sourcetype":"contoso3","count":"88494"}}

{"preview":true,"offset":3,"result":{"sourcetype":"contoso4","count":"15277"}}

Exemplo 3: passar vários cabeçalhos

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

Exemplo 3: Enviar dados de formulário

$R = Invoke-WebRequest https://website.com/login.aspx
$R.Forms[0].Name = "MyName"
$R.Forms[0].Password = "MyPassword"
Invoke-RestMethod https://website.com/service.aspx -Body $R.Forms[0]

Exemplo 4: enumerar itens retornados no pipeline

$uri = 'https://api.github.com/repos/microsoftdocs/powershell-docs/issues'
$x = 0
Invoke-RestMethod -Uri $uri | ForEach-Object { $x++ }
$x
1

$x = 0
(Invoke-RestMethod -Uri $uri) | ForEach-Object { $x++ }
$x
30

$x = 0
Invoke-RestMethod -Uri $uri | Write-Output | ForEach-Object { $x++ }
$x
30

Parâmetros

-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-RestMethod.

O parâmetro Body pode ser usado para especificar uma lista de parâmetros de consulta ou especificar o conteúdo do .

pedir. 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 POST), o corpo é definido como o valor do corpo da solicitação no formato name=value padrão.

Propriedades do parâmetro

Conjuntos de parâmetros

-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

Conjuntos de parâmetros

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

Propriedades do parâmetro

Conjuntos de parâmetros

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

Propriedades do parâmetro

Conjuntos de parâmetros

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

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

Propriedades do parâmetro

Conjuntos de parâmetros

-DisableKeepAlive

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

Conjuntos de parâmetros

-Headers

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

Para definir cabeçalhos UserAgent, use o parâmetro UserAgent. Você não pode usar esse parâmetro para especificar useragent ou cabeçalhos de cookie.

Propriedades do parâmetro

Conjuntos de parâmetros

-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

Conjuntos de parâmetros

-MaximumRedirection

Determina quantas vezes o Windows 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

Conjuntos de parâmetros

-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

Propriedades do parâmetro

Conjuntos de parâmetros

-OutFile

Salva o corpo da resposta no arquivo de saída especificado. Insira um caminho e um nome de arquivo. Se você omitir o caminho, o padrão será o local atual.

Por padrão, Invoke-RestMethod retorna os resultados para o pipeline.

Propriedades do parâmetro

Conjuntos de parâmetros

-PassThru

Esse parâmetro é válido somente quando o parâmetro OutFile também é usado no comando. A intenção é que os resultados sejam gravados no arquivo e no pipeline.

Propriedades do parâmetro

Conjuntos de parâmetros

-Proxy

Usa 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

Conjuntos de parâmetros

-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

Conjuntos de parâmetros

-ProxyUseDefaultCredentials

Usa as credenciais do usuário atual para acessar o servidor proxy especificado pelo parâmetro proxy.

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

Conjuntos de parâmetros

-SessionVariable

Cria uma variável que contém a sessão de solicitação da Web. Insira um nome de variável sem o símbolo de cifrão ($).

Quando você especifica uma variável de sessão, Invoke-RestMethod 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.

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

Conjuntos de parâmetros

-TimeoutSec

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 expirar. Se sua solicitação contiver um nome de host que exija resolução e você definir TimeoutSec como um valor maior que zero, mas menor que 15 segundos, podem se passar 15 segundos ou mais antes que uma WebException seja gerada e sua solicitação expire devido ao tempo limite.

Propriedades do parâmetro

Conjuntos de parâmetros

-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

Conjuntos de parâmetros

-Uri

Especifica o URI (Uniform Resource Identifier) do recurso de Internet para o qual a solicitação da Web é enviada. Esse parâmetro dá suporte a valores HTTP, HTTPS, FTP e FILE.

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

Propriedades do parâmetro

Conjuntos de parâmetros

-UseBasicParsing

Indica que o cmdlet usa análise básica. O cmdlet retorna o HTML bruto em um objeto String.

Propriedades do parâmetro

Conjuntos de parâmetros

-UseDefaultCredentials

Usa as credenciais do usuário atual para enviar a solicitação da Web.

Propriedades do parâmetro

Conjuntos de parâmetros

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

Propriedades do parâmetro

Conjuntos de parâmetros

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

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-RestMethod. Invoke-RestMethod 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

Conjuntos de parâmetros

CommonParameters

Entradas

Object

Saídas

Int64

String

XmlDocument

PSObject

Observações

Links Relacionados

• ConvertTo-Json
• ConvertFrom-Json
• Invoke-WebRequest