WebResourceLike interface

Paket:

@azure/core-http

Uzak sunucuya yapılacak HTTP isteğinin açıklaması.

Özellikler

abortSignal	İptal denetleyicisi sinyali. Hem ağ isteği göndermeyi hem de yanıt beklemeyi durdurmak için kullanılabilir.
body	İsteğin HTTP gövde içeriği.
decompressResponse	yanıtın Accept-Encoding üst bilgisine göre açılıp açılmayacağı (yalnızca düğüm getirme)
formData	İstek gövdesini oluşturmak için kullanılan form verileri.
headers	İstek yapılırken kullanılacak HTTP üst bilgileri.
keepAlive	Bağlantının yeniden kullanılması gerekiyorsa.
method	İstek yapılırken kullanılacak HTTP yöntemi.
onDownloadProgress	İndirme ilerlemesi üzerine tetiklenen geri arama.
onUploadProgress	Karşıya yükleme ilerlemesi üzerine tetiklenen geri arama.
operationResponseGetter	Verilen OperationSpec ve HttpOperationResponse bileşimi için uygun OperationResponse değerini döndüren bir işlev. Bu tanımsızsa, basit bir durum kodu araması kullanılır.
operationSpec	Yanıtı ayrıştırmak için kullanılır.
proxySettings	Ara sunucu yapılandırması.
query	Nesne olarak temsil edilen sorgu dizesi.
requestId	İstek için benzersiz bir tanımlayıcı. Günlüğe kaydetme ve izleme için kullanılır.
shouldDeserialize	HttpOperationResponse'un seri durumdan çıkarılıp çıkarılmayacağı. Bu tanımlanmamışsa HttpOperationResponse seri durumdan çıkarılmalıdır.
streamResponseBody	HttpOperationResponse gövdesinin akış olarak ele alınıp alınmayacağı.
streamResponseStatusCodes	Karşılık gelen HttpOperationResponse gövdesi bir akış olarak ele alınması gereken yanıt durum kodlarının listesi.
timeout	otomatik olarak sonlandırılmadan önce bir isteğin alabildiği milisaniye sayısı. İstek sonlandırılırsa bir AbortError oluşturulur.
tracingContext	İzleme: Yayılma alanları oluşturulurken kullanılan bağlam.
url	İstek tarafından erişilen URL.
withCredentials	Kimlik bilgilerinin (tanımlama bilgileri) bir XHR sırasında birlikte gönderilmesi gerekiyorsa.

Yöntemler

clone()	Bu istek nesnesini klonla.
prepare(RequestPrepareOptions)	İstekte seçenekleri ayarlar.
validateRequestProperties()	yöntem, url, headers["Content-Type"], headers["accept-language"] gibi gerekli özelliklerin tanımlandığını doğrular. Yukarıda belirtilen özelliklerden biri tanımlanmadıysa hata oluşturur.

Özellik Ayrıntıları

abortSignal

İptal denetleyicisi sinyali. Hem ağ isteği göndermeyi hem de yanıt beklemeyi durdurmak için kullanılabilir.

abortSignal?: AbortSignalLike

Özellik Değeri

AbortSignalLike

body

İsteğin HTTP gövde içeriği.

body?: any

Özellik Değeri

any

decompressResponse

yanıtın Accept-Encoding üst bilgisine göre açılıp açılmayacağı (yalnızca düğüm getirme)

decompressResponse?: boolean

Özellik Değeri

boolean

formData

İstek gövdesini oluşturmak için kullanılan form verileri.

formData?: any

Özellik Değeri

any

headers

İstek yapılırken kullanılacak HTTP üst bilgileri.

headers: HttpHeadersLike

Özellik Değeri

HttpHeadersLike

keepAlive

Bağlantının yeniden kullanılması gerekiyorsa.

keepAlive?: boolean

Özellik Değeri

boolean

method

İstek yapılırken kullanılacak HTTP yöntemi.

method: HttpMethods

Özellik Değeri

HttpMethods

onDownloadProgress

İndirme ilerlemesi üzerine tetiklenen geri arama.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Özellik Değeri

(progress: TransferProgressEvent) => void

onUploadProgress

Karşıya yükleme ilerlemesi üzerine tetiklenen geri arama.

onUploadProgress?: (progress: TransferProgressEvent) => void

Özellik Değeri

(progress: TransferProgressEvent) => void

operationResponseGetter

Verilen OperationSpec ve HttpOperationResponse bileşimi için uygun OperationResponse değerini döndüren bir işlev. Bu tanımsızsa, basit bir durum kodu araması kullanılır.

operationResponseGetter?: (operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponse

Özellik Değeri

(operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponse

operationSpec

Yanıtı ayrıştırmak için kullanılır.

operationSpec?: OperationSpec

Özellik Değeri

OperationSpec

proxySettings

Ara sunucu yapılandırması.

proxySettings?: ProxySettings

Özellik Değeri

ProxySettings

query

Nesne olarak temsil edilen sorgu dizesi.

query?: {[key: string]: any}

Özellik Değeri

{[key: string]: any}

requestId

İstek için benzersiz bir tanımlayıcı. Günlüğe kaydetme ve izleme için kullanılır.

requestId: string

Özellik Değeri

string

shouldDeserialize

HttpOperationResponse'un seri durumdan çıkarılıp çıkarılmayacağı. Bu tanımlanmamışsa HttpOperationResponse seri durumdan çıkarılmalıdır.

shouldDeserialize?: boolean | (response: HttpOperationResponse) => boolean

Özellik Değeri

boolean | (response: HttpOperationResponse) => boolean

streamResponseBody

Uyarı

Bu API artık kullanım dışıdır.

Use streamResponseStatusCodes property instead.

HttpOperationResponse gövdesinin akış olarak ele alınıp alınmayacağı.

streamResponseBody?: boolean

Özellik Değeri

boolean

streamResponseStatusCodes

Karşılık gelen HttpOperationResponse gövdesi bir akış olarak ele alınması gereken yanıt durum kodlarının listesi.

streamResponseStatusCodes?: Set<number>

Özellik Değeri

Set<number>

timeout

otomatik olarak sonlandırılmadan önce bir isteğin alabildiği milisaniye sayısı. İstek sonlandırılırsa bir AbortError oluşturulur.

timeout: number

Özellik Değeri

number

tracingContext

İzleme: Yayılma alanları oluşturulurken kullanılan bağlam.

tracingContext?: Context

Özellik Değeri

@azure/core-tracing.Context

url

İstek tarafından erişilen URL.

url: string

Özellik Değeri

string

withCredentials

Kimlik bilgilerinin (tanımlama bilgileri) bir XHR sırasında birlikte gönderilmesi gerekiyorsa.

withCredentials: boolean

Özellik Değeri

boolean

Yöntem Ayrıntıları

clone()

Bu istek nesnesini klonla.

function clone(): WebResourceLike

Döndürülenler

WebResourceLike

prepare(RequestPrepareOptions)

İstekte seçenekleri ayarlar.

function prepare(options: RequestPrepareOptions): WebResourceLike

Parametreler

options

RequestPrepareOptions

Döndürülenler

WebResourceLike

validateRequestProperties()

yöntem, url, headers["Content-Type"], headers["accept-language"] gibi gerekli özelliklerin tanımlandığını doğrular. Yukarıda belirtilen özelliklerden biri tanımlanmadıysa hata oluşturur.

function validateRequestProperties()