PipelineRequest interface

Paket:

@azure/core-rest-pipeline

Metadata tentang permintaan yang dibuat oleh alur.

Properti

abortSignal	Digunakan untuk membatalkan permintaan nanti.
agent	NODEJS HANYA opsi khusus Simpul untuk menyediakan kustom http.Agent/https.Agent. Tidak melakukan apa pun saat berjalan di browser.
allowInsecureConnection	Atur ke true jika permintaan dikirim melalui HTTP alih-alih HTTPS
body	Konten isi HTTP (jika ada)
disableKeepAlive	Jika koneksi tidak boleh digunakan kembali.
enableBrowserStreams	BROWSER HANYA opsi browser saja untuk mengaktifkan Stream browser. Jika opsi ini diatur dan responsnya adalah aliran, respons akan memiliki properti browserStream alih-alih blobBody tidak akan ditentukan. Nilai defaultnya adalah false
formData	Untuk menyimulasikan postingan formulir browser
headers	Header HTTP yang digunakan saat membuat permintaan.
method	Metode HTTP yang digunakan saat membuat permintaan.
onDownloadProgress	Panggilan balik yang diaktifkan setelah kemajuan pengunduhan.
onUploadProgress	Panggilan balik yang diaktifkan setelah kemajuan pengunggahan.
proxySettings	Konfigurasi proksi.
requestId	Pengidentifikasi unik untuk permintaan. Digunakan untuk pengelogan dan pelacakan.
streamResponseStatusCodes	Daftar kode status respons yang isi PipelineResponse terkaitnya harus diperlakukan sebagai aliran. Saat streamResponseStatusCodes berisi nilai Number.POSITIVE_INFINITY status apa pun akan diperlakukan sebagai aliran.
timeout	Jumlah milidetik yang dapat diambil permintaan sebelum dihentikan secara otomatis. Jika permintaan dihentikan, maka AbortError akan dilemparkan. Default ke 0, yang menonaktifkan batas waktu.
tlsSettings	Pengaturan untuk mengonfigurasi autentikasi TLS
tracingOptions	Opsi pelacakan yang digunakan untuk rentang yang dibuat.
url	URL untuk membuat permintaan.
withCredentials	Menunjukkan apakah agen pengguna harus mengirim cookie dari domain lain dalam kasus permintaan lintas asal. Default ke false.

Detail Properti

abortSignal

Digunakan untuk membatalkan permintaan nanti.

abortSignal?: AbortSignalLike

Nilai Properti

AbortSignalLike

agent

NODEJS HANYA opsi khusus Simpul untuk menyediakan kustom http.Agent/https.Agent. Tidak melakukan apa pun saat berjalan di browser.

agent?: Agent

Nilai Properti

Agent

allowInsecureConnection

Atur ke true jika permintaan dikirim melalui HTTP alih-alih HTTPS

allowInsecureConnection?: boolean

Nilai Properti

boolean

body

Konten isi HTTP (jika ada)

body?: RequestBodyType

Nilai Properti

RequestBodyType

disableKeepAlive

Jika koneksi tidak boleh digunakan kembali.

disableKeepAlive?: boolean

Nilai Properti

boolean

enableBrowserStreams

BROWSER HANYA opsi browser saja untuk mengaktifkan Stream browser. Jika opsi ini diatur dan responsnya adalah aliran, respons akan memiliki properti browserStream alih-alih blobBody tidak akan ditentukan.

Nilai defaultnya adalah false

enableBrowserStreams?: boolean

Nilai Properti

boolean

formData

Untuk menyimulasikan postingan formulir browser

formData?: FormDataMap

Nilai Properti

FormDataMap

headers

Header HTTP yang digunakan saat membuat permintaan.

headers: HttpHeaders

Nilai Properti

HttpHeaders

method

Metode HTTP yang digunakan saat membuat permintaan.

method: HttpMethods

Nilai Properti

HttpMethods

onDownloadProgress

Panggilan balik yang diaktifkan setelah kemajuan pengunduhan.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Nilai Properti

(progress: TransferProgressEvent) => void

onUploadProgress

Panggilan balik yang diaktifkan setelah kemajuan pengunggahan.

onUploadProgress?: (progress: TransferProgressEvent) => void

Nilai Properti

(progress: TransferProgressEvent) => void

proxySettings

Konfigurasi proksi.

proxySettings?: ProxySettings

Nilai Properti

ProxySettings

requestId

Pengidentifikasi unik untuk permintaan. Digunakan untuk pengelogan dan pelacakan.

requestId: string

Nilai Properti

string

streamResponseStatusCodes

Daftar kode status respons yang isi PipelineResponse terkaitnya harus diperlakukan sebagai aliran. Saat streamResponseStatusCodes berisi nilai Number.POSITIVE_INFINITY status apa pun akan diperlakukan sebagai aliran.

streamResponseStatusCodes?: Set<number>

Nilai Properti

Set<number>

timeout

Jumlah milidetik yang dapat diambil permintaan sebelum dihentikan secara otomatis. Jika permintaan dihentikan, maka AbortError akan dilemparkan. Default ke 0, yang menonaktifkan batas waktu.

timeout: number

Nilai Properti

number

tlsSettings

Pengaturan untuk mengonfigurasi autentikasi TLS

tlsSettings?: TlsSettings

Nilai Properti

TlsSettings

tracingOptions

Opsi pelacakan yang digunakan untuk rentang yang dibuat.

tracingOptions?: OperationTracingOptions

Nilai Properti

OperationTracingOptions

url

URL untuk membuat permintaan.

url: string

Nilai Properti

string

withCredentials

Menunjukkan apakah agen pengguna harus mengirim cookie dari domain lain dalam kasus permintaan lintas asal. Default ke false.

withCredentials: boolean

Nilai Properti

boolean