Invoke-RestMethod

Modül:

Microsoft.PowerShell.Utility Module

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

Sözdizimi

StandardMethod EnterprisePublishing

Invoke-RestMethod
    [-Uri] <Uri>
    [-FollowRelLink]
    [-MaximumFollowRelLink <Int32>]
    [-ResponseHeadersVariable <String>]
    [-StatusCodeVariable <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>]
    [-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-RestMethod
    [-Uri] <Uri>
    [-FollowRelLink]
    [-MaximumFollowRelLink <Int32>]
    [-ResponseHeadersVariable <String>]
    [-StatusCodeVariable <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>]
    [-Method <WebRequestMethod>]
    [-PreserveHttpMethodOnRedirect]
    [-UnixSocket <UnixDomainSocketEndPoint>]
    [-NoProxy]
    [-Body <Object>]
    [-Form <IDictionary>]
    [-ContentType <String>]
    [-TransferEncoding <String>]
    [-InFile <String>]
    [-OutFile <String>]
    [-PassThru]
    [-Resume]
    [-SkipHttpErrorCheck]
    [<CommonParameters>]

CustomMethod

Invoke-RestMethod
    [-Uri] <Uri>
    -CustomMethod <String>
    [-FollowRelLink]
    [-MaximumFollowRelLink <Int32>]
    [-ResponseHeadersVariable <String>]
    [-StatusCodeVariable <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-RestMethod
    [-Uri] <Uri>
    -CustomMethod <String>
    [-FollowRelLink]
    [-MaximumFollowRelLink <Int32>]
    [-ResponseHeadersVariable <String>]
    [-StatusCodeVariable <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

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

Uyarı

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.

Bu cmdlet, Windows PowerShell 3.0'da kullanıma sunulmuştur.

PowerShell 7.0'da Invoke-RestMethod ortam değişkenleri tarafından tanımlanan ara sunucu yapılandırmasını destekler. Bu makalenin NOTLAR bölümüne bakın.

PowerShell 7.4'den başlayarak, istekler için karakter kodlaması varsayılan olarak ASCII yerine UTF-8'e ayarlı olur. Farklı bir kodlamaya ihtiyacınız varsa, charset üst bilgisinde Content-Type özniteliğini ayarlamanız gerekir.

Örnekler

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

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

Invoke-RestMethod -Uri https://blogs.msdn.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

Örnek 2: POST isteği çalıştırma

Bu örnekte kullanıcı, kullanıcının kuruluşundaki intranet web sitesinde POST isteği yapmak için Invoke-RestMethod çalıştırır.

$Cred = Get-Credential
$Url = "https://server.contoso.com:8089/services/search/jobs/export"
$Body = @{
    search = "search index=_internal | reverse | table index,host,source,sourcetype,_raw"
    output_mode = "csv"
    earliest_time = "-2d@d"
    latest_time = "-1d@d"
}
Invoke-RestMethod -Method 'Post' -Uri $url -Credential $Cred -Body $body -OutFile output.csv

Cmdlet kimlik bilgilerini ister ve $Crediçinde depolar. $Url REST uç nokta URL'sini içerir.

$Body değişkeni arama ölçütlerini açıklar, çıkış modu olarak CSV'yi belirtir ve döndürülen veriler için iki gün önce başlayıp bir gün önce biten bir zaman aralığını belirtir. Gövde değişkeni, Invoke-RestMethod iletişimde olduğu belirli REST API'ye uygulanan parametrelerin değerlerini belirtir.

Invoke-RestMethod komutu tüm değişkenler yerinde çalıştırılır ve sonuçta elde edilen CSV çıktı dosyası için bir yol ve dosya adı belirtilir.

Örnek 3: İlişki bağlantılarını izleme

Bazı REST API'leri, RFC5988başına İlişki Bağlantıları aracılığıyla sayfalandırmayı destekler. Sonraki sayfanın URL'sini almak için üst bilgiyi ayrıştırmak yerine, cmdlet'in bunu sizin için gerçekleştirmesini sağlayabilirsiniz. Bu örnek, PowerShell GitHub deposundaki sorunların ilk iki sayfasını döndürür.

$url = 'https://api.github.com/repos/powershell/powershell/issues'
Invoke-RestMethod $url -FollowRelLink -MaximumFollowRelLink 2

Örnek 4: Basitleştirilmiş Çok ParçalıForm-Data Gönderimi

Dosyaları ve karma içeriği yüklemek için bazı API'ler multipart/form-data gönderimleri gerektirir. Bu örnekte bir kullanıcının profilinin nasıl güncelleştirilecekleri gösterilmektedir.

$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-RestMethod -Uri $Uri -Method Post -Form $Form

Profil formu şu alanları gerektirir: firstName, lastName, email, avatar, birthdayve hobbies. API, avatar alanında kullanıcı profili resmi için bir görüntü sağlanmasını bekliyor. API aynı formda gönderilecek birden çok hobbies girdisini de kabul eder.

$Form HashTable oluşturulurken, anahtar adları form alanı adları olarak kullanılır. Varsayılan olarak, HashTable değerleri dizelere dönüştürülür. bir System.IO.FileInfo değeri varsa, dosya içeriği gönderilir. Dizi veya liste gibi bir koleksiyon varsa, form alanı birden çok kez gönderilir.

Get-Item anahtarında avatar kullanıldığında, FileInfo nesnesi değer olarak ayarlanır. Sonuç, jdoe.png görüntü verilerinin gönderilmesidir.

hobbies anahtarına bir liste sağlandığında, hobbies alanı her liste öğesi için gönderimlerde bir kez bulunur.

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

API'ler genellikle kimlik doğrulaması veya geçerlilik doğrulaması için geçirilen üst bilgileri gerektirir. Bir hash-table'den REST API'ye birden çok üst bilgiyi nasıl geçireceğiniz bu örnekte gösterilmektedir.

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

Örnek 6: İşlem hattında döndürülen öğeleri listeleme

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

Örnek 7: Başlık Doğrulamasının Atlanması

varsayılan olarak, Invoke-RestMethod cmdlet'i standart tanımlı değer biçimine sahip iyi bilinen üst bilgilerin değerlerini doğrular. Aşağıdaki örnekte, bu doğrulamanın nasıl hata oluşturabileceği ve geçersiz biçimlendirilmiş değerleri tolere eden uç noktalar için değerlerin doğrulanmasından kaçınmak için SkipHeaderValidation parametresini nasıl kullanabileceğiniz gösterilmektedir.

$Uri = 'https://httpbin.org/headers'
$InvalidHeaders = @{
    'If-Match' = '12345'
}

Invoke-RestMethod -Uri $Uri -Headers $InvalidHeaders

Invoke-RestMethod -Uri $Uri -Headers $InvalidHeaders -SkipHeaderValidation |
    Format-List

Invoke-RestMethod: The format of value '12345' is invalid.

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=Root=1-62f150a6-27754fd4226f31b43a3d2874}

httpbin.org, sorun gidermeye yönelik web istekleri ve yanıtları hakkında bilgi döndüren bir hizmettir. $Uri değişkeni, yanıttaki içerik olarak bir isteğin üst bilgilerini döndüren hizmetin /headers uç noktasına atanır.

If-Match isteği üst bilgisi, RFC-7232 bölüm 3.1'de tanımlanmıştır ve bu üst bilginin değerinin, tırnak işaretleriyle çevrilmiş olarak tanımlanmasını gerektirir. $InvalidHeaders değişkenine, If-Match değerinin 12345yerine "12345" olarak tanımlandığı için geçersiz olduğu bir karma tablosu atanır.

Geçersiz üst bilgilerle Invoke-RestMethod çağrılması, biçimlendirilmiş değerin geçersiz olduğunu bildiren bir hata döndürür. İstek uç noktaya gönderilmez.

Invoke-RestMethod parametresiyle çağrılması doğrulama hatasını yoksayar ve isteği uç noktaya gönderir. Uç nokta uyumlu olmayan üst bilgi değerlerini tolere ettiğinden, cmdlet yanıt nesnesini hatasız döndürür.

Örnek 8: HTTP 2.0 kullanarak istek gönderme

Bu örnek, HTTP 2.0 protokolunu kullanarak GitHub sorununu sorgular.

$uri = 'https://api.github.com/repos/microsoftdocs/powershell-docs/issues'
Invoke-RestMethod -Uri $uri -HttpVersion 2.0 -SkipCertificateCheck

Örnek 9: Unix yuva uygulamasına istek gönderme

Docker gibi bazı uygulamalar, iletişim için unix yuvasını kullanıma sunar. Bu örnek, Docker API'sini kullanarak Docker görüntülerinin listesini sorgular. Cmdlet, Unix yuvasını kullanarak Docker daemon'a bağlanır.

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

Parametreler

-AllowInsecureRedirect

HTTPS'den HTTP'ye yeniden yönlendirmeye izin verir. Varsayılan olarak, HTTPS'den HTTP'ye yönlendirilen tüm istekler bir hatayla sonuçlanır ve şifrelenmemiş bağlantılar üzerinden yanlışlıkla düz metin olarak iletişim kurmasını önlemek için istek durduruldu. AllowInsecureRedirect parametresini kullanarak bu davranışı kendi sorumluluğunuzda geçersiz kılın.

Bu parametre PowerShell 7.4'e eklendi.

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

-AllowUnencryptedAuthentication

Kimlik bilgilerinin ve gizli dizilerin şifrelenmemiş bağlantılar üzerinden gönderilmesine izin verir. Varsayılan olarak, ile başlamayan bir Uri ile Kimlik Bilgisi veya herhangi bir https:// seçeneği verildiğinde hata oluşur ve istek, şifrelenmemiş bağlantılar üzerinden düz metinle gizli bilgiler yanlışlıkla iletilmesin diye iptal edilir. Bu davranışı kendi riski altında geçersiz kılmak için AllowUnencryptedAuthentication parametresini sağlayın.

Uyarı

Bu parametrenin kullanılması güvenli değildir ve önerilmez. Yalnızca şifrelenmiş bağlantılar sağlayamayan eski sistemlerle uyumluluk için sağlanır. Kendi riskinizle kullanın.

Bu özellik PowerShell 6.0.0'a eklendi.

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

-Authentication

İstek için kullanılacak açık kimlik doğrulama türünü belirtir. Varsayılan değer Yok'tır. Kimlik Doğrulaması parametresi, UseDefaultCredentials parametresiyle kullanılamaz.

Kullanılabilir Kimlik Doğrulama Seçenekleri:

• None: Kimlik Doğrulaması sağlanmadığında bu varsayılan seçenektir. Açık kimlik doğrulaması kullanılmaz.
• Basic: Kimlik Bilgisigerektirir. Kimlik bilgileri, Authorization: Basicbiçiminde bir RFC 7617 Temel Kimlik Doğrulaması base64(user:password) üst bilgisi göndermek için kullanılır.
• Bearer: Belirteci parametresini gerektirir. Verilen belirteçle bir RFC 6750 Authorization: Bearer üst bilgisi gönderir.
• OAuth: Belirteci parametresini gerektirir. Verilen belirteçle bir RFC 6750 Authorization: Bearer üst bilgisi gönderir.

Kimlik Doğrulaması sağlanması, Authorization veya WebSessionbağlamına sağlanan tüm üst bilgilerini geçersiz kılar.

Bu özellik PowerShell 6.0.0'a eklendi.

Parametre özellikleri

Tür:	WebAuthenticationType
Default value:	None
Kabul edilen değerler:	None, Basic, Bearer, OAuth
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

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

Gövde parametresi, sorgu parametrelerinin listesini belirtmek veya isteğin içeriğini belirtmek için kullanılabilir. Sorgu parametreleri için cmdlet, anahtar-değer çiftlerini kodlamak için System.Net.WebUtility.UrlEncode yöntemini kullanır. URL'ler için dize kodlama hakkında daha fazla bilgi için bkz. urlEncode() yöntem başvurusu .

Giriş bir POST isteği olduğunda ve gövde Dizeise, ilk eşittir işaretinin (=) solundaki değer form verilerinde anahtar olarak ayarlanır ve kalan metin değer olarak ayarlanır. Birden çok anahtar belirtmek için, Gövdeiçin karma tablo gibi bir IDictionary nesnesi kullanın.

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 (PATCH gibi) için gövde, istek gövdesinin standart name=value biçiminde url ile kodlanmış değerleriyle değeri olarak ayarlanır.

Giriş bir System.Xml.XmlNode nesnesiyse ve XML bildirimi bir kodlama belirtiyorsa, ContentType parametresi tarafından geçersiz kılınmadığı sürece istekteki veriler için bu kodlama kullanılır.

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.

Body parametresi, isteklerini kolaylaştıran bir multipart/form-data nesnesini de kabul edebilir. Bodyiçin bir MultipartFormDataContent nesnesi sağlandığında, ContentType, Headersveya WebSession parametrelerine sağlanan içerikle ilgili tüm üst bilgiler MultipartFormDataContent nesnesinin içerik üst bilgileri tarafından geçersiz kılınır. Bu özellik PowerShell 6.0.0'a eklendi.

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.

Uyarı

Bu özellik şu anda yalnızca Windows işletim sistemi platformlarında desteklenmektedir.

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

-ConnectionTimeoutSeconds

İ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 yanıt alması veya zaman aşımına uğraması 15 saniye kadar sürebilir. İsteğinizde çözümleme gerektiren bir ana bilgisayar adı varsa ve ConnectionTimeoutSeconds değerini sıfırdan büyük ama 15 saniyeden küçük bir değer olarak ayarlarsanız, bir WebException atılması ve isteğinizin zaman aşımına uğraması 15 saniye veya daha uzun sürebilir.

Bu parametre, PowerShell 7.4'teki TimeoutSec parametresinin yerini aldı. ConnectionTimeoutSecondsiçin diğer ad olarak TimeoutSec kullanabilirsiniz.

Parametre özellikleri

Tür:	Int32
Default value:	0
Joker karakterleri destekler:	False
DontShow:	False
Diğer adlar:	TimeoutSec

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.

GövdeMultipartFormDataContent nesnesi olduğunda ContentType geçersiz kılınır.

PowerShell 7.4'te başlayarak, üst bilgisini tanımlamak için hem bu parametreyi hem de Content-Type parametresini kullanırsanız, ContentType parametresinde belirtilen değer kullanılı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

-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 Bilgisi tek başına veya belirli Kimlik Doğrulaması parametre seçenekleriyle birlikte kullanabilirsiniz. Tek başına kullanıldığında, yalnızca uzak sunucu kimlik doğrulaması sınama isteği gönderdiğinde uzak sunucuya kimlik bilgileri sağlar. Kimlik Doğrulaması seçenekleriyle kullanıldığında, kimlik bilgileri açıkça gönderilir.

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

-CustomMethod

Web isteği için kullanılan özel yöntemi belirtir. Bu, uç nokta tarafından gereken İstek Yöntemi'nin Yöntemi'de mevcut bir seçenek olmaması durumunda kullanılabilir. Yöntemi ve CustomMethod birlikte kullanılamaz.

Örnek:

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

Bu, API'ye TEST bir HTTP isteği yapar.

Bu özellik PowerShell 6.0.0'a eklendi.

Parametre özellikleri

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

Parametre kümeleri

CustomMethod

Position:	Named
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

CustomMethodNoProxy

Position:	Named
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

-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

-FollowRelLink

Cmdlet'in ilişki bağlantılarını izlemesi gerektiğini gösterir.

Bazı REST API'leri, RFC5988başına İlişki Bağlantıları aracılığıyla sayfalandırmayı destekler. Sonraki sayfanın URL'sini almak için üst bilgiyi ayrıştırmak yerine, cmdlet'in bunu sizin için gerçekleştirmesini sağlayabilirsiniz. İlişki bağlantılarını kaç kez takip edeceğinizi ayarlamak için MaximumFollowRelLink parametresini kullanın.

Bu anahtarı kullanırken, cmdlet sonuç sayfalarından oluşan bir koleksiyon döndürür. Her sonuç sayfası birden çok sonuç öğesi içerebilir.

Bu özellik PowerShell 6.0.0'a eklendi.

Parametre özellikleri

Tür:	SwitchParameter
Default value:	False
Joker karakterleri destekler:	False
DontShow:	False
Diğer adlar:	FL

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

-Form

Sözlüğü multipart/form-data gönderimine dönüştürür. FormGövdeile kullanılamaz. ContentType göz ardı edilir.

Sözlüğün anahtarları, form alanı adları olarak kullanılır. Varsayılan olarak, form değerleri dize değerlerine dönüştürülür.

Değer bir System.IO.FileInfo nesnesiyse, ikili dosya içeriği gönderilir. Dosyanın adı filenameolarak gönderilir. MIME türü application/octet-streamolarak ayarlanır. Get-Item, System.IO.FileInfo nesnesini sağlamayı basitleştirmek için kullanılabilir.

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

Değer Dizi veya Liste gibi bir koleksiyon türüyse, form alanı birden çok kez gönderilir. Listenin değerleri varsayılan olarak dize olarak değerlendirilir. Değer bir System.IO.FileInfo nesnesiyse, ikili dosya içeriği gönderilir. İç içe koleksiyonlar desteklenmez.

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

Yukarıdaki örnekte, tags alanı formda üç kez ve her değer için bir kez sağlanır: Vacation, Italyve 2017. pictures alanı, 2017-Italy klasöründeki her dosya için bir kez gönderilir. Bu klasördeki dosyaların ikili içeriği değerler olarak gönderilir.

Bu özellik PowerShell 6.1.0'a eklendi.

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

-Headers

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

Content-Type nesnesi MultipartFormDataContentiçin sağlandığında, gibi içerikle ilgili başlıklar geçersiz kılınır.

PowerShell 7.4'te başlayarak, Content-Type üst bilgisini tanımlamak için bu parametreyi kullanır ve ContentType parametresini kullanırsanız, ContentType parametresinde belirtilen değer kullanılır.

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

-HttpVersion

İstek için kullanılan HTTP sürümünü belirtir. Varsayılan değer: 1.1.

Geçerli değerler şunlardır:

• 1.0
• 1.1
• 2.0
• 3.0

Parametre özellikleri

Tür:	Version
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

-MaximumFollowRelLink

FollowRelLink kullanıldığında ilişki bağlantılarının kaç kez izleyebileceğinizi belirtir. REST api çok fazla istek nedeniyle kısıtlanırsa daha küçük bir değer gerekebilir. Varsayılan değer şudur: [int32]::MaxValue. 0 (sıfır) değeri, aşağıdaki ilişki bağlantılarını engeller.

Parametre özellikleri

Tür:	Int32
Default value:	Int32.MaxValue
Joker karakterleri destekler:	False
DontShow:	False
Diğer adlar:	Makine Öğrenmesi (ML)

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

Bağlantı başarısız olmadan önce PowerShell'in bir bağlantıyı kaç kez alternatif bir Tekdüzen Kaynak Tanımlayıcısı'na (URI) yönlendirecek olduğunu belirtir. 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:	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

-MaximumRetryCount

400 ile 599 arasında (dahil veya 304) bir hata kodu alındığında PowerShell'in bağlantıyı kaç kez yeniden denemesi olduğunu belirtir. Ayrıca yeniden denemeler arasındaki aralığı belirtmek için RetryIntervalSec parametresine bakın.

Parametre özellikleri

Tür:	Int32
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

-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

CustomMethod parametresi, yukarıda listelenmeyen İstek Yöntemleri için kullanılabilir.

Parametre özellikleri

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

Parametre kümeleri

StandardMethod

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

StandardMethodNoProxy

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

-NoProxy

Cmdlet'in hedefe ulaşmak için ara sunucu kullanmayacağını gösterir. İnternet ayarlarınızda yapılandırılan veya ortamda belirtilen ara sunucuyu atlamak için bunu kullanın.

Bu parametre PowerShell 6.0'da kullanıma sunulmuştur.

Parametre özellikleri

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

Parametre kümeleri

StandardMethodNoProxy

Position:	Named
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

CustomMethodNoProxy

Position:	Named
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

-OperationTimeoutSeconds

Bu zaman aşımı, bir akış içindeki veri okuma işlemleri için geçerlidir, bir bütün olarak akış süresi için geçerli değildir. Varsayılan değer olan 0, süresiz bir zaman aşımı belirtir.

Değeri 30 saniye olarak ayarlamak, akıştaki veriler arasındaki 30 saniyeden uzun gecikmelerin isteği sonlandırdığını gösterir. İndirmesi birkaç dakika süren büyük bir dosya, akış 30 saniyeden uzun süre durmadığı sürece sonlandırılamaz.

Parametre özellikleri

Tür:	Int32
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

-OutFile

Varsayılan olarak, Invoke-RestMethod sonuçları işlem hattına döndürür. OutFile parametresini kullandığınızda, sonuçlar belirtilen dosyaya kaydedilir ve işlem hattına geri döndürülmez. Bir yol ve dosya adı girin. Sonuçları bir dosyaya ve işlem hattına göndermek için PassThru parametresini ekleyin.

Yolu atlarsanız, varsayılan ayar şu anki konumdur. Ad, kelimenin tam anlamıyla bir dizin olarak ele alınır. Köşeli ayraç ([]) içeren adlar tek tırnak içine alınmalıdır (').

PowerShell 7.4'den başlayarak, dosya adı olmadan bir klasör yolu belirtebilirsiniz. Bunu yaptığınızda, komut herhangi bir yeniden yönlendirmeden sonra çözümlenen URI'nin son kesiminden dosya adını kullanır. OutFileiçin bir klasör yolu belirttiğinizde, Resume parametresini kullanamazsınız.

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.

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

-PreserveAuthorizationOnRedirect

Bu cmdlet, mevcut olduğunda yeniden yönlendirmeler arasında Authorization üst bilgisini koruması gerektiğini belirtir.

Varsayılan olarak, cmdlet yeniden yönlendirmeden önce Authorization üst bilgisini kaldırır. Bu parametrenin belirtilmesi, üst bilginin yeniden yönlendirme konumuna gönderilmesi gereken durumlar için bu mantığı devre dışı bırakır.

Bu özellik PowerShell 6.0.0'a eklendi.

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

-PreserveHttpMethodOnRedirect

Cmdlet'in yeniden yönlendirmeler arasında isteğin yöntemini koruması gerektiğini gösterir.

Varsayılan olarak, cmdlet yeniden yönlendirildiğinde yöntemini GET olarak değiştirir. Bu parametrenin belirtilmesi, hedeflenen yöntemin yeniden yönlendirme ile kullanılabildiğinden emin olmak için bu mantığı devre dışı bırakır.

Bu özellik PowerShell 7.4'e eklendi.

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

-Proxy

doğrudan İnternet kaynağına bağlanmak yerine istek için bir ara sunucu kullanır. Bir ağ proxy sunucusunun Tekdüzen Kaynak Tanımlayıcısı'nı (URI) girin.

Bu özellik PowerShell 6.0.0'a eklendi.

Parametre özellikleri

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

Parametre kümeleri

StandardMethod

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

CustomMethod

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:	None
Joker karakterleri destekler:	False
DontShow:	False

Parametre kümeleri

StandardMethod

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

CustomMethod

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:	False
Joker karakterleri destekler:	False
DontShow:	False

Parametre kümeleri

StandardMethod

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

CustomMethod

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

-ResponseHeadersVariable

Yanıt Üst Bilgileri Sözlüğü içeren bir değişken oluşturur. Dolar işareti ($) simgesi olmadan bir değişken adı girin. Sözlüğün anahtarları, web sunucusu tarafından döndürülen Yanıt Üst Bilgisinin alan adlarını ve değerlerini içerir.

Bu özellik PowerShell 6.0.0'a eklendi.

Parametre özellikleri

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

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

-Resume

Kısmi bir dosyayı indirmeye devam etmek için en iyi çabayı gösterir. Resume parametresi OutFile parametresini gerektirir.

Özgeçmiş yalnızca yerel dosya ve uzak dosyanın boyutu üzerinde çalışır ve yerel dosya ile uzak dosyanın aynı olduğu konusunda başka bir doğrulama gerçekleştirmez.

Yerel dosya boyutu uzak dosya boyutundan küçükse, cmdlet dosyayı indirmeye devam etmeye çalışır ve kalan baytları dosyanın sonuna ekler.

Yerel dosya boyutu uzak dosya boyutuyla aynıysa hiçbir işlem yapılmaz ve cmdlet indirme işleminin zaten tamamlandığını varsayar.

Yerel dosya boyutu uzak dosya boyutundan büyükse, yerel dosyanın üzerine yazılır ve uzak dosyanın tamamı yeniden indirilir. Bu davranış, Özgeçmişolmadan OutFile kullanmakla aynıdır.

Uzak sunucu indirmeye kaldığı yerden devam etmeyi desteklemiyorsa, yerel dosya değiştirilir ve uzak dosyanın tamamı yeniden indirilir. Bu davranış, Özgeçmişolmadan OutFile kullanmakla aynıdır.

Yerel dosya yoksa, yerel dosya oluşturulur ve uzak dosyanın tamamı indirilir. Bu davranış, Özgeçmişolmadan OutFile kullanmakla aynıdır.

Bu özellik PowerShell 6.1.0'a eklendi.

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

-RetryIntervalSec

400 ile 599 (dahil) veya 304 arasında bir hata kodu alındığında bağlantı için yeniden denemeler arasındaki aralığı belirtir. Değerin 1 ile [int]::MaxValuearasında olması gerekir. Hata kodu 429 olduğunda ve yanıt üst bilgilerinde Retry-After özelliğini içeriyorsa, cmdlet bu parametre belirtilmiş olsa bile yeniden deneme aralığı için bu değeri kullanır.

Ayrıca, yeniden deneme sayısını belirtmek için MaximumRetryCount parametresine bakın.

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

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

PowerShell 7.4'e geçmeden önce 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.

PowerShell 7.4'te başlayarak, sonraki istekte oturumun özellikleri geçersiz kılınmadıkça web isteği oturumu kalıcı olur. Olduklarında, cmdlet oturumu yeni değerlerle yeniden oluşturur. Kalıcı oturumlar, yinelenen isteklerin yükünü azaltarak çok daha hızlı olmalarını sağlar.

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

-SkipCertificateCheck

Süre sonu, iptal, güvenilen kök yetkili vb. gibi tüm doğrulamaları içeren sertifika doğrulama denetimlerini atlar.

Uyarı

Bu parametrenin kullanılması güvenli değildir ve önerilmez. Bu anahtar yalnızca test amacıyla otomatik olarak imzalanan bir sertifika kullanan bilinen konaklara karşı kullanılmak üzere tasarlanmıştır. Kendi riskinizle kullanın.

Bu özellik PowerShell 6.0.0'a eklendi.

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

-SkipHeaderValidation

Cmdlet'in doğrulama olmadan isteğe üst bilgi eklemesi gerektiğini gösterir.

Bu düğme, standartlara uygun olmayan üst bilgi değerleri gerektiren siteler için kullanılmalıdır. Bu anahtarın belirtilmesi, değerin işaretsiz geçirilmesine izin vermek için doğrulamayı devre dışı bırakır. Belirtildiğinde, tüm üst bilgiler doğrulama olmadan eklenir.

Bu anahtar, ContentType, Headersve UserAgent parametrelerine geçirilen değerler için doğrulamayı devre dışı bırakır.

Bu özellik PowerShell 6.0.0'a eklendi.

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

-SkipHttpErrorCheck

Bu parametre, cmdlet'in HTTP hata durumlarını yoksayıp yanıtları işlemeye devam etmesine neden olur. Hata yanıtları, tıpkı başarılı olmuş gibi işlem hattına yazılır.

Bu parametre PowerShell 7'de kullanıma sunulmuştur.

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

-SslProtocol

Web isteği için izin verilen SSL/TLS protokollerini ayarlar. Varsayılan olarak, sistem tarafından desteklenen SSL/TLS protokollerinin tümüne izin verilir. SslProtocol, uyumluluk amacıyla belirli protokollerle sınırlanabilir.

Bu değerler, bayrak tabanlı bir numaralandırma olarak tanımlanır. Bu parametreyi kullanarak birden çok bayrak ayarlamak için birden çok değeri birlikte birleştirebilirsiniz. Değerler, SslProtocol parametresine bir değer dizisi olarak veya bu değerlerin virgülle ayrılmış dizesi olarak geçirilebilir. Cmdlet, değerleri ikili VEYA işlemi kullanarak birleştirir. Değerleri dizi olarak geçirmek en basit seçenektir ve değerler üzerinde sekme tamamlama özelliğini kullanmanıza da olanak tanır. Tüm platformlarda birden çok değer sağlayamayabilirsiniz.

Bu özellik PowerShell 6.0.0'a eklendi. PowerShell 7.1'de Tls13 desteği eklendi.

Parametre özellikleri

Tür:	WebSslProtocol
Default value:	None
Kabul edilen değerler:	Default, Tls, Tls11, Tls12, Tls13
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

-StatusCodeVariable

İsteğin HTTP durum kodu sonucunu içeren bir değişken oluşturur. Dolar işareti ($) simgesi olmadan bir değişken adı girin.

parametresi, SkipHttpErrorCheck parametresiyle kullanıldığında başarı iletilerini veya hata iletilerini tanımlayabilir.

parametresinin değişken adını -StatusCodeVariable "scv"gibi bir dize olarak girin.

Bu parametre PowerShell 7'de kullanıma sunulmuştur.

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

-Token

İstekte dahil etmek için OAuth veya Bearer belirteci. Belirteci, belirli Kimlik Doğrulaması seçenekleri için gereklidir. Bağımsız olarak kullanılamaz.

Belirteci, belirteci içeren bir SecureString alır. Belirteci sağlamak için aşağıdakileri manuel olarak kullanın:

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

Bu parametre PowerShell 6.0'da kullanıma sunulmuştur.

Parametre özellikleri

Tür:	SecureString
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

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

• Parçalanmış
• Sıkıştırmak
• Söndürmek
• GZip
• Kimlik

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

-UnixSocket

Bağlanacak Unix yuvasının adını belirtir. Bu parametre Unix tabanlı sistemlerde ve Windows sürüm 1803 ve sonraki sürümlerde desteklenir. Unix yuvalarının Windows desteği hakkında daha fazla bilgi için AF_UNIX ile Windows/WSL Birlikte Çalışma blog gönderisine bakın.

Bu parametre PowerShell 7.4'e eklendi.

Parametre özellikleri

Tür:	UnixDomainSocketEndPoint
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

-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

Bu parametre kullanım dışı bırakıldı. PowerShell 6.0.0 sürümünden başlayarak, tüm Web istekleri yalnızca temel ayrıştırma kullanır. Bu parametre yalnızca geriye dönük uyumluluk için eklenmiştir. Kullanıldığında, cmdlet'in çalışmasını hiçbir şekilde etkilemez.

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

-UseDefaultCredentials

Cmdlet'in geçerli kullanıcının kimlik bilgilerini kullanarak web isteğini gönderdiğini gösterir. Bu, Kimlik Doğrulaması veya Kimlik Bilgisi ile kullanılamaz ve tüm platformlarda desteklenmeyebilir.

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

-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. Content-Typegibi içerikle ilgili üst bilgiler, Bodyiçin MultipartFormDataContent nesnesi geldiğinde geçersiz kılınır.

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

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

• Tüm platformlar:
  • irm

Bazı özellikler tüm platformlarda kullanılamayabilir.

.NET Core 3.1'deki değişiklikler nedeniyle PowerShell 7.0 ve üzeri, proxy yapılandırmasını belirlemek için httpclient.defaultproxy özelliğini kullanır.

Bu özelliğin değeri platformunuza bağlı olarak farklılık gösterir:

• Windowsiçin: Ortam değişkenlerinden veya bunlar tanımlanmamışsa kullanıcının proxy ayarlarından ara sunucu yapılandırmasını okur.
• macOSiçin: Ortam değişkenlerinden veya tanımlanmamışsa sistemin proxy ayarlarından ara sunucu yapılandırmasını okur.
• Linuxiçin: Ortam değişkenlerinden ara sunucu yapılandırmasını okur veya bunların tanımlanmaması durumunda, bu özellik tüm adresleri atlayan yapılandırılmamış bir örneği başlatır.

Windows ve Unix tabanlı platformlarda DefaultProxy başlatma için kullanılan ortam değişkenleri şunlardır:

• HTTP_PROXY: HTTP isteklerinde kullanılan ara sunucunun ana bilgisayar adı veya IP adresi.
• HTTPS_PROXY: HTTPS isteklerinde kullanılan ara sunucunun ana bilgisayar adı veya IP adresi.
• ALL_PROXY: HTTP_PROXY veya HTTPS_PROXY tanımlanmadığı durumlarda HTTP ve HTTPS isteklerinde kullanılan ara sunucunun ana bilgisayar adı veya IP adresi.
• NO_PROXY: Proxy dışı tutulması gereken ana bilgisayar adlarının virgülle ayrılmış listesi.

PowerShell 7.4, Brotli sıkıştırma algoritması için destek ekledi.

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