WebResource class

Paket:

@azure/storage-queue

Yeni bir WebResource nesnesi oluşturur.

Bu sınıf, kitaplık / uygulamadan bağımsız olarak ve bir istek başlatmak için gerekli özellikleri sarmalayarak REST çağrısı üzerinde bir soyutlama sağlar.

Oluşturucular

WebResource(string, HttpMethods, unknown, {[key: string]: any}, HttpHeadersLike | {[key: string]: any}, boolean, boolean, AbortSignalLike, number, (progress: TransferProgressEvent) => void, (progress: TransferProgressEvent) => void, ProxySettings, boolean, boolean, Set<number>)

Özellikler

abortSignal	İptal denetleyicisi sinyali. Hem ağ isteği göndermeyi hem de yanıt beklemeyi durdurmak için kullanılabilir.
body	İstek gövdesi.
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	HTTP üst bilgileri.
keepAlive	İstekler boyunca HTTP bağlantılarının canlı tutulup tutulmayacağı.
method	Kullanılacak HTTP yöntemi.
onDownloadProgress	İndirme ilerlemesi üzerine tetiklenen geri çağırma.
onUploadProgress	Karşıya yükleme ilerlemesi üzerine tetiklenen geri çağırma.
operationResponseGetter	Verilen OperationSpec ve HttpOperationResponse bileşimi için düzgün OperationResponse döndüren bir işlev. Bu tanımsızsa, basit bir durum kodu araması kullanılır.
operationSpec	HTTP isteğinin belirtimi.
proxySettings	Gerekirse hangi proxy'nin kullanılacağı.
query	SORGU URL'ye eklendi.
requestId	Giden isteğin benzersiz tanımlayıcısı.
shouldDeserialize	HttpOperationResponse'un seri durumdan çıkarılıp seri durumdan çıkarılmayacağı. Bu tanımlanmamışsa HttpOperationResponse seri durumdan çıkarılmalıdır.
spanOptions	İzleme: İzleme etkinleştirildiğinde yayılma alanı oluşturmak için kullanılan seçenekler.
streamResponseBody	HttpOperationResponse gövdesinin akış olarak ele alınıp alınmayacağı.
streamResponseStatusCodes	Karşılık gelen HttpOperationResponse gövdesi bir akış olarak kabul edilmesi gereken durum kodlarının listesi.
timeout	İsteği durdurmadan önce milisaniye cinsinden beklenmesi gereken süre.
tracingContext	İzleme: Spans oluşturulurken kullanılan bağlam.
url	Giden isteğin URL'si.
withCredentials	Tarayıcıda siteler arası bir hedefe istekte bulunurken kimlik bilgilerinin (tanımlama bilgileri, yetkilendirme üst bilgileri veya TLS istemci sertifikaları aracılığıyla) gönderilip gönderilmeyeceği.

Yöntemler

clone()	Bu WebResource HTTP istek nesnesini klonla.
prepare(RequestPrepareOptions)	İsteği hazırlar.
validateRequestProperties()	yöntem, url, headers["Content-Type"], headers["accept-language"] gibi gerekli özelliklerin tanımlandığını doğrular. Yukarıda belirtilen özelliklerden biri tanımlanmamışsa hata oluşturur.

Oluşturucu Ayrıntıları

WebResource(string, HttpMethods, unknown, {[key: string]: any}, HttpHeadersLike | {[key: string]: any}, boolean, boolean, AbortSignalLike, number, (progress: TransferProgressEvent) => void, (progress: TransferProgressEvent) => void, ProxySettings, boolean, boolean, Set<number>)

new WebResource(url?: string, method?: HttpMethods, body?: unknown, query?: {[key: string]: any}, headers?: HttpHeadersLike | {[key: string]: any}, streamResponseBody?: boolean, withCredentials?: boolean, abortSignal?: AbortSignalLike, timeout?: number, onUploadProgress?: (progress: TransferProgressEvent) => void, onDownloadProgress?: (progress: TransferProgressEvent) => void, proxySettings?: ProxySettings, keepAlive?: boolean, decompressResponse?: boolean, streamResponseStatusCodes?: Set<number>)

