PipelineRequestOptions interface

Paket:

@azure/core-rest-pipeline

İstek başlatma ayarları. Kısmi ile neredeyse eşdeğerdir, ancak URL zorunludur.

Özellikler

abortSignal	İsteği daha sonra durdurmak için kullanılır.
allowInsecureConnection	İstek HTTPS yerine HTTP üzerinden gönderiliyorsa true olarak ayarlayın
body	HTTP gövdesi içeriği (varsa)
disableKeepAlive	Bağlantının yeniden kullanılamaması gerekiyorsa.
enableBrowserStreams	YALNIZCA TARAYıCı Streams API'sinin kullanımını etkinleştirmek için yalnızca bir tarayıcı seçeneği. Bu seçenek ayarlanırsa ve akış kullanılırsa (bkz streamResponseStatusCodes. ), yanıtın bir özelliği browserStream olur ve bunun yerine blobBody tanımsız olur. Varsayılan değer false
formData	Tarayıcı form gönderisi benzetimi yapmak için
headers	İstek yapılırken kullanılacak HTTP üst bilgileri.
method	İstek yapılırken kullanılacak HTTP yöntemi.
onDownloadProgress	İndirme ilerlemesi üzerine tetiklenen geri çağırma.
onUploadProgress	Karşıya yükleme ilerlemesi üzerine tetiklenen geri çağırma.
proxySettings	Ara sunucu yapılandırması.
requestId	İstek için benzersiz bir tanımlayıcı. Günlüğe kaydetme ve izleme için kullanılır.
streamResponseStatusCodes	karşılık gelen PipelineResponse gövdesi bir akış olarak ele alınması gereken yanıt durum kodlarının listesi.
timeout	Bir isteğin otomatik olarak sonlandırılmadan önce ne kadar süre alabileceğini milisaniye cinsinden belirtin. İstek sonlandırılırsa, bir AbortError oluşturulur. Varsayılan değer 0'dır ve bu da zaman aşımını devre dışı bırakır.
tracingOptions	İzleme etkinleştirildiğinde yayılma alanı oluşturmak için kullanılan seçenekler.
url	İstekte bulunulanın URL'si.
withCredentials	XHR sırasında kimlik bilgilerinin (tanımlama bilgileri) birlikte gönderilmesi gerekiyorsa. Varsayılan değer false şeklindedir.

Özellik Ayrıntıları

abortSignal

İsteği daha sonra durdurmak için kullanılır.

abortSignal?: AbortSignalLike

Özellik Değeri

AbortSignalLike

allowInsecureConnection

İstek HTTPS yerine HTTP üzerinden gönderiliyorsa true olarak ayarlayın

allowInsecureConnection?: boolean

Özellik Değeri

boolean

body

HTTP gövdesi içeriği (varsa)

body?: RequestBodyType

Özellik Değeri

RequestBodyType

disableKeepAlive

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

disableKeepAlive?: boolean

Özellik Değeri

boolean

enableBrowserStreams

YALNIZCA TARAYıCı

Streams API'sinin kullanımını etkinleştirmek için yalnızca bir tarayıcı seçeneği. Bu seçenek ayarlanırsa ve akış kullanılırsa (bkz streamResponseStatusCodes. ), yanıtın bir özelliği browserStream olur ve bunun yerine blobBody tanımsız olur.

Varsayılan değer false

enableBrowserStreams?: boolean

Özellik Değeri

boolean

formData

Tarayıcı form gönderisi benzetimi yapmak için

formData?: FormDataMap

Özellik Değeri

FormDataMap

headers

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

headers?: HttpHeaders

Özellik Değeri

HttpHeaders

method

İstek yapılırken 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

proxySettings

Ara sunucu yapılandırması.

proxySettings?: ProxySettings

Özellik Değeri

ProxySettings

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

streamResponseStatusCodes

karşılık gelen PipelineResponse 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

Bir isteğin otomatik olarak sonlandırılmadan önce ne kadar süre alabileceğini milisaniye cinsinden belirtin. İstek sonlandırılırsa, bir AbortError oluşturulur. Varsayılan değer 0'dır ve bu da zaman aşımını devre dışı bırakır.

timeout?: number

Özellik Değeri

number

tracingOptions

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

tracingOptions?: OperationTracingOptions

Özellik Değeri

OperationTracingOptions

url

İstekte bulunulanın URL'si.

url: string

Özellik Değeri

string

withCredentials

XHR sırasında kimlik bilgilerinin (tanımlama bilgileri) birlikte gönderilmesi gerekiyorsa. Varsayılan değer false şeklindedir.

withCredentials?: boolean

Özellik Değeri

boolean