Invoke-RestMethod

Modül:

Microsoft.PowerShell.Utility Module

RESTful web hizmetine HTTP veya HTTPS isteği gönderir.

Syntax

Default (Varsayılan)

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

Invoke-RestMethod cmdlet, zengin yapılandırılmış veriler döndüren Temsili Durum Aktarımı (REST) web hizmetlerine HTTP ve HTTPS istekleri gönderir.

PowerShell, yanıtı veri türüne göre biçimlendirer. Bir RSS veya ATOM akışı için PowerShell, Öğe veya Giriş XML düğümlerini döndürür. JavaScript Nesne Gösterimi (JSON) veya XML için PowerShell içeriği [pscustomobject] nesnelere dönüştürür veya seri durumdan çıkartır. JSON verilerinde açıklamalara izin verilmez.

Uyarı

Varsayılan olarak, Invoke-RestMethod web sayfasının içeriğini ayrıştırmaktadır. Web sayfasındaki betik kodu, sayfa ayrıştırıldığında çalıştırılabilir. -UseBasicParsing Betik kodu yürütülmesini önlemek için anahtarını kullanın.

Bu cmdlet, Windows PowerShell 3.0'da kullanıma sunulmuştur. Bu komut diğer ad kullanılarak irm çalıştırılabilir.

Varsayılan olarak, HTTP isteği aşağıdaki HTTP üst bilgileri için varsayılan değerleri içerir:

• Host
• User-Agent

Diğer üst bilgileri eklemek veya varsayılan değerleri geçersiz kılmak için Headers parametresini kullanın.

Örnekler

Örnek 1: PowerShell RSS akışını alma

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

Bu komut, PowerShell Blogu RSS akışından bilgi almak için Invoke-RestMethod cmdlet'ini kullanır. Komut, her blogdaki Format-Table ve pubDate özelliklerinin değerlerini bir tabloda görüntülemek için cmdlet'ini kullanır.

Örnek 2

Aşağıdaki örnekte, kullanıcı Invoke-RestMethod çalıştırarak kullanıcının kuruluşundaki intranet web sitesinde POST isteği gerçekleştirir.

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

Örnek 3: Birden çok başlık geçirme

Bu örnek, hash-table'dan bir REST API'sine birden çok üst bilginin nasıl aktarılabileceğini göstermektedir.

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

API'ler genellikle kimlik doğrulaması, doğrulama vb. için geçirilen üst bilgiler gerektirir.

Örnek 3: Form verilerini gönderme

Gövde bir form olduğunda veya başka bir Invoke-WebRequest çağrısının çıktısı olduğunda, PowerShell istek içeriğini form alanlarına ayarlar.

Örneğin:

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

Örnek 4: İşlem hattında geri döndürülen öğeleri listele

GitHub birçok nesneyi bir dizi içinde döndürür. Çıkışı başka bir komuta aktarırsanız, tek bir [Object[]]nesnesi olarak gönderilir.

Nesneleri işlem hattına numaralandırmak için, sonuçları Write-Output'a iletin veya cmdlet'i parantez içine alın. Aşağıdaki örnek, GitHub tarafından döndürülen nesne sayısını sayar. Ardından işlem hattına numaralandırılmış nesne sayısını sayar.

$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

Parametreler

-Body

İsteğin gövdesini belirtir. Gövde, üst bilgileri izleyen isteğin içeriğidir. Gövde değerini Invoke-RestMethodüzerine yönlendirebilirsiniz.

Body parametresi, sorgu parametrelerinin listesini veya içeriğini belirtmek için kullanılabilir.

istek. Giriş bir GET isteği olduğunda ve gövde bir IDictionary (genellikle bir karma tablosu) olduğunda, gövde sorgu parametreleri olarak URI'ye eklenir. Diğer istek türleri (POST gibi) için gövde, standart ad=değer biçiminde istek gövdesinin değeri olarak ayarlanır.

Uyarı

POST gövdesinin ayrıntılı çıktısı with -1-byte payloadile sona erer, ancak gövdenin boyutu bilinmekle birlikte Content-Length HTTP üst bilgisinde de gönderilir.

Parametre özellikleri