Parametreler

url

string

method

HttpMethods

body

unknown

query

{[key: string]: any}

headers

HttpHeadersLike | {[key: string]: any}

streamResponseBody

boolean

withCredentials

boolean

abortSignal

AbortSignalLike

timeout

number

onUploadProgress

(progress: TransferProgressEvent) => void

onDownloadProgress

(progress: TransferProgressEvent) => void

proxySettings

ProxySettings

keepAlive

boolean

decompressResponse

boolean

streamResponseStatusCodes

Set<number>

Ö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

İstek gövdesi.

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

HTTP üst bilgileri.

headers: HttpHeadersLike

Özellik Değeri

HttpHeadersLike

keepAlive

İstekler boyunca HTTP bağlantılarının canlı tutulup tutulmayacağı.

keepAlive?: boolean

Özellik Değeri

boolean

method

Kullanılacak HTTP yöntemi.

method: HttpMethods

Özellik Değeri

HttpMethods

onDownloadProgress

İndirme ilerlemesi üzerine tetiklenen geri çağırma.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Özellik Değeri

(progress: TransferProgressEvent) => void

onUploadProgress

Karşıya yükleme ilerlemesi üzerine tetiklenen geri çağırma.

onUploadProgress?: (progress: TransferProgressEvent) => void

Özellik Değeri

(progress: TransferProgressEvent) => void

operationResponseGetter

Verilen OperationSpec ve HttpOperationResponse bileşimi için düzgün OperationResponse 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

HTTP isteğinin belirtimi.

operationSpec?: OperationSpec

Özellik Değeri

OperationSpec

proxySettings

Gerekirse hangi proxy'nin kullanılacağı.

proxySettings?: ProxySettings

Özellik Değeri

ProxySettings

query

SORGU URL'ye eklendi.

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

Özellik Değeri

{[key: string]: any}

requestId

Giden isteğin benzersiz tanımlayıcısı.

requestId: string

Özellik Değeri

string

shouldDeserialize

HttpOperationResponse'un seri durumdan çıkarılıp seri durumdan çı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

spanOptions

İzleme: İzleme etkinleştirildiğinde yayılma alanı oluşturmak için kullanılan seçenekler.

spanOptions?: SpanOptions

Özellik Değeri

@azure/core-tracing.SpanOptions

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 kabul edilmesi gereken durum kodlarının listesi.

streamResponseStatusCodes?: Set<number>

Özellik Değeri

Set<number>

timeout

İsteği durdurmadan önce milisaniye cinsinden beklenmesi gereken süre.

timeout: number

Özellik Değeri

number

tracingContext

İzleme: Spans oluşturulurken kullanılan bağlam.

tracingContext?: Context

Özellik Değeri

@azure/core-tracing.Context

url

Giden isteğin URL'si.

url: string

Özellik Değeri

string

withCredentials

Tarayıcıda siteler arası bir hedefe istekte bulunurken kimlik bilgilerinin (tanımlama bilgileri, yetkilendirme üst bilgileri veya TLS istemci sertifikaları aracılığıyla) gönderilip gönderilmeyeceği.

withCredentials: boolean

Özellik Değeri

boolean

Yöntem Ayrıntıları

clone()

Bu WebResource HTTP istek nesnesini klonla.

function clone(): WebResource

Döndürülenler

WebResource

Bu WebResource HTTP istek nesnesinin kopyası.

prepare(RequestPrepareOptions)

İsteği hazırlar.

function prepare(options: RequestPrepareOptions): WebResource

Parametreler

options

RequestPrepareOptions

İsteğin hazırlanması için sağlanması gereken seçenekler.

Döndürülenler

WebResource

İstek işlem hattına verilmesi gereken hazırlanmış WebResource (HTTP İsteği) nesnesini döndürür.

validateRequestProperties()

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

function validateRequestProperties()