Invoke-WebRequest
Mendapatkan konten dari halaman web di internet.
Sintaks
StandardMethod (Default)
Invoke-WebRequest
[-Uri] <Uri>
[-UseBasicParsing]
[-HttpVersion <Version>]
[-WebSession <WebRequestSession>]
[-SessionVariable <String>]
[-AllowUnencryptedAuthentication]
[-Authentication <WebAuthenticationType>]
[-Credential <PSCredential>]
[-UseDefaultCredentials]
[-CertificateThumbprint <String>]
[-Certificate <X509Certificate>]
[-SkipCertificateCheck]
[-SslProtocol <WebSslProtocol>]
[-Token <SecureString>]
[-UserAgent <String>]
[-DisableKeepAlive]
[-ConnectionTimeoutSeconds <Int32>]
[-OperationTimeoutSeconds <Int32>]
[-Headers <IDictionary>]
[-SkipHeaderValidation]
[-AllowInsecureRedirect]
[-MaximumRedirection <Int32>]
[-MaximumRetryCount <Int32>]
[-PreserveAuthorizationOnRedirect]
[-RetryIntervalSec <Int32>]
[-Method <WebRequestMethod>]
[-PreserveHttpMethodOnRedirect]
[-UnixSocket <UnixDomainSocketEndPoint>]
[-Proxy <Uri>]
[-ProxyCredential <PSCredential>]
[-ProxyUseDefaultCredentials]
[-Body <Object>]
[-Form <IDictionary>]
[-ContentType <String>]
[-TransferEncoding <String>]
[-InFile <String>]
[-OutFile <String>]
[-PassThru]
[-Resume]
[-SkipHttpErrorCheck]
[<CommonParameters>]
StandardMethodNoProxy
Invoke-WebRequest
[-Uri] <Uri>
[-UseBasicParsing]
[-HttpVersion <Version>]
[-WebSession <WebRequestSession>]
[-SessionVariable <String>]
[-AllowUnencryptedAuthentication]
[-Authentication <WebAuthenticationType>]
[-Credential <PSCredential>]
[-UseDefaultCredentials]
[-CertificateThumbprint <String>]
[-Certificate <X509Certificate>]
[-SkipCertificateCheck]
[-SslProtocol <WebSslProtocol>]
[-Token <SecureString>]
[-UserAgent <String>]
[-DisableKeepAlive]
[-ConnectionTimeoutSeconds <Int32>]
[-OperationTimeoutSeconds <Int32>]
[-Headers <IDictionary>]
[-SkipHeaderValidation]
[-AllowInsecureRedirect]
[-MaximumRedirection <Int32>]
[-MaximumRetryCount <Int32>]
[-PreserveAuthorizationOnRedirect]
[-RetryIntervalSec <Int32>]
[-Method <WebRequestMethod>]
[-PreserveHttpMethodOnRedirect]
[-UnixSocket <UnixDomainSocketEndPoint>]
[-NoProxy]
[-Body <Object>]
[-Form <IDictionary>]
[-ContentType <String>]
[-TransferEncoding <String>]
[-InFile <String>]
[-OutFile <String>]
[-PassThru]
[-Resume]
[-SkipHttpErrorCheck]
[<CommonParameters>]
CustomMethod
Invoke-WebRequest
[-Uri] <Uri>
-CustomMethod <String>
[-UseBasicParsing]
[-HttpVersion <Version>]
[-WebSession <WebRequestSession>]
[-SessionVariable <String>]
[-AllowUnencryptedAuthentication]
[-Authentication <WebAuthenticationType>]
[-Credential <PSCredential>]
[-UseDefaultCredentials]
[-CertificateThumbprint <String>]
[-Certificate <X509Certificate>]
[-SkipCertificateCheck]
[-SslProtocol <WebSslProtocol>]
[-Token <SecureString>]
[-UserAgent <String>]
[-DisableKeepAlive]
[-ConnectionTimeoutSeconds <Int32>]
[-OperationTimeoutSeconds <Int32>]
[-Headers <IDictionary>]
[-SkipHeaderValidation]
[-AllowInsecureRedirect]
[-MaximumRedirection <Int32>]
[-MaximumRetryCount <Int32>]
[-PreserveAuthorizationOnRedirect]
[-RetryIntervalSec <Int32>]
[-PreserveHttpMethodOnRedirect]
[-UnixSocket <UnixDomainSocketEndPoint>]
[-Proxy <Uri>]
[-ProxyCredential <PSCredential>]
[-ProxyUseDefaultCredentials]
[-Body <Object>]
[-Form <IDictionary>]
[-ContentType <String>]
[-TransferEncoding <String>]
[-InFile <String>]
[-OutFile <String>]
[-PassThru]
[-Resume]
[-SkipHttpErrorCheck]
[<CommonParameters>]
CustomMethodNoProxy
Invoke-WebRequest
[-Uri] <Uri>
-CustomMethod <String>
[-UseBasicParsing]
[-HttpVersion <Version>]
[-WebSession <WebRequestSession>]
[-SessionVariable <String>]
[-AllowUnencryptedAuthentication]
[-Authentication <WebAuthenticationType>]
[-Credential <PSCredential>]
[-UseDefaultCredentials]
[-CertificateThumbprint <String>]
[-Certificate <X509Certificate>]
[-SkipCertificateCheck]
[-SslProtocol <WebSslProtocol>]
[-Token <SecureString>]
[-UserAgent <String>]
[-DisableKeepAlive]
[-ConnectionTimeoutSeconds <Int32>]
[-OperationTimeoutSeconds <Int32>]
[-Headers <IDictionary>]
[-SkipHeaderValidation]
[-AllowInsecureRedirect]
[-MaximumRedirection <Int32>]
[-MaximumRetryCount <Int32>]
[-PreserveAuthorizationOnRedirect]
[-RetryIntervalSec <Int32>]
[-PreserveHttpMethodOnRedirect]
[-UnixSocket <UnixDomainSocketEndPoint>]
[-NoProxy]
[-Body <Object>]
[-Form <IDictionary>]
[-ContentType <String>]
[-TransferEncoding <String>]
[-InFile <String>]
[-OutFile <String>]
[-PassThru]
[-Resume]
[-SkipHttpErrorCheck]
[<CommonParameters>]
Deskripsi
Invoke-WebRequest Cmdlet mengirimkan permintaan HTTP dan HTTPS ke halaman web atau layanan web. Ini mengurai respons dan mengembalikan kumpulan tautan, gambar, dan elemen HTML signifikan lainnya.
Cmdlet ini diperkenalkan di PowerShell 3.0.
Dimulai di PowerShell 7.0, Invoke-WebRequest mendukung konfigurasi proksi yang ditentukan oleh variabel lingkungan. Lihat bagian Catatan di artikel ini.
Penting
Contoh dalam artikel ini mereferensikan host di contoso.com domain. Ini adalah domain fiktif yang digunakan oleh Microsoft misalnya. Contoh dirancang untuk menunjukkan cara menggunakan cmdlet.
Namun, karena contoso.com situs tidak ada, contohnya tidak berfungsi. Sesuaikan contoh ke host di lingkungan Anda.
Mulai dari PowerShell 7.4, pengodean karakter untuk permintaan defaultnya adalah UTF-8 alih-alih ASCII. Jika Anda memerlukan pengodean yang berbeda, Anda harus mengatur atribut charset di header Content-Type.
Contoh
Contoh 1: Mengirim permintaan web
Contoh ini menggunakan Invoke-WebRequest cmdlet untuk mengirim permintaan web ke situs Bing.com.
$Response = Invoke-WebRequest -Uri https://www.bing.com/search?q=how+many+feet+in+a+mile
$Response.InputFields | Where-Object {
$_.Name -like "* Value*"
} | Select-Object Name, Value
Name Value
---- -----
From Value 1
To Value 5280
Perintah pertama mengeluarkan permintaan dan menyimpan respons dalam variabel $Response.
Perintah kedua mendapatkan InputField di Hasil yang difilter disalurkan ke untuk Select-Object memilih properti Nama dan Nilai .
Contoh 2: Menggunakan layanan web stateful
Contoh ini menunjukkan cara menggunakan Invoke-WebRequest cmdlet dengan layanan web stateful.
$LoginParameters = @{
Uri = 'https://www.contoso.com/login/'
SessionVariable = 'Session'
Method = 'POST'
Body = @{
User = 'jdoe'
Password = 'P@S$w0rd!'
}
}
$LoginResponse = Invoke-WebRequest @LoginParameters
$ProfileResponse = Invoke-WebRequest 'https://www.contoso.com/profile/' -WebSession $Session
Panggilan pertama untuk Invoke-WebRequest mengirim permintaan masuk. Perintah menentukan nilai Session untuk nilai parameter SessionVariable . Ketika perintah selesai, $LoginResponse variabel berisi BasicHtmlWebResponseObject dan $Session variabel berisi WebRequestSession objek. Ini mencatat pengguna ke situs.
Panggilan kedua untuk Invoke-WebRequest mengambil profil pengguna, yang mengharuskan pengguna masuk ke situs. Data sesi yang $Session disimpan dalam variabel menyediakan cookie sesi ke situs yang dibuat selama login.
Contoh 3: Mendapatkan tautan dari halaman web
Contoh ini mendapatkan tautan di halaman web. Ini menggunakan Invoke-WebRequest cmdlet untuk mendapatkan konten halaman web. Kemudian menggunakan properti Tautan dari BasicHtmlWebResponseObject yang Invoke-WebRequest mengembalikan, dan properti Href dari setiap tautan.
(Invoke-WebRequest -Uri "https://aka.ms/pscore6-docs").Links.Href
Contoh 4: Menulis konten respons ke file menggunakan pengodean yang ditentukan di halaman yang diminta
Contoh ini menggunakan Invoke-WebRequest cmdlet untuk mengambil konten halaman web halaman dokumentasi PowerShell.
$Response = Invoke-WebRequest -Uri "https://aka.ms/pscore6-docs"
$Stream = [System.IO.StreamWriter]::new('.\docspage.html', $false, $Response.Encoding)
try {
$Stream.Write($Response.Content)
} finally {
$Stream.Dispose()
}
Perintah pertama mengambil halaman dan menyimpan objek respons dalam $Response variabel.
Perintah kedua membuat StreamWriter untuk digunakan untuk menulis konten respons ke file. Properti Pengodean objek respons digunakan untuk mengatur pengodean untuk file.
Beberapa perintah terakhir menulis properti Konten ke file lalu membuang StreamWriter.
Perhatikan bahwa properti Pengodean null jika permintaan web tidak mengembalikan konten teks.
Contoh 5: Mengirimkan file multipart/form-data
Contoh ini menggunakan Invoke-WebRequest cmdlet mengunggah file sebagai multipart/form-data pengiriman. File C:\document.txt dikirimkan sebagai bidang document formulir dengan Content-Type dari text/plain.
$FilePath = 'C:\document.txt'
$FieldName = 'document'
$ContentType = 'text/plain'
$FileStream = [System.IO.FileStream]::new($filePath, [System.IO.FileMode]::Open)
$FileHeader = [System.Net.Http.Headers.ContentDispositionHeaderValue]::new('form-data')
$FileHeader.Name = $FieldName
$FileHeader.FileName = Split-Path -Leaf $FilePath
$FileContent = [System.Net.Http.StreamContent]::new($FileStream)
$FileContent.Headers.ContentDisposition = $FileHeader
$FileContent.Headers.ContentType = [System.Net.Http.Headers.MediaTypeHeaderValue]::Parse($ContentType)
$MultipartContent = [System.Net.Http.MultipartFormDataContent]::new()
$MultipartContent.Add($FileContent)
$Response = Invoke-WebRequest -Body $MultipartContent -Method 'POST' -Uri 'https://api.contoso.com/upload'
Contoh 6: Pengiriman Multipihak/Formulir-Data yang Disederhanakan
Beberapa API memerlukan pengiriman multipart/form-data untuk mengunggah file dan konten campuran. Contoh ini menunjukkan pembaruan profil pengguna.
$Uri = 'https://api.contoso.com/v2/profile'
$Form = @{
firstName = 'John'
lastName = 'Doe'
email = 'john.doe@contoso.com'
avatar = Get-Item -Path 'C:\Pictures\jdoe.png'
birthday = '1980-10-15'
hobbies = 'Hiking','Fishing','Jogging'
}
$Result = Invoke-WebRequest -Uri $Uri -Method Post -Form $Form
Formulir profil memerlukan bidang-bidang ini: firstName, lastName, email, avatar, birthday, dan hobbies. API mengharapkan gambar untuk foto profil pengguna disediakan di kolom avatar. API juga menerima beberapa entri hobbies untuk dikirimkan dalam formulir yang sama.
Saat membuat $Form HashTable, nama kunci digunakan sebagai nama bidang formulir. Secara default, nilai HashTable dikonversi menjadi string. Jika ada nilai System.IO.FileInfo , konten file akan dikirimkan. Jika koleksi seperti array atau daftar ada, bidang formulir dikirimkan beberapa kali.
Menggunakan Get-Item pada kunci avatar , FileInfo objek diatur sebagai nilai . Hasilnya adalah bahwa data gambar untuk jdoe.png dikirimkan.
Dengan menyediakan daftar ke kunci hobbies, bidang hobbies akan muncul dalam setiap pengiriman untuk tiap item dalam daftar.
Contoh 7: Menangkap pesan yang tidak berhasil dari Invoke-WebRequest
Ketika Invoke-WebRequest mengalami pesan HTTP yang tidak berhasil (404, 500, dll.), pesan HTTP tidak mengembalikan output dan memunculkan kesalahan yang mengakhiri. Untuk menangkap kesalahan dan melihat StatusCode Anda dapat mengapit eksekusi di blok try/catch.
try
{
$Response = Invoke-WebRequest -Uri "www.microsoft.com/unkownhost"
# This will only execute if the Invoke-WebRequest is successful.
$StatusCode = $Response.StatusCode
} catch {
$StatusCode = $_.Exception.Response.StatusCode.value__
}
$StatusCode
404
Kesalahan penghentian ditangkap oleh catch blok , yang mengambil StatusCode dari objek Pengecualian .
Contoh 8: Mengunduh beberapa file secara bersamaan
Invoke-WebRequest Cmdlet hanya dapat mengunduh satu file pada satu waktu. Contoh berikut menggunakan Start-ThreadJob untuk membuat beberapa pekerjaan utas untuk mengunduh beberapa file secara bersamaan.
$baseUri = 'https://github.com/PowerShell/PowerShell/releases/download'
$files = @(
@{
Uri = "$baseUri/v7.3.0-preview.5/PowerShell-7.3.0-preview.5-win-x64.msi"
OutFile = 'PowerShell-7.3.0-preview.5-win-x64.msi'
},
@{
Uri = "$baseUri/v7.3.0-preview.5/PowerShell-7.3.0-preview.5-win-x64.zip"
OutFile = 'PowerShell-7.3.0-preview.5-win-x64.zip'
},
@{
Uri = "$baseUri/v7.2.5/PowerShell-7.2.5-win-x64.msi"
OutFile = 'PowerShell-7.2.5-win-x64.msi'
},
@{
Uri = "$baseUri/v7.2.5/PowerShell-7.2.5-win-x64.zip"
OutFile = 'PowerShell-7.2.5-win-x64.zip'
}
)
$jobs = @()
foreach ($file in $files) {
$jobs += Start-ThreadJob -Name $file.OutFile -ScriptBlock {
$params = $Using:file
Invoke-WebRequest @params
}
}
Write-Host "Downloads started..."
Wait-Job -Job $jobs
foreach ($job in $jobs) {
Receive-Job -Job $job
}
Contoh 9: Melewati Validasi Header
Secara default, cmdlet Invoke-WebRequest memvalidasi nilai header terkenal yang memiliki format nilai yang ditentukan standar. Contoh berikut menunjukkan bagaimana validasi ini dapat menimbulkan kesalahan dan bagaimana Anda dapat menggunakan parameter SkipHeaderValidation untuk menghindari validasi nilai untuk titik akhir yang mentolerir nilai yang diformat secara tidak valid.
$Uri = 'https://httpbin.org/headers'
$InvalidHeaders = @{
'If-Match' = '12345'
}
Invoke-WebRequest -Uri $Uri -Headers $InvalidHeaders
Invoke-WebRequest -Uri $Uri -Headers $InvalidHeaders -SkipHeaderValidation
Invoke-WebRequest: The format of value '12345' is invalid.
StatusCode : 200
StatusDescription : OK
Content : {
"headers": {
"Host": "httpbin.org",
"If-Match": "12345",
"User-Agent": "Mozilla/5.0 (Windows NT 10.0; Microsoft Windows 10.0.19044; en-US) PowerShell/7.2.5",
"X-Amzn-Trace-Id": �
RawContent : HTTP/1.1 200 OK
Date: Mon, 08 Aug 2022 16:24:24 GMT
Connection: keep-alive
Server: gunicorn/19.9.0
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application�
Headers : {[Date, System.String[]], [Connection, System.String[]], [Server, System.String[]], [Access-Control-Allow-Origin, System.String[]]�}
Images : {}
InputFields : {}
Links : {}
RawContentLength : 249
RelationLink : {}
httpbin.org adalah layanan yang mengembalikan informasi tentang permintaan web dan respons untuk pemecahan masalah. Variabel $Uri ditetapkan ke titik akhir /headers layanan, yang mengembalikan header permintaan sebagai konten dalam responsnya.
Header permintaan If-Match didefinisikan dalam RFC-7232 bagian 3.1 dan memerlukan nilai header tersebut didefinisikan dengan tanda kutip di sekitarnya. Variabel $InvalidHeaders diberi tabel hash di mana nilai If-Match tidak valid karena didefinisikan sebagai 12345 alih-alih "12345".
Memanggil Invoke-WebRequest dengan header yang tidak valid mengembalikan pelaporan kesalahan bahwa nilai yang diformat tidak valid. Permintaan tidak dikirim ke titik akhir.
Memanggil Invoke-WebRequest dengan parameter SkipHeaderValidation melewatkan kegagalan validasi dan mengirim permintaan ke server tujuan. Karena titik akhir mentolerir nilai header yang tidak sesuai, cmdlet mengembalikan objek respons tanpa kesalahan.
Contoh 10: Mengirim permintaan menggunakan HTTP 2.0
Contoh ini mendapatkan tautan di halaman web menggunakan protokol HTTP 2.0. Ini menggunakan Invoke-WebRequest cmdlet untuk mendapatkan konten halaman web. Kemudian menggunakan properti Tautan dari BasicHtmlWebResponseObject yang Invoke-WebRequest mengembalikan, dan properti Href dari setiap tautan.
(Invoke-WebRequest -Uri 'https://aka.ms/pscore6-docs' -HttpVersion 2.0).Links.Href
Contoh 11: Mengirim permintaan ke aplikasi soket Unix
Beberapa aplikasi, seperti Docker, mengekspos soket Unix untuk komunikasi. Contoh ini mengkueri daftar gambar Docker menggunakan Docker API. Cmdlet terhubung ke daemon Docker menggunakan soket Unix.
Invoke-WebRequest -Uri "http://localhost/v1.40/images/json/" -UnixSocket "/var/run/docker.sock"
Parameter
-AllowInsecureRedirect
Memungkinkan pengalihan dari HTTPS ke HTTP. Secara default, permintaan apa pun yang dialihkan dari HTTPS ke HTTP menghasilkan kesalahan dan permintaan dibatalkan untuk mencegah komunikasi secara tidak sengaja dalam teks biasa melalui koneksi yang tidak terenkripsi. Untuk mengambil alih perilaku ini dengan risiko Anda sendiri, gunakan parameter AllowInsecureRedirect.
Parameter ini ditambahkan di PowerShell 7.4.
Properti parameter
| Jenis: | SwitchParameter |
| Nilai default: | False |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-AllowUnencryptedAuthentication
Memungkinkan pengiriman kredensial dan rahasia melalui koneksi yang tidak terenkripsi. Secara default, menyediakan Kredensial atau opsi Autentikasi apa pun dengan Uri yang tidak dimulai dengan https:// menghasilkan kesalahan dan permintaan dibatalkan untuk mencegah rahasia yang tidak sengaja berkomunikasi dalam teks biasa melalui koneksi yang tidak terenkripsi. Untuk mengambil alih perilaku ini dengan risiko Anda sendiri, berikan parameter AllowUnencryptedAuthentication.
Peringatan
Menggunakan parameter ini tidak aman dan tidak disarankan. Ini disediakan hanya untuk kompatibilitas dengan sistem warisan yang tidak dapat menyediakan koneksi terenkripsi. Gunakan dengan risiko Anda sendiri.
Fitur ini ditambahkan di PowerShell 6.0.0.
Properti parameter
| Jenis: | SwitchParameter |
| Nilai default: | False |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-Authentication
Menentukan jenis autentikasi eksplisit yang akan digunakan untuk permintaan. Default Tidak Ada. Parameter Autentikasi tidak dapat digunakan dengan parameter UseDefaultCredentials.
Opsi Autentikasi yang Tersedia:
-
None: Ini adalah opsi default saat Autentikasi tidak disediakan. Tidak ada autentikasi eksplisit yang digunakan. -
Basic: Memerlukan Kredensial. Kredensial dikirim sebagai header AutentikasiAuthorization: BasicDasar RFC 7617 dalam formatbase64(user:password). -
Bearer: Memerlukan Token parameter. Mengirim header RFC 6750Authorization: Bearerdengan token yang disediakan. -
OAuth: Memerlukan Token parameter. Mengirim header RFC 6750Authorization: Bearerdengan token yang disediakan.
Menyediakan Autentikasi mengambil alih header Authorization yang disediakan untuk Header atau disertakan dalam WebSession.
Fitur ini ditambahkan di PowerShell 6.0.0.
Properti parameter
| Jenis: | WebAuthenticationType |
| Nilai default: | None |
| Nilai yang diterima: | None, Basic, Bearer, OAuth |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-Body
Menentukan isi permintaan. Isi adalah konten permintaan yang mengikuti header.
Anda juga dapat mengalirkan nilai isi ke Invoke-WebRequest.
Parameter Body dapat digunakan untuk menentukan daftar parameter kueri atau konten respons. Untuk parameter kueri, cmdlet menggunakan metode System.Net.WebUtility.UrlEncode untuk mengenkode pasangan kunci-nilai. Untuk informasi selengkapnya tentang pengodean string untuk URL, lihat referensi metode UrlEncode().
Ketika input adalah permintaan POST dan isinya adalah string , nilai di sebelah kiri tanda sama dengan pertama (=) diatur sebagai kunci dalam data formulir dan teks yang tersisa ditetapkan sebagai nilai. Untuk menentukan beberapa kunci, gunakan objek IDictionary, seperti hash table, untuk Badan.
Ketika input adalah permintaan GET dan isinya adalah IDictionary (biasanya, tabel hash), isi ditambahkan ke URI sebagai parameter kueri. Untuk jenis permintaan lain (seperti PATCH), isi diatur sebagai nilai isi permintaan dalam format name=value standar dengan nilai yang dikodekan URL.
Ketika input adalah objek System.Xml.XmlNode dan deklarasi XML menentukan pengodean, pengodean tersebut digunakan untuk data dalam permintaan kecuali ditimpa oleh parameter ContentType.
Parameter Isi juga menerima System.Net.Http.MultipartFormDataContent objek. Ini memfasilitasi multipart/form-data permintaan.
Ketika objek MultipartFormDataContent disediakan untuk Isi, header terkait Konten apa pun yang disediakan ke parameter ContentType, Header, atau WebSession ditimpa oleh header Konten objek MultipartFormDataContent. Fitur ini ditambahkan di PowerShell 6.0.0.
Properti parameter
| Jenis: | Object |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | True |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-Certificate
Menentukan sertifikat klien yang digunakan untuk permintaan web yang aman. Masukkan variabel yang berisi sertifikat atau perintah atau ekspresi yang mendapatkan sertifikat.
Untuk menemukan sertifikat, gunakan Get-PfxCertificate atau gunakan cmdlet Get-ChildItem di drive Sertifikat (Cert:). Jika sertifikat tidak valid atau tidak memiliki otoritas yang memadai, perintah gagal.
Properti parameter
| Jenis: | X509Certificate |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-CertificateThumbprint
Menentukan sertifikat kunci publik digital (X509) dari akun pengguna yang memiliki izin untuk mengirim permintaan. Masukkan sidik jari sertifikat.
Sertifikat digunakan dalam autentikasi berbasis sertifikat klien. Sertifikat hanya dapat dipetakan ke akun pengguna lokal, bukan akun domain.
Untuk melihat thumbprint sertifikat, gunakan perintah Get-Item atau Get-ChildItem untuk menemukan sertifikat di Cert:\CurrentUser\My.
Nota
Fitur ini hanya didukung pada platform OS Windows.
Properti parameter
| Jenis: | String |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-ConnectionTimeoutSeconds
Menentukan berapa lama permintaan dapat tertunda sebelum waktu habis. Masukkan nilai dalam detik. Nilai default, 0, menentukan waktu tunggu tidak terbatas.
Kueri Sistem Nama Domain (DNS) bisa memakan waktu hingga 15 detik untuk kembali atau kehabisan waktu. Jika permintaan Anda berisi nama host yang memerlukan resolusi, dan Anda mengatur ConnectionTimeoutSeconds ke nilai yang lebih besar dari nol, tetapi kurang dari 15 detik, dibutuhkan waktu 15 detik atau lebih sebelum WebException dibuang, dan waktu permintaan Anda habis.
Parameter ini menggantikan parameter TimeoutSec di PowerShell 7.4. Anda dapat menggunakan TimeoutSec sebagai alias untuk ConnectionTimeoutSeconds.
Properti parameter
| Jenis: | Int32 |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
| Alias: | TimeoutSec |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-ContentType
Menentukan tipe isi permintaan web.
Jika nilai untuk ContentType berisi format pengodean (sebagai charset), cmdlet menggunakan format tersebut untuk mengodekan isi permintaan web. Jika ContentType tidak menentukan format pengodean, format pengodean default akan digunakan sebagai gantinya. Contoh ContentType dengan format pengodean adalah text/plain; charset=iso-8859-5, yang menentukan alfabet Latin/Sirilik.
Jika Anda menghilangkan parameter, jenis konten mungkin berbeda berdasarkan metode HTTP yang Anda gunakan:
- Untuk metode POST, jenis konten
application/x-www-form-urlencoded - Untuk metode PUT, jenis konten
application/json - Untuk metode lain, jenis konten tidak ditentukan dalam permintaan
Jika Anda menggunakan parameter InFile untuk mengunggah file, Anda harus mengatur jenis konten.
Biasanya, jenisnya harus application/octet-stream. Namun, Anda perlu mengatur jenis konten berdasarkan persyaratan titik akhir.
ContentType ditimpa ketika Isi adalah objek MultipartFormDataContent.
Mulai dari PowerShell 7.4, jika Anda menggunakan parameter ini dan parameter Header untuk menentukan header Content-Type, nilai yang ditentukan dalam parameter ContentType digunakan.
Properti parameter
| Jenis: | String |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-Credential
Menentukan akun pengguna yang memiliki izin untuk mengirim permintaan. Defaultnya adalah pengguna saat ini.
Ketik nama pengguna, seperti User01 atau Domain01\User01, atau masukkan objek PSCredential yang dihasilkan oleh cmdlet Get-Credential.
Kredensial dapat digunakan sendiri atau bersama dengan opsi parameter Autentikasi tertentu. Ketika digunakan sendiri, fitur ini hanya menyediakan kredensial ke server jarak jauh jika server jarak jauh mengirimkan permintaan tantangan autentikasi. Saat digunakan dengan opsi Autentikasi , kredensial dikirim secara eksplisit.
Kredensial disimpan dalam objek PSCredential
Nota
Untuk informasi selengkapnya tentang perlindungan data SecureString, lihat Seberapa aman SecureString?.
Properti parameter
| Jenis: | PSCredential |
| Nilai default: | Current user |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-CustomMethod
Menentukan metode kustom yang digunakan untuk permintaan web. Ini dapat digunakan jika Metode Permintaan yang diperlukan oleh titik akhir bukan opsi yang tersedia pada Metode. Metode dan CustomMethod tidak dapat digunakan bersama-sama.
Contoh ini membuat TEST permintaan HTTP ke API:
Invoke-WebRequest -Uri 'https://api.contoso.com/widget/' -CustomMethod 'TEST'
Fitur ini ditambahkan di PowerShell 6.0.0.
Properti parameter
| Jenis: | String |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
| Alias: | cm |
Set parameter
CustomMethod
| Position: | Named |
| Wajib: | True |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
CustomMethodNoProxy
| Position: | Named |
| Wajib: | True |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-DisableKeepAlive
Menunjukkan bahwa cmdlet mengatur nilai KeepAlive di header HTTP ke False. Secara default,
Properti parameter
| Jenis: | SwitchParameter |
| Nilai default: | False |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-Form
Mengonversi kamus menjadi entri multipart/form-data.
Formulir mungkin tidak digunakan dengan Isi.
Jika ContentType digunakan, contentType akan diabaikan.
Kunci kamus digunakan sebagai nama bidang formulir. Secara default, nilai formulir dikonversi menjadi nilai string.
Jika nilainya adalah objek System.IO.FileInfo, maka konten file biner dikirimkan. Nama file dikirimkan sebagai properti nama file. Jenis MIME diatur sebagai application/octet-stream.
Get-Item dapat digunakan untuk menyederhanakan penyediaan objek System.IO.FileInfo.
$Form = @{
resume = Get-Item 'C:\Users\jdoe\Documents\John Doe.pdf'
}
Jika nilainya adalah jenis koleksi, array atau Daftar tersebut, bidang untuk dikirimkan beberapa kali. Nilai daftar diperlakukan sebagai string secara default. Jika nilainya adalah objek System.IO.FileInfo, maka konten file biner dikirimkan. Koleksi berlapis tidak didukung.
$Form = @{
tags = 'Vacation', 'Italy', '2017'
pictures = Get-ChildItem 'C:\Users\jdoe\Pictures\2017-Italy\'
}
Dalam contoh tags di atas bidang disediakan tiga kali dalam formulir, sekali untuk masing-masing Vacation, Italy, dan 2017. Bidang pictures juga dikirimkan sekali untuk setiap file di 2017-Italy folder. Konten biner file dalam folder tersebut dikirimkan sebagai nilai.
Fitur ini ditambahkan di PowerShell 6.1.0.
Properti parameter
| Jenis: | IDictionary |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-Headers
Menentukan header permintaan web. Inputkan tabel hash atau kamus.
Header terkait konten, seperti Content-Type ditimpa ketika objek MultipartFormDataContent disediakan untuk Isi.
Mulai dari PowerShell 7.4, jika Anda menggunakan parameter ini untuk menentukan header Content-Type dan menggunakan parameter ContentType, nilai yang ditentukan dalam parameter ContentType digunakan.
Properti parameter
| Jenis: | IDictionary |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-HttpVersion
Menentukan versi HTTP yang digunakan untuk permintaan. Defaultnya adalah 1.1.
Nilai yang valid adalah:
- 1.0
- 1.1
- 2.0
- 3.0
Properti parameter
| Jenis: | Version |
| Nilai default: | 1.1 |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-InFile
Mendapatkan konten isi permintaan web dari file. Masukkan jalur dan nama file. Jika Anda menghilangkan jalur, defaultnya adalah lokasi saat ini.
Anda juga perlu mengatur jenis konten permintaan. Misalnya, untuk mengunggah file, Anda harus mengatur jenis konten. Biasanya, jenisnya harus application/octet-stream. Namun, Anda perlu mengatur jenis konten berdasarkan persyaratan titik akhir.
Properti parameter
| Jenis: | String |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-MaximumRedirection
Menentukan berapa kali PowerShell mengalihkan koneksi ke Pengidentifikasi Sumber Daya Seragam (URI) alternatif sebelum koneksi gagal. Nilai defaultnya adalah 5. Nilai 0 (nol) mencegah semua pengalihan.
Properti parameter
| Jenis: | Int32 |
| Nilai default: | 5 |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-MaximumRetryCount
Menentukan berapa kali PowerShell mencoba kembali koneksi saat kode kegagalan antara 400 dan 599, inklusif atau 304 diterima. Lihat juga parameter RetryIntervalSec untuk menentukan interval antar percobaan ulang.
Properti parameter
| Jenis: | Int32 |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-Method
Menentukan metode yang digunakan untuk permintaan web. Nilai yang dapat diterima untuk parameter ini adalah:
DefaultDeleteGetHeadMergeOptionsPatchPostPutTrace
Parameter CustomMethod dapat digunakan untuk Metode Permintaan yang tidak tercantum di atas.
Properti parameter
| Jenis: | WebRequestMethod |
| Nilai default: | None |
| Nilai yang diterima: | Default, Get, Head, Post, Put, Delete, Trace, Options, Merge, Patch |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
StandardMethod
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
StandardMethodNoProxy
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-NoProxy
Menunjukkan bahwa cmdlet tidak boleh menggunakan proksi untuk mencapai tujuan. Saat Anda perlu melewati proksi yang dikonfigurasi di lingkungan, gunakan sakelar ini. Fitur ini ditambahkan di PowerShell 6.0.0.
Properti parameter
| Jenis: | SwitchParameter |
| Nilai default: | False |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
StandardMethodNoProxy
| Position: | Named |
| Wajib: | True |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
CustomMethodNoProxy
| Position: | Named |
| Wajib: | True |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-OperationTimeoutSeconds
Batas waktu ini berlaku untuk pembacaan data dalam aliran, bukan untuk waktu streaming secara keseluruhan. Nilai default, 0, menentukan batas waktu yang tidak ditentukan.
Mengatur nilai menjadi 30 detik berarti bahwa setiap penundaan lebih dari 30 detik antara data dalam aliran mengakhiri permintaan. File besar yang membutuhkan waktu beberapa menit untuk diunduh tidak akan dihentikan kecuali aliran terhenti selama lebih dari 30 detik.
Properti parameter
| Jenis: | Int32 |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-OutFile
Pada pengaturan awal, Invoke-WebRequest mengembalikan hasil ke jalur pemrosesan. Saat Anda menggunakan parameter OutFile, hasilnya disimpan ke file yang ditentukan dan tidak dikembalikan ke alur. Masukkan jalur dan nama file. Untuk mengirim hasil ke file dan ke alur, tambahkan parameter PassThru.
Jika Anda menghilangkan jalur, defaultnya adalah lokasi saat ini. Nama ini diperlakukan sebagai jalur harfiah.
Nama yang berisi tanda kurung ([]) harus diapit dalam tanda kutip tunggal (').
Mulai dari PowerShell 7.4, Anda dapat menentukan jalur folder tanpa nama file. Saat Anda melakukannya, perintah menggunakan nama file dari segmen terakhir URI yang diselesaikan setelah pengalihan apa pun. Saat Anda menentukan jalur folder untuk OutFile, Anda tidak dapat menggunakan parameter Resume.
Properti parameter
| Jenis: | String |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-PassThru
Menunjukkan bahwa cmdlet mengembalikan hasilnya, selain menulisnya ke file. Parameter ini hanya valid ketika parameter OutFile juga digunakan dalam perintah .
Properti parameter
| Jenis: | SwitchParameter |
| Nilai default: | False |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-PreserveAuthorizationOnRedirect
Menunjukkan bahwa cmdlet harus mempertahankan header Authorization, jika ada, di seluruh pengalihan.
Secara default, cmdlet menghapus header Authorization sebelum dialihkan. Menentukan parameter ini menonaktifkan logika ini untuk kasus di mana header perlu dikirim ke lokasi pengalihan.
Fitur ini ditambahkan di PowerShell 6.0.0.
Properti parameter
| Jenis: | SwitchParameter |
| Nilai default: | False |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-PreserveHttpMethodOnRedirect
Menunjukkan bahwa cmdlet harus mempertahankan metode permintaan di seluruh pengalihan.
Secara default, cmdlet mengubah metode menjadi GET saat dialihkan. Menentukan parameter ini menonaktifkan logika ini untuk memastikan bahwa metode yang dimaksudkan dapat digunakan dengan pengalihan.
Fitur ini ditambahkan di PowerShell 7.4.
Properti parameter
| Jenis: | SwitchParameter |
| Nilai default: | False |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-Proxy
Menentukan server proksi untuk permintaan, daripada menyambungkan langsung ke sumber daya internet. Masukkan URI server proksi jaringan.
Properti parameter
| Jenis: | Uri |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
StandardMethod
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
CustomMethod
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-ProxyCredential
Menentukan akun pengguna yang memiliki izin untuk menggunakan server proksi yang ditentukan oleh parameter Proksi . Defaultnya adalah pengguna saat ini.
Ketik nama pengguna, seperti User01 atau Domain01\User01, atau masukkan objek PSCredential, seperti yang dihasilkan oleh cmdlet Get-Credential.
Parameter ini hanya valid ketika parameter Proksi juga digunakan dalam perintah . Anda tidak dapat menggunakan parameter ProxyCredential dan ProxyUseDefaultCredentials dalam perintah yang sama.
Properti parameter
| Jenis: | PSCredential |
| Nilai default: | Current user |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
StandardMethod
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
CustomMethod
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-ProxyUseDefaultCredentials
Menunjukkan bahwa cmdlet menggunakan kredensial pengguna saat ini untuk mengakses server proksi yang ditentukan oleh parameter Proksi
Parameter ini hanya valid ketika parameter Proksi juga digunakan dalam perintah . Anda tidak dapat menggunakan parameter ProxyCredential dan ProxyUseDefaultCredentials dalam perintah yang sama.
Properti parameter
| Jenis: | SwitchParameter |
| Nilai default: | False |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
StandardMethod
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
CustomMethod
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-Resume
Melakukan upaya terbaik untuk melanjutkan pengunduhan file parsial. Resume memerlukan OutFile.
Lanjutkan hanya beroperasi pada ukuran file lokal dan file jarak jauh dan tidak melakukan validasi lain bahwa file lokal dan file jarak jauh sama.
Jika ukuran file lokal lebih kecil dari ukuran file jarak jauh, maka cmdlet mencoba melanjutkan pengunduhan file dan menambahkan byte yang tersisa ke akhir file.
Jika ukuran file lokal sama dengan ukuran file jarak jauh, maka tidak ada tindakan yang diambil dan cmdlet mengasumsikan unduhan sudah selesai.
Jika ukuran file lokal lebih besar dari ukuran file jarak jauh, maka file lokal di-overwrite dan seluruh file jarak jauh diunduh ulang. Perilaku ini sama dengan menggunakan OutFile tanpa Lanjutkan.
Jika server jarak jauh tidak mendukung melanjutkan unduhan, maka file lokal diganti dan seluruh file jarak jauh diunduh ulang. Perilaku ini sama dengan menggunakan OutFile tanpa Lanjutkan.
Jika file lokal tidak ada, maka file lokal dibuat dan seluruh file jarak jauh diunduh. Perilaku ini sama dengan menggunakan OutFile tanpa Lanjutkan.
Fitur ini ditambahkan di PowerShell 6.1.0.
Properti parameter
| Jenis: | SwitchParameter |
| Nilai default: | False |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-RetryIntervalSec
Menentukan interval antara percobaan ulang untuk koneksi ketika kode kegagalan antara 400 dan 599, inklusif atau 304 diterima.
Lihat juga parameter MaximumRetryCount untuk menentukan jumlah percobaan ulang. Nilai harus antara 1 dan [int]::MaxValue.
Ketika kode kegagalan adalah 429 dan respons menyertakan properti Coba Lagi-Setelah di headernya, cmdlet menggunakan nilai tersebut untuk interval coba lagi, bahkan jika parameter ini ditentukan.
Properti parameter
| Jenis: | Int32 |
| Nilai default: | 5 |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-SessionVariable
Menentukan variabel yang cmdlet ini membuat sesi permintaan web dan menyimpannya dalam nilai .
Masukkan nama variabel tanpa simbol tanda dolar ($).
Saat Anda menentukan variabel sesi, Invoke-WebRequest membuat objek sesi permintaan web dan menetapkannya ke variabel dengan nama yang ditentukan dalam sesi PowerShell Anda. Anda dapat menggunakan variabel dalam sesi Anda segera setelah perintah selesai.
Sebelum PowerShell 7.4, sesi permintaan web bukan koneksi persisten. Ini adalah objek yang berisi informasi tentang koneksi dan permintaan, termasuk cookie, kredensial, nilai pengalihan maksimum, dan string agen pengguna. Anda dapat menggunakannya untuk berbagi status dan data di antara permintaan web.
Dimulai pada PowerShell 7.4, sesi permintaan web bersifat persisten selama properti sesi tidak digantikan dalam permintaan berikutnya. Ketika sudah, cmdlet membuat ulang sesi dengan nilai baru. Session yang persisten mengurangi beban kerja untuk permintaan berulang, menjadikannya jauh lebih cepat.
Untuk menggunakan sesi permintaan web dalam permintaan web berikutnya, tentukan variabel sesi dalam nilai parameter WebSession. PowerShell menggunakan data dalam objek sesi permintaan web saat membuat koneksi baru. Untuk mengambil alih nilai dalam sesi permintaan web, gunakan parameter cmdlet, seperti UserAgent atau Credential. Nilai parameter lebih diutamakan daripada nilai dalam sesi permintaan web.
Anda tidak dapat menggunakan parameter SessionVariable dan WebSession dalam perintah yang sama.
Properti parameter
| Jenis: | String |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
| Alias: | SV |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-SkipCertificateCheck
Melewati pemeriksaan validasi sertifikat. Ini termasuk semua validasi seperti kedaluwarsa, pencabutan, otoritas akar tepercaya, dll.
Peringatan
Menggunakan parameter ini tidak aman dan tidak disarankan. Sakelar ini hanya dimaksudkan untuk digunakan terhadap host yang diketahui menggunakan sertifikat yang ditandatangani sendiri untuk tujuan pengujian. Gunakan dengan risiko Anda sendiri.
Fitur ini ditambahkan di PowerShell 6.0.0.
Properti parameter
| Jenis: | SwitchParameter |
| Nilai default: | False |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-SkipHeaderValidation
Menunjukkan cmdlet harus menambahkan header ke permintaan tanpa validasi.
Sakelar ini harus digunakan untuk situs yang memerlukan nilai header yang tidak mengikuti standar. Menentukan sakelar ini menonaktifkan validasi untuk memungkinkan nilai diteruskan tanpa pemeriksaan. Ketika ditentukan, semua header ditambahkan tanpa validasi.
Sakelar ini menonaktifkan validasi untuk nilai yang diteruskan ke parameter ContentType, Headers , dan UserAgent .
Fitur ini ditambahkan di PowerShell 6.0.0.
Properti parameter
| Jenis: | SwitchParameter |
| Nilai default: | False |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-SkipHttpErrorCheck
Parameter ini menyebabkan cmdlet mengabaikan status kesalahan HTTP dan terus memproses respons. Respons kesalahan ditulis ke alur seolah-olah berhasil.
Parameter ini diperkenalkan di PowerShell 7.
Properti parameter
| Jenis: | SwitchParameter |
| Nilai default: | False |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-SslProtocol
Mengatur protokol SSL/TLS yang diizinkan untuk permintaan web. Secara default semua, protokol SSL/TLS yang didukung oleh sistem diizinkan. SslProtocol memungkinkan pembatasan pada protokol tertentu untuk tujuan kepatuhan.
Nilai-nilai ini didefinisikan sebagai enumerasi berbasis bendera. Anda dapat menggabungkan beberapa nilai bersama-sama untuk mengatur beberapa bendera menggunakan parameter ini. Nilai dapat diteruskan ke parameter SslProtocol sebagai array nilai atau sebagai string yang dipisahkan koma dari nilai tersebut. Cmdlet menggabungkan nilai menggunakan operasi biner-OR. Meneruskan nilai sebagai array adalah opsi paling sederhana dan juga memungkinkan Anda menggunakan penyelesaian tab pada nilai. Anda mungkin tidak dapat menentukan beberapa opsi di semua platform.
Nota
Pada platform non-Windows mungkin tidak dimungkinkan untuk menyediakan Tls atau Tls12 sebagai opsi. Dukungan untuk Tls13 tidak tersedia di semua sistem operasi dan perlu diverifikasi berdasarkan sistem operasi.
Fitur ini ditambahkan di PowerShell 6.0.0 dan dukungan untuk Tls13 ditambahkan di PowerShell 7.1.
Properti parameter
| Jenis: | WebSslProtocol |
| Nilai default: | None |
| Nilai yang diterima: | Default, Tls, Tls11, Tls12 |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-Token
Token OAuth atau Bearer yang harus disertakan dalam permintaan. Token diperlukan oleh opsi Autentikasi tertentu. Ini tidak dapat digunakan secara independen.
Token mengambil yang SecureString berisi token. Untuk menyediakan token secara manual, gunakan yang berikut:
Invoke-WebRequest -Uri $uri -Authentication OAuth -Token (Read-Host -AsSecureString)
Parameter ini diperkenalkan di PowerShell 6.0.
Properti parameter
| Jenis: | SecureString |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-TransferEncoding
Menentukan nilai untuk header respons HTTP Transfer-Encoding. Nilai yang dapat diterima untuk parameter ini adalah:
ChunkedCompressDeflateGZipIdentity
Properti parameter
| Jenis: | String |
| Nilai default: | None |
| Nilai yang diterima: | chunked, compress, deflate, gzip, identity |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-UnixSocket
Menentukan nama soket Unix yang akan disambungkan. Parameter ini didukung pada sistem berbasis Unix dan Windows versi 1803 dan yang lebih baru. Untuk informasi selengkapnya tentang dukungan soket Unix di Windows, lihat posting blog Windows/WSL Interop dengan AF_UNIX.
Parameter ini ditambahkan di PowerShell 7.4.
Properti parameter
| Jenis: | UnixDomainSocketEndPoint |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-Uri
Menentukan Pengidentifikasi Sumber Daya Seragam (URI) sumber daya internet tempat permintaan web dikirim. Masukkan URI. Parameter ini hanya mendukung HTTP atau HTTPS.
Parameter ini diperlukan. Nama parameter Uri bersifat opsional.
Properti parameter
| Jenis: | Uri |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | 0 |
| Wajib: | True |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-UseBasicParsing
Parameter ini tidak digunakan lagi. Dimulai dengan PowerShell 6.0.0, semua permintaan Web hanya menggunakan penguraian dasar. Parameter ini disertakan hanya untuk kompatibilitas mundur dan penggunaan apa pun tidak berpengaruh pada pengoperasian cmdlet.
Properti parameter
| Jenis: | SwitchParameter |
| Nilai default: | False |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-UseDefaultCredentials
Menunjukkan bahwa cmdlet menggunakan kredensial pengguna saat ini untuk mengirim permintaan web. Ini tidak dapat digunakan dengan Autentikasi atau Kredensial dan mungkin tidak didukung di semua platform.
Properti parameter
| Jenis: | SwitchParameter |
| Nilai default: | False |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-UserAgent
Menentukan user agent string untuk permintaan web.
Agen pengguna default mirip dengan Mozilla/5.0 (Windows NT 10.0; Microsoft Windows 10.0.15063; en-US) PowerShell/6.0.0 dengan sedikit variasi untuk setiap sistem operasi dan platform.
Untuk menguji situs web dengan string agen pengguna standar yang digunakan oleh sebagian besar browser internet, gunakan properti kelas PSUserAgent, seperti Chrome, Firefox, InternetExplorer, Opera, dan Safari.
Misalnya, perintah berikut menggunakan string agen pengguna untuk Internet Explorer: Invoke-WebRequest -Uri https://website.com/ -UserAgent ([Microsoft.PowerShell.Commands.PSUserAgent]::InternetExplorer)
Properti parameter
| Jenis: | String |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-WebSession
Menentukan sesi permintaan web. Masukkan nama variabel, termasuk tanda dolar ($).
Untuk mengambil alih nilai dalam sesi permintaan web, gunakan parameter cmdlet, seperti UserAgent atau Credential. Nilai parameter lebih diutamakan daripada nilai dalam sesi permintaan web. Header terkait konten, seperti Content-Type, juga ditimpa ketika objek MultipartFormDataContent disediakan untuk Isi.
Tidak seperti sesi jarak jauh, sesi permintaan web bukan koneksi persisten. Ini adalah objek yang berisi informasi tentang koneksi dan permintaan, termasuk cookie, kredensial, nilai pengalihan maksimum, dan string agen pengguna. Anda dapat menggunakannya untuk berbagi status dan data di antara permintaan web.
Untuk membuat sesi permintaan web, masukkan nama variabel, tanpa tanda dolar, dalam nilai parameter SessionVariable dari perintah Invoke-WebRequest.
Invoke-WebRequest membuat sesi dan menyimpannya dalam variabel. Dalam perintah berikutnya, gunakan variabel sebagai nilai parameter WebSession.
Anda tidak dapat menggunakan parameter SessionVariable dan WebSession dalam perintah yang sama.
Properti parameter
| Jenis: | WebRequestSession |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
CommonParameters
Cmdlet ini mendukung parameter umum: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, dan -WarningVariable. Untuk informasi selengkapnya, lihat about_CommonParameters.
Input
Object
Anda dapat menyalurkan isi permintaan web ke cmdlet ini.
Output
BasicHtmlWebResponseObject
Cmdlet ini mengembalikan objek respons yang mewakili hasil permintaan web.
Catatan
PowerShell menyertakan alias berikut untuk Invoke-WebRequest:
- Semua platform:
iwr
Dimulai dengan PowerShell 6.0.0 Invoke-WebRequest hanya mendukung penguraian dasar.
Untuk informasi selengkapnya, lihat BasicHtmlWebResponseObject.
Karena perubahan pada .NET Core 3.1, PowerShell 7.0 dan yang lebih tinggi menggunakan properti HttpClient.DefaultProxy untuk menentukan konfigurasi proksi.
Nilai properti ini ditentukan oleh platform Anda:
- Untuk Windows: Membaca konfigurasi proksi dari variabel lingkungan. Jika variabel tersebut tidak ditentukan, properti berasal dari pengaturan proksi pengguna.
- Untuk macOS: Membaca konfigurasi proksi dari variabel lingkungan. Jika variabel tersebut tidak ditentukan, properti berasal dari pengaturan proksi sistem.
- Untuk Linux: Membaca konfigurasi proksi dari variabel lingkungan. Jika variabel tersebut tidak ditentukan, properti menginisialisasi instans yang tidak dikonfigurasi yang melewati semua alamat.
Variabel lingkungan yang digunakan untuk inisialisasi DefaultProxy pada platform berbasis Windows dan Unix adalah:
-
HTTP_PROXY: nama host atau alamat IP server proksi yang digunakan pada permintaan HTTP. -
HTTPS_PROXY: nama host atau alamat IP server proksi yang digunakan pada permintaan HTTPS. -
ALL_PROXY: nama host atau alamat IP server proksi yang digunakan pada permintaan HTTP dan HTTPS jikaHTTP_PROXYatauHTTPS_PROXYtidak ditentukan. -
NO_PROXY: daftar hostname yang dipisahkan koma yang harus dikecualikan dari penggunaan proksi.
PowerShell 7.4 menambahkan dukungan untuk algoritma kompresi Brotli.
