PipelineRequestOptions interface

Nastavení pro inicializaci požadavku Téměř ekvivalentní k Partial<PipelineRequest>, ale adresa URL je povinná.

Vlastnosti

abortSignal

Používá se k přerušení žádosti později.

body

Základní obsah HTTP (pokud existuje)

formData

Simulace příspěvku formuláře prohlížeče

headers

Hlavičky HTTP, které se mají použít při vytváření požadavku.

keepAlive

Pokud by se připojení mělo znovu použít. Výchozí hodnota je true.

method

Metoda HTTP, která se má použít při vytváření požadavku.

onDownloadProgress

Zpětné volání, které se aktivuje při průběhu stahování.

onUploadProgress

Zpětné volání, které se aktivuje při nahrávání průběhu.

proxySettings

Konfigurace proxy.

requestId

Unikátní identifikátor pro požadavek. Používá se k protokolování a trasování.

spanOptions

Možnosti použité k vytvoření rozsahu při povolení trasování

streamResponseStatusCodes

Seznam stavových kódů odpovědí, jejichž odpovídající tělo PipelineResponse by se mělo považovat za datový proud.

timeout

Počet milisekund, které může požadavek trvat, než se automaticky ukončí. Pokud je žádost ukončena, vyvolá se AbortError. Výchozí hodnota je 0, což zakáže vypršení časového limitu.

url

Adresa URL, na kterou se má požadavek provést.

withCredentials

Pokud by se během XHR měly odesílat přihlašovací údaje (soubory cookie). Výchozí nastavení je „false“.

Podrobnosti vlastnosti

abortSignal

Používá se k přerušení žádosti později.

abortSignal?: AbortSignalLike

Hodnota vlastnosti

body

Základní obsah HTTP (pokud existuje)

body?: RequestBodyType

Hodnota vlastnosti

formData

Simulace příspěvku formuláře prohlížeče

formData?: FormDataMap

Hodnota vlastnosti

headers

Hlavičky HTTP, které se mají použít při vytváření požadavku.

headers?: HttpHeaders

Hodnota vlastnosti

keepAlive

Pokud by se připojení mělo znovu použít. Výchozí hodnota je true.

keepAlive?: boolean

Hodnota vlastnosti

boolean

method

Metoda HTTP, která se má použít při vytváření požadavku.

method?: HttpMethods

Hodnota vlastnosti

onDownloadProgress

Zpětné volání, které se aktivuje při průběhu stahování.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Hodnota vlastnosti

(progress: TransferProgressEvent) => void

onUploadProgress

Zpětné volání, které se aktivuje při nahrávání průběhu.

onUploadProgress?: (progress: TransferProgressEvent) => void

Hodnota vlastnosti

(progress: TransferProgressEvent) => void

proxySettings

Konfigurace proxy.

proxySettings?: ProxySettings

Hodnota vlastnosti

requestId

Unikátní identifikátor pro požadavek. Používá se k protokolování a trasování.

requestId?: string

Hodnota vlastnosti

string

spanOptions

Možnosti použité k vytvoření rozsahu při povolení trasování

spanOptions?: SpanOptions

Hodnota vlastnosti

@azure/core-tracing.SpanOptions

streamResponseStatusCodes

Seznam stavových kódů odpovědí, jejichž odpovídající tělo PipelineResponse by se mělo považovat za datový proud.

streamResponseStatusCodes?: Set<number>

Hodnota vlastnosti

Set<number>

timeout

Počet milisekund, které může požadavek trvat, než se automaticky ukončí. Pokud je žádost ukončena, vyvolá se AbortError. Výchozí hodnota je 0, což zakáže vypršení časového limitu.

timeout?: number

Hodnota vlastnosti

number

url

Adresa URL, na kterou se má požadavek provést.

url: string

Hodnota vlastnosti

string

withCredentials

Pokud by se během XHR měly odesílat přihlašovací údaje (soubory cookie). Výchozí nastavení je „false“.

withCredentials?: boolean

Hodnota vlastnosti

boolean