Tür:	Object
Default value:	None
Joker karakterleri destekler:	False
DontShow:	False

Parametre kümeleri

(All)

Position:	Named
Zorunlu:	False
İşlem hattından gelen değer:	True
Özellik adına göre işlem hattından gelen değer:	False
Kalan bağımsız değişkenlerden elde edilen değer:	False

-Certificate

Güvenli bir web isteği için kullanılan istemci sertifikasını belirtir. Sertifikayı içeren bir değişken veya sertifikayı alan bir komut veya ifade girin.

Sertifika bulmak için Get-PfxCertificate kullanın veya Sertifika (Get-ChildItem) sürücüsündeki Cert: cmdlet'ini kullanın. Sertifika geçerli değilse veya yeterli yetkiye sahip değilse, komut başarısız olur.

Parametre özellikleri

Tür:	X509Certificate
Default value:	None
Joker karakterleri destekler:	False
DontShow:	False

Parametre kümeleri

(All)

Position:	Named
Zorunlu:	False
İşlem hattından gelen değer:	False
Özellik adına göre işlem hattından gelen değer:	False
Kalan bağımsız değişkenlerden elde edilen değer:	False

-CertificateThumbprint

İsteği gönderme izni olan bir kullanıcı hesabının dijital ortak anahtar sertifikasını (X509) belirtir. Sertifikanın parmak izini girin.

Sertifikalar, istemci sertifikası tabanlı kimlik doğrulamasında kullanılır. Sertifikalar yalnızca yerel kullanıcı hesaplarıyla eşlenebilir, etki alanı hesaplarıyla eşlenemez.

Sertifika parmak izini görmek için Get-Item veya Get-ChildItem komutunu kullanarak Cert:\CurrentUser\Myiçinde sertifikayı bulun.

Parametre özellikleri

Tür:	String
Default value:	None
Joker karakterleri destekler:	False
DontShow:	False

Parametre kümeleri

(All)

Position:	Named
Zorunlu:	False
İşlem hattından gelen değer:	False
Özellik adına göre işlem hattından gelen değer:	False
Kalan bağımsız değişkenlerden elde edilen değer:	False

-ContentType

Web isteğinin içerik türünü belirtir.

ContentType değeri kodlama biçimini (charsetolarak) içeriyorsa, cmdlet web isteğinin gövdesini kodlamak için bu biçimi kullanır. ContentType kodlama biçimi belirtmiyorsa, bunun yerine varsayılan kodlama biçimi kullanılır. Kodlama biçimine sahip bir ContentType örneği, text/plain; charset=iso-8859-5 alfabesini belirten şeklindedir.

parametresini atlarsanız, içerik türü kullandığınız HTTP yöntemine göre farklı olabilir:

• POST yöntemi için içerik türü application/x-www-form-urlencoded
• PUT yöntemi için içerik türü application/json
• Diğer yöntemler için içerik türü istekte belirtilmez

Dosyayı karşıya yüklemek için InFile parametresini kullanıyorsanız, içerik türünü ayarlamanız gerekir. Genellikle türü application/octet-streamolmalıdır. Ancak, içerik türünü uç noktanın gereksinimlerine göre ayarlamanız gerekir.

Parametre özellikleri

Tür:	String
Default value:	None
Joker karakterleri destekler:	False
DontShow:	False

Parametre kümeleri

(All)

Position:	Named
Zorunlu:	False
İşlem hattından gelen değer:	False
Özellik adına göre işlem hattından gelen değer:	False
Kalan bağımsız değişkenlerden elde edilen değer:	False

-Credential

İsteği gönderme izni olan bir kullanıcı hesabı belirtir. Varsayılan değer mevcut kullanıcıdır.

User01 veya Domain01\User01gibi bir kullanıcı adı yazın veya cmdlet'i tarafından oluşturulan Get-Credential nesnesi girin.

Kimlik bilgileri bir PSCredential nesnesinde depolanır ve parola SecureStringolarak depolanır.

Uyarı

SecureString veri koruması hakkında daha fazla bilgi için bkz. SecureString ne kadar güvenli?.

Parametre özellikleri

Tür:	PSCredential
Default value:	Current user
Joker karakterleri destekler:	False
DontShow:	False

