PipelineRequestOptions interface

Paket:
@azure/core-rest-pipeline

Pengaturan untuk menginisialisasi permintaan. Hampir setara dengan Partial<PipelineRequest>, tetapi url wajib.

Properti

abortSignal

Digunakan untuk membatalkan permintaan nanti.
agent

HANYA NODEJS

Opsi khusus simpul untuk menyediakan http.Agent/https.Agentkustom . CATATAN: biasanya ini harus menjadi satu instans yang dibagikan oleh beberapa permintaan sehingga koneksi yang mendasar ke layanan dapat digunakan kembali. 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 SAJA

Opsi hanya browser untuk mengaktifkan penggunaan STREAMS API. Jika opsi ini diatur dan streaming digunakan (lihat streamResponseStatusCodes), respons akan memiliki properti browserStream alih-alih blobBody yang tidak akan ditentukan.

Nilai defaultnya adalah false
formData

Untuk mensimulasikan posting formulir browser
headers

Header HTTP yang akan digunakan saat membuat permintaan.
method

Metode HTTP yang digunakan saat membuat permintaan.
multipartBody

Isi untuk permintaan multipihak.
onDownloadProgress

Panggilan balik yang diaktifkan setelah kemajuan pengunduhan.
onUploadProgress

Panggilan balik yang diaktifkan setelah kemajuan pengunggahan.
proxySettings

Konfigurasi proksi.
requestId

Pengidentifikasi unik untuk permintaan tersebut. Digunakan untuk pengelogan dan pelacakan.
requestOverrides

Opsi tambahan untuk diatur pada permintaan. Ini menyediakan cara untuk mengganti yang sudah ada atau memberikan properti permintaan yang tidak dideklarasikan.

Untuk kemungkinan properti yang valid, lihat

PERINGATAN: Opsi yang ditentukan di sini akan menggantikan properti apa pun dengan nama yang sama saat permintaan dikirim oleh HttpClient.
streamResponseStatusCodes

Daftar kode status respons yang isi PipelineResponse terkait harus diperlakukan sebagai aliran.
timeout

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

Pengaturan untuk mengonfigurasi autentikasi TLS
tracingOptions

Opsi yang digunakan untuk membuat rentang saat pelacakan diaktifkan.
url

URL untuk membuat permintaan.
withCredentials

Jika kredensial (cookie) harus dikirim bersama selama XHR. Default ke false.

Detail Properti

abortSignal

Digunakan untuk membatalkan permintaan nanti.

abortSignal?: AbortSignalLike

Nilai Properti

AbortSignalLike

agent

HANYA NODEJS

Opsi khusus simpul untuk menyediakan http.Agent/https.Agentkustom . CATATAN: biasanya ini harus menjadi satu instans yang dibagikan oleh beberapa permintaan sehingga koneksi yang mendasar ke layanan dapat digunakan kembali. 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 SAJA

Opsi hanya browser untuk mengaktifkan penggunaan STREAMS API. Jika opsi ini diatur dan streaming digunakan (lihat streamResponseStatusCodes), respons akan memiliki properti browserStream alih-alih blobBody yang tidak akan ditentukan.

Nilai defaultnya adalah false

enableBrowserStreams?: boolean

Nilai Properti

boolean

formData

Untuk mensimulasikan posting formulir browser

formData?: FormDataMap

Nilai Properti

FormDataMap

headers

Header HTTP yang akan digunakan saat membuat permintaan.

headers?: HttpHeaders

Nilai Properti

HttpHeaders

method

Metode HTTP yang digunakan saat membuat permintaan.

method?: HttpMethods

Nilai Properti

HttpMethods

multipartBody

Isi untuk permintaan multipihak.

multipartBody?: MultipartRequestBody

Nilai Properti

MultipartRequestBody

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 tersebut. Digunakan untuk pengelogan dan pelacakan.

requestId?: string

Nilai Properti

string

requestOverrides

Opsi tambahan untuk diatur pada permintaan. Ini menyediakan cara untuk mengganti yang sudah ada atau memberikan properti permintaan yang tidak dideklarasikan.

Untuk kemungkinan properti yang valid, lihat

PERINGATAN: Opsi yang ditentukan di sini akan menggantikan properti apa pun dengan nama yang sama saat permintaan dikirim oleh HttpClient.

requestOverrides?: Record<string, unknown>

Nilai Properti

Record<string, unknown>

streamResponseStatusCodes

Daftar kode status respons yang isi PipelineResponse terkait harus diperlakukan sebagai aliran.

streamResponseStatusCodes?: Set<number>

Nilai Properti

Set<number>

timeout

Jumlah milidetik yang dapat diambil permintaan sebelum dihentikan secara otomatis. Jika permintaan dihentikan, 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 yang digunakan untuk membuat rentang saat pelacakan diaktifkan.

tracingOptions?: OperationTracingOptions

Nilai Properti

OperationTracingOptions

url

URL untuk membuat permintaan.

url: string

Nilai Properti

string

withCredentials

Jika kredensial (cookie) harus dikirim bersama selama XHR. Default ke false.

withCredentials?: boolean

Nilai Properti

boolean