PipelineRequestOptions interface

Paket:

@azure/core-rest-pipeline

İstek başlatma ayarları. Neredeyse Kısmi PipelineRequest'e<> eşdeğerdir, ancak url zorunludur.

Özellikler

abortSignal	İsteği daha sonra durdurmak için kullanılır.
agent	YALNıZCA NODEJS Özel bir http.Agent/https.Agentsağlamak için yalnızca düğüm seçeneği. NOT: Hizmetle temel alınan bağlantının yeniden kullanılabilmesi için bu genellikle birden çok istek tarafından paylaşılan bir örnek olmalıdır. Tarayıcıda çalışırken hiçbir şey yapmaz.
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 tarayıcı seçeneği. Bu seçenek ayarlanırsa ve akış kullanılırsa (bkz. streamResponseStatusCodes), yanıtta tanımsız olacak browserStream yerine bir özellik blobBody olur. Varsayılan değer false
formData	Tarayıcı form gönderisi simülasyonu yapmak için
headers	İstek yapılırken kullanılacak HTTP üst bilgileri.
method	İstek yapılırken kullanılacak HTTP yöntemi.
multipartBody	Çok bölümlü bir isteğin gövdesi.
onDownloadProgress	İndirme ilerlemesi üzerine tetiklenen geri arama.
onUploadProgress	Karşıya yükleme ilerlemesi üzerine tetiklenen geri arama.
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.
requestOverrides	İstekte ayarlanacak ek seçenekler. Bu, var olanları geçersiz kılmak veya bildirilmemiş istek özelliklerini sağlamak için bir yol sağlar. Olası geçerli özellikler için bkz. NodeJS https.request seçenekleri: https://nodejs.org/api/http.html#httprequestoptions-callback Tarayıcı RequestInit: https://developer.mozilla.org/en-US/docs/Web/API/RequestInit UYARI: Burada belirtilen seçenekler, istek HttpClient tarafından gönderildiğinde aynı adların özelliklerini geçersiz kılar.
streamResponseStatusCodes	Karşılık gelen PipelineResponse gövdesi 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. Varsayılan değer 0'dır ve bu da zaman aşımını devre dışı bırakır.
tlsSettings	TLS kimlik doğrulamasını yapılandırma ayarları
tracingOptions	İzleme etkinleştirildiğinde bir yayılma alanı oluşturmak için kullanılan seçenekler.
url	İstekte bulunacak URL.
withCredentials	Kimlik bilgilerinin (tanımlama bilgileri) bir XHR sırasında birlikte gönderilmesi gerekiyorsa. Varsayılan değer false'tur.

Özellik Ayrıntıları

abortSignal

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

abortSignal?: AbortSignalLike

Özellik Değeri

AbortSignalLike

agent

YALNıZCA NODEJS

Özel bir http.Agent/https.Agentsağlamak için yalnızca düğüm seçeneği. NOT: Hizmetle temel alınan bağlantının yeniden kullanılabilmesi için bu genellikle birden çok istek tarafından paylaşılan bir örnek olmalıdır. Tarayıcıda çalışırken hiçbir şey yapmaz.

agent?: Agent

Özellik Değeri

Agent

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 tarayıcı seçeneği. Bu seçenek ayarlanırsa ve akış kullanılırsa (bkz. streamResponseStatusCodes), yanıtta tanımsız olacak browserStream yerine bir özellik blobBody olur.

Varsayılan değer false

enableBrowserStreams?: boolean

Özellik Değeri

boolean

formData

Tarayıcı form gönderisi simülasyonu 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

multipartBody

Çok bölümlü bir isteğin gövdesi.

multipartBody?: MultipartRequestBody

Özellik Değeri

MultipartRequestBody

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

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

requestOverrides

İstekte ayarlanacak ek seçenekler. Bu, var olanları geçersiz kılmak veya bildirilmemiş istek özelliklerini sağlamak için bir yol sağlar.

Olası geçerli özellikler için bkz.

• NodeJS https.request seçenekleri: https://nodejs.org/api/http.html#httprequestoptions-callback
• Tarayıcı RequestInit: https://developer.mozilla.org/en-US/docs/Web/API/RequestInit

UYARI: Burada belirtilen seçenekler, istek HttpClient tarafından gönderildiğinde aynı adların özelliklerini geçersiz kılar.

requestOverrides?: Record<string, unknown>

Özellik Değeri

Record<string, unknown>

streamResponseStatusCodes

Karşılık gelen PipelineResponse gövdesi 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. 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

tlsSettings

TLS kimlik doğrulamasını yapılandırma ayarları

tlsSettings?: TlsSettings

Özellik Değeri

TlsSettings

tracingOptions

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

tracingOptions?: OperationTracingOptions

Özellik Değeri

OperationTracingOptions

url

İstekte bulunacak URL.

url: string

Özellik Değeri

string

withCredentials

Kimlik bilgilerinin (tanımlama bilgileri) bir XHR sırasında birlikte gönderilmesi gerekiyorsa. Varsayılan değer false'tur.

withCredentials?: boolean

Özellik Değeri

boolean