Parametre kümeleri

(All)

Position:	Named
Zorunlu:	False
İşlem hattından gelen değer:	False
Özellik adına göre işlem hattından gelen değer:	False
Kalan bağımsız değişkenlerden elde edilen değer:	False

-DisableKeepAlive

HTTP üst bilgisindeki KeepAlive değerini False olarak ayarlar. Varsayılan olarak KeepAlive True'dur. KeepAlive, sonraki istekleri kolaylaştırmak için sunucuya kalıcı bir bağlantı kurar.

Parametre özellikleri

Tür:	SwitchParameter
Default value:	False
Joker karakterleri destekler:	False
DontShow:	False

Parametre kümeleri

(All)

Position:	Named
Zorunlu:	False
İşlem hattından gelen değer:	False
Özellik adına göre işlem hattından gelen değer:	False
Kalan bağımsız değişkenlerden elde edilen değer:	False

-Headers

Web isteğinin üst bilgilerini belirtir. Bir hash tablosu veya sözlük girin.

UserAgent üst bilgilerini ayarlamak için UserAgent parametresini kullanın. UserAgent veya çerez başlıklarını belirtmek için bu parametreyi kullanamazsınız.

Parametre özellikleri

Tür:	IDictionary
Default value:	None
Joker karakterleri destekler:	False
DontShow:	False

Parametre kümeleri

(All)

Position:	Named
Zorunlu:	False
İşlem hattından gelen değer:	False
Özellik adına göre işlem hattından gelen değer:	False
Kalan bağımsız değişkenlerden elde edilen değer:	False

-InFile

Web isteği gövdesinin içeriğini bir dosyadan alır. Bir yol ve dosya adı girin. Yolu atlarsanız, varsayılan ayar şu anki konumdur.

İsteğin içerik türünü de ayarlamanız gerekir. Örneğin, bir dosyayı karşıya yüklemek için içerik türünü ayarlamanız gerekir. Genellikle türü application/octet-streamolmalıdır. Ancak, içerik türünü uç noktanın gereksinimlerine göre ayarlamanız gerekir.

Parametre özellikleri

Tür:	String
Default value:	None
Joker karakterleri destekler:	False
DontShow:	False

Parametre kümeleri

(All)

Position:	Named
Zorunlu:	False
İşlem hattından gelen değer:	False
Özellik adına göre işlem hattından gelen değer:	False
Kalan bağımsız değişkenlerden elde edilen değer:	False

-MaximumRedirection

Windows PowerShell'in bağlantı başarısız olmadan önce bir bağlantıyı kaç kez alternatif bir Tekdüzen Kaynak Tanımlayıcısı'na (URI) yönlendireceğini belirler. Varsayılan değer 5'tir. 0 (sıfır) değeri tüm yeniden yönlendirmeyi engeller.

Parametre özellikleri

Tür:	Int32
Default value:	5
Joker karakterleri destekler:	False
DontShow:	False

Parametre kümeleri

(All)

Position:	Named
Zorunlu:	False
İşlem hattından gelen değer:	False
Özellik adına göre işlem hattından gelen değer:	False
Kalan bağımsız değişkenlerden elde edilen değer:	False

-Method

Web isteği için kullanılan yöntemi belirtir. Bu parametre için kabul edilebilir değerler şunlardır:

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

Parametre özellikleri

Tür:	WebRequestMethod
Default value:	Default
Kabul edilen değerler:	Default, Get, Head, Post, Put, Delete, Trace, Options, Merge, Patch
Joker karakterleri destekler:	False
DontShow:	False

Parametre kümeleri

(All)

Position:	Named
Zorunlu:	False
İşlem hattından gelen değer:	False
Özellik adına göre işlem hattından gelen değer:	False
Kalan bağımsız değişkenlerden elde edilen değer:	False

-OutFile

Yanıt gövdesini belirtilen çıkış dosyasına kaydeder. Bir yol ve dosya adı girin. Yolu atlarsanız, varsayılan ayar şu anki konumdur.

Varsayılan olarak, Invoke-RestMethod sonuçları işlem hattına döndürür.

Parametre özellikleri

Tür:	String
Default value:	None
Joker karakterleri destekler:	False
DontShow:	False

Parametre kümeleri

(All)

Position:	Named
Zorunlu:	False
İşlem hattından gelen değer:	False
Özellik adına göre işlem hattından gelen değer:	False
Kalan bağımsız değişkenlerden elde edilen değer:	False

-PassThru

Bu parametre yalnızca komutta OutFile parametresi de kullanıldığında geçerlidir. Amaç, sonuçların dosyaya ve işlem hattına yazılmasıdır.

Uyarı

PassThru parametresini kullandığınızda, çıkış işlem hattına yazılır ancak dosya boş olur. Daha fazla bilgi için bkz. PowerShell Sorunu #15409.

Parametre özellikleri

Tür:	SwitchParameter
Default value:	No output
Joker karakterleri destekler:	False
DontShow:	False

Parametre kümeleri

(All)

Position:	Named
Zorunlu:	False
İşlem hattından gelen değer:	False
Özellik adına göre işlem hattından gelen değer:	False
Kalan bağımsız değişkenlerden elde edilen değer:	False

-Proxy

doğrudan İnternet kaynağına bağlanmak yerine istek için bir ara sunucu kullanır. Ağ proxy sunucusunun URI'sini girin.

Parametre özellikleri

Tür:	Uri
Default value:	None
Joker karakterleri destekler:	False
DontShow:	False

Parametre kümeleri

(All)

Position:	Named
Zorunlu:	False
İşlem hattından gelen değer:	False
Özellik adına göre işlem hattından gelen değer:	False
Kalan bağımsız değişkenlerden elde edilen değer:	False

-ProxyCredential

Proxy parametresi tarafından belirtilen proxy sunucusunu kullanma izni olan bir kullanıcı hesabı belirtir. Varsayılan değer mevcut kullanıcıdır.

"User01" veya "Domain01\User01" gibi bir kullanıcı adı yazın veya cmdlet'i tarafından oluşturulan bir nesne gibi Get-Credential nesnesi girin.

Bu parametre yalnızca komutta Proxy parametresi de kullanıldığında geçerlidir. ProxyCredential ve ProxyUseDefaultCredentials parametrelerini aynı komutta kullanamazsınız.

Parametre özellikleri

Tür:	PSCredential
Default value:	Current user
Joker karakterleri destekler:	False
DontShow:	False

Parametre kümeleri

(All)

Position:	Named
Zorunlu:	False
İşlem hattından gelen değer:	False
Özellik adına göre işlem hattından gelen değer:	False
Kalan bağımsız değişkenlerden elde edilen değer:	False

-ProxyUseDefaultCredentials

Proxy parametresi tarafından belirtilen ara sunucuya erişmek için geçerli kullanıcının kimlik bilgilerini kullanır.

Bu parametre yalnızca komutta Proxy parametresi de kullanıldığında geçerlidir. ProxyCredential ve ProxyUseDefaultCredentials parametrelerini aynı komutta kullanamazsınız.

Parametre özellikleri

Tür:	SwitchParameter
Default value:	None
Joker karakterleri destekler:	False
DontShow:	False

Parametre kümeleri

(All)

Position:	Named
Zorunlu:	False
İşlem hattından gelen değer:	False
Özellik adına göre işlem hattından gelen değer:	False
Kalan bağımsız değişkenlerden elde edilen değer:	False

-SessionVariable

Web isteği oturumunu içeren bir değişken oluşturur. Dolar işareti ($) simgesi olmadan bir değişken adı girin.

Bir oturum değişkeni belirttiğinizde, Invoke-RestMethod bir web isteği oturum nesnesi oluşturur ve bunu PowerShell oturumunuzda belirtilen ada sahip bir değişkene atar. Komutu tamamlar tamamlamaz, değişkeni oturumunuzda kullanabilirsiniz.

Uzak oturumdan farklı olarak, web isteği oturumu kalıcı bir bağlantı değildir. Bağlantı ve istek hakkında çerezler, kimlik bilgileri, maksimum yönlendirme sayısı ve kullanıcı aracı dizgesi gibi bilgileri içeren bir nesnedir. Web istekleri arasında durum ve veri paylaşmak için bunu kullanabilirsiniz.

Sonraki web isteklerinde web isteği oturumunu kullanmak için WebSession parametresinin değerinde oturum değişkenini belirtin. PowerShell, yeni bağlantı kurarken web isteği oturum nesnesindeki verileri kullanır. Web isteği oturumundaki bir değeri geçersiz kılmak için UserAgent veya Credentialgibi bir cmdlet parametresi kullanın. Parametre değerleri web isteği oturumundaki değerlerden önceliklidir.

SessionVariable ve WebSession parametrelerini aynı komutta kullanamazsınız.

Parametre özellikleri

Tür:	String
Default value:	None
Joker karakterleri destekler:	False
DontShow:	False
Diğer adlar:	SV

Parametre kümeleri

(All)

Position:	Named
Zorunlu:	False
İşlem hattından gelen değer:	False
Özellik adına göre işlem hattından gelen değer:	False
Kalan bağımsız değişkenlerden elde edilen değer:	False

-TimeoutSec

İsteğin zaman aşımına uğramadan önce ne kadar süreyle beklenebileceğini belirtir. Saniye olarak bir değer girin. Varsayılan değer olan 0, süresiz bir zaman aşımı belirtir.

Etki Alanı Adı Sistemi (DNS) sorgusunun geri döndürülmesi veya zaman aşımına uğraması 15 saniye kadar sürebilir. İsteğiniz çözüm gerektiren bir konak adı içeriyorsa ve TimeoutSec'i sıfırdan büyük ancak 15 saniyeden kısa bir değere ayarlarsanız, bir WebException atılmadan önce 15 saniye veya daha uzun sürebilir ve isteğinizin zaman aşımına uğramasına neden olabilir.

Parametre özellikleri

Tür:	Int32
Default value:	0
Joker karakterleri destekler:	False
DontShow:	False

Parametre kümeleri

(All)

Position:	Named
Zorunlu:	False
İşlem hattından gelen değer:	False
Özellik adına göre işlem hattından gelen değer:	False
Kalan bağımsız değişkenlerden elde edilen değer:	False

-TransferEncoding

Aktarım kodlaması HTTP yanıt üst bilgisi için bir değer belirtir. Bu parametre için kabul edilebilir değerler şunlardır:

• Chunked
• Compress
• Deflate
• GZip
• Identity

Parametre özellikleri

Tür:	String
Default value:	None
Kabul edilen değerler:	chunked, compress, deflate, gzip, identity
Joker karakterleri destekler:	False
DontShow:	False

Parametre kümeleri

(All)

Position:	Named
Zorunlu:	False
İşlem hattından gelen değer:	False
Özellik adına göre işlem hattından gelen değer:	False
Kalan bağımsız değişkenlerden elde edilen değer:	False

-Uri

Web isteğinin gönderildiği internet kaynağının Tekdüzen Kaynak Tanımlayıcısını (URI) belirtir. Bu parametre HTTP, HTTPS, FTP ve FILE değerlerini destekler.

Bu parametre gereklidir. Parametre adı (Uri) isteğe bağlıdır.

Parametre özellikleri

Tür:	Uri
Default value:	None
Joker karakterleri destekler:	False
DontShow:	False

Parametre kümeleri

(All)

Position:	0
Zorunlu:	True
İşlem hattından gelen değer:	False
Özellik adına göre işlem hattından gelen değer:	False
Kalan bağımsız değişkenlerden elde edilen değer:	False

-UseBasicParsing

Cmdlet'in temel ayrıştırma kullandığını gösterir. Cmdlet, String nesnesindeki ham HTML'yi döndürür.

Parametre özellikleri

Tür:	SwitchParameter
Default value:	None
Joker karakterleri destekler:	False
DontShow:	False

Parametre kümeleri

(All)

Position:	Named
Zorunlu:	False
İşlem hattından gelen değer:	False
Özellik adına göre işlem hattından gelen değer:	False
Kalan bağımsız değişkenlerden elde edilen değer:	False

-UseDefaultCredentials

Web isteğini göndermek için geçerli kullanıcının kimlik bilgilerini kullanır.

Parametre özellikleri

Tür:	SwitchParameter
Default value:	None
Joker karakterleri destekler:	False
DontShow:	False

Parametre kümeleri

(All)

Position:	Named
Zorunlu:	False
İşlem hattından gelen değer:	False
Özellik adına göre işlem hattından gelen değer:	False
Kalan bağımsız değişkenlerden elde edilen değer:	False

-UserAgent

Web isteği için bir kullanıcı aracısı dizesi belirtir.

Varsayılan kullanıcı aracısı, her işletim sistemi ve platform için küçük varyasyonları olan Mozilla/5.0 (Windows NT 10.0; Microsoft Windows 10.0.15063; en-US) PowerShell/6.0.0 benzerdir.

Web sitesini çoğu internet tarayıcısı tarafından kullanılan standart kullanıcı aracısı dizesiyle test etmek için Chrome, Firefox, InternetExplorer, Opera ve Safari gibi PSUserAgent sınıfının özelliklerini kullanın.

Parametre özellikleri

Tür:	String
Default value:	None
Joker karakterleri destekler:	False
DontShow:	False

Parametre kümeleri

(All)

Position:	Named
Zorunlu:	False
İşlem hattından gelen değer:	False
Özellik adına göre işlem hattından gelen değer:	False
Kalan bağımsız değişkenlerden elde edilen değer:	False

-WebSession

Belirli bir web isteği oturumunu belirtir. Dolar işareti ($) dahil olmak üzere değişken adını girin.

Web isteği oturumundaki bir değeri geçersiz kılmak için UserAgent veya Credentialgibi bir cmdlet parametresi kullanın. Parametre değerleri web isteği oturumundaki değerlerden önceliklidir.

Uzak oturumdan farklı olarak, web isteği oturumu kalıcı bir bağlantı değildir. Bağlantı ve istek hakkında çerezler, kimlik bilgileri, maksimum yönlendirme sayısı ve kullanıcı aracı dizgesi gibi bilgileri içeren bir nesnedir. Web istekleri arasında durum ve veri paylaşmak için bunu kullanabilirsiniz.

Web isteği oturumu oluşturmak için bir komutunun Invoke-RestMethod parametresinin değerine dolar işareti olmadan bir değişken adı girin. Invoke-RestMethod oturumu oluşturur ve bu oturumu değişkene kaydeder. Sonraki komutlarda, WebSession parametresinin değeri olarak değişkenini kullanın.

SessionVariable ve WebSession parametrelerini aynı komutta kullanamazsınız.

Parametre özellikleri

Tür:	WebRequestSession
Default value:	None
Joker karakterleri destekler:	False
DontShow:	False

Parametre kümeleri

(All)

Position:	Named
Zorunlu:	False
İşlem hattından gelen değer:	False
Özellik adına göre işlem hattından gelen değer:	False
Kalan bağımsız değişkenlerden elde edilen değer:	False

CommonParameters

Bu cmdlet yaygın parametreleri destekler: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction ve -WarningVariable. Daha fazla bilgi için bkz. about_CommonParameters.

Girişler

Object

Web isteğinin gövdesini bu cmdlet'e iletebilirsiniz.

Çıkışlar

Int64

İstek bir tamsayı döndürdüğünde, bu cmdlet bu tamsayıyı döndürür.

String

İstek bir dize döndürdüğünde, bu cmdlet bu dizeyi döndürür.

XmlDocument

İstek geçerli XML döndürdüğünde, bu cmdlet bunu XmlDocumentolarak döndürür.

PSObject

İstek JSON dizeleri döndürdüğünde, bu cmdlet verileri temsil eden bir PSObject döndürür.

Notlar

Windows PowerShell, Invoke-RestMethodiçin aşağıdaki diğer adları içerir:

• irm

REST uç noktası birden çok nesne döndürdüğünde, nesneler dizi olarak alınır. Invoke-RestMethod çıktısını başka bir komuta gönderirseniz, tek bir [Object[]] nesnesi olarak gönderilir. Bu dizinin içeriği, işlem hattındaki bir sonraki komut için numaralandırılmamıştır.

İlişkili Bağlantılar

• ConvertTo-Json (Json'a Dönüştür)
• Json'dan Dönüştür
• Web isteği başlatma komutu (Invoke-WebRequest)