Sdílet prostřednictvím

RequestPrepareOptions interface

  • Reference
Balíček:
@azure/core-http

Možnosti přípravy odchozího požadavku HTTP

Vlastnosti

abortSignal

Signál přerušení kontroleru. Dá se použít k přerušení odesílání síťového požadavku i čekání na odpověď.
baseUrl

Základní adresa URL požadavku. Výchozí hodnota je: "https://management.azure.com". To platí jenom pro pathTemplate. Pokud zadáte adresu options.url, očekává se, že zadáte úplnou adresu URL.
body

Text požadavku. Může být libovolného typu. Tato hodnota bude serializována, pokud se nejedná o datový proud.
bodyIsStream

Označuje, jestli je tělo požadavku datový proud (užitečné pro scénáře nahrávání souborů).
deserializationMapper

Obsahuje informace o tom, jak deserializovat tělo odpovědi.
disableClientRequestId

Pokud je nastavená hodnota true, dá klientovi pokyn, aby nenastavil hlavičku x-ms-client-request-id na novou hodnotu Guid().
disableJsonStringifyOnBody

Určuje, jestli by tato metoda měla JSON.stringify() tělo požadavku. Výchozí hodnota: false.
formData

Data formuláře, která slouží k vytvoření textu požadavku.
headers

Slovník hlaviček požadavků, které je potřeba na žádost použít. Tady je klíč "header-name" a hodnota je "header-value". Hodnota hlavičky MUSÍ být typu řetězec.

  • ContentType musí být zadán s názvem klíče jako Content-Type. Výchozí hodnota application/json; charset=utf-8".
  • Pokud je vlastnost "options.bodyIsStream" nastavená na hodnotu true, je ve výchozím nastavení nastavená hodnota Transfer-Encoding na hodnotu "chunked".
  • Vlastnost Content-Type je ve výchozím nastavení nastavená na application/octet-stream, pokud je vlastnost options.bodyIsStream nastavená na hodnotu true.
  • Výraz "accept-language" je ve výchozím nastavení nastavený na "en-US".
  • Vlastnost x-ms-client-request-id je ve výchozím nastavení nastavená na nový identifikátor GUID. Pokud nechcete pro požadavek vygenerovat identifikátor GUID, nastavte parametr options.disableClientRequestId na hodnotu true.
mappers

Slovník mapovačů, které lze použít při [de]serializaci.
method

Metoda požadavku HTTP. Platné hodnoty jsou "GET", "PUT", "HEAD", "DELETE", "OPTIONS", "POST" nebo "PATCH".
onDownloadProgress

Umožňuje sledovat průběh stahování příchozí odpovědi.
onUploadProgress

Umožňuje sledovat průběh nahrávání odchozí žádosti.
pathParameters

Slovník parametrů cesty, které je třeba nahradit skutečnými hodnotami v pathTemplate. Tady je klíč "path-parameter-name" a hodnota je "path-parameter-value". "path-parameter-value" může být typu "string" nebo typu "object". Formát objektu by se měl použít, když chcete přeskočit kódování adresy URL. Při použití formátu objektu musí mít objekt vlastnost s názvem value, která poskytuje "path-parameter-value". Příklad:

  • path-parameter-value ve formátu object: { "path-parameter-name": { value: "path-parameter-value", skipUrlEncoding: true } }
  • path-parameter-value ve formátu "string": { "path-parameter-name": "path-parameter-value" }.
pathTemplate

Šablona cesty adresy URL požadavku. Buď zadejte "url" nebo "pathTemplate" v objektu options. Obě možnosti se vzájemně vylučují. Příklad: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}
queryParameters

Slovník parametrů dotazu, které se mají připojit k adrese URL, kde "klíč" je "query-parameter-name" a "value" je "query-parameter-value". "query-parameter-value" může být typu "string" nebo může být typu "object". Formát objektu by se měl použít, když chcete přeskočit kódování adresy URL. Při použití formátu objektu musí mít objekt vlastnost s názvem value, která poskytuje "query-parameter-value". Příklad:

  • query-parameter-value ve formátu object: { "query-parameter-name": { value: "query-parameter-value", skipUrlEncoding: true } }
  • query-parameter-value ve formátu "string": { "query-parameter-name": "query-parameter-value"}. Poznámka: Pokud už options.url obsahuje některé parametry dotazu, pak se k adrese URL připojí hodnota zadaná v options.queryParameters.
serializationMapper

Obsahuje informace o tom, jak serializovat text požadavku.
spanOptions

Trasování: Možnosti použité k vytvoření rozsahu při povoleném trasování.
tracingContext

Trasování: Kontext použitý při vytváření spans.
url

Adresa URL požadavku. Může nebo nemusí obsahovat parametry dotazu. Buď zadejte "url" nebo "pathTemplate" v objektu options. Obě možnosti se vzájemně vylučují.

Podrobnosti vlastnosti

abortSignal

Signál přerušení kontroleru. Dá se použít k přerušení odesílání síťového požadavku i čekání na odpověď.

abortSignal?: AbortSignalLike

Hodnota vlastnosti

AbortSignalLike

baseUrl

Základní adresa URL požadavku. Výchozí hodnota je: "https://management.azure.com". To platí jenom pro pathTemplate. Pokud zadáte adresu options.url, očekává se, že zadáte úplnou adresu URL.

baseUrl?: string

Hodnota vlastnosti

string

body

Text požadavku. Může být libovolného typu. Tato hodnota bude serializována, pokud se nejedná o datový proud.

body?: any

Hodnota vlastnosti

any

bodyIsStream

Označuje, jestli je tělo požadavku datový proud (užitečné pro scénáře nahrávání souborů).

bodyIsStream?: boolean

Hodnota vlastnosti

boolean

deserializationMapper

Obsahuje informace o tom, jak deserializovat tělo odpovědi.

deserializationMapper?: Record<string, unknown>

Hodnota vlastnosti

Record<string, unknown>

disableClientRequestId

Pokud je nastavená hodnota true, dá klientovi pokyn, aby nenastavil hlavičku x-ms-client-request-id na novou hodnotu Guid().

disableClientRequestId?: boolean

Hodnota vlastnosti

boolean

disableJsonStringifyOnBody

Určuje, jestli by tato metoda měla JSON.stringify() tělo požadavku. Výchozí hodnota: false.

disableJsonStringifyOnBody?: boolean

Hodnota vlastnosti

boolean

formData

Data formuláře, která slouží k vytvoření textu požadavku.

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

Hodnota vlastnosti

{[key: string]: any}

headers

Slovník hlaviček požadavků, které je potřeba na žádost použít. Tady je klíč "header-name" a hodnota je "header-value". Hodnota hlavičky MUSÍ být typu řetězec.

  • ContentType musí být zadán s názvem klíče jako Content-Type. Výchozí hodnota application/json; charset=utf-8".
  • Pokud je vlastnost "options.bodyIsStream" nastavená na hodnotu true, je ve výchozím nastavení nastavená hodnota Transfer-Encoding na hodnotu "chunked".
  • Vlastnost Content-Type je ve výchozím nastavení nastavená na application/octet-stream, pokud je vlastnost options.bodyIsStream nastavená na hodnotu true.
  • Výraz "accept-language" je ve výchozím nastavení nastavený na "en-US".
  • Vlastnost x-ms-client-request-id je ve výchozím nastavení nastavená na nový identifikátor GUID. Pokud nechcete pro požadavek vygenerovat identifikátor GUID, nastavte parametr options.disableClientRequestId na hodnotu true.
headers?: {[key: string]: any}

Hodnota vlastnosti

{[key: string]: any}

mappers

Slovník mapovačů, které lze použít při [de]serializaci.

mappers?: {[x: string]: any}

Hodnota vlastnosti

{[x: string]: any}

method

Metoda požadavku HTTP. Platné hodnoty jsou "GET", "PUT", "HEAD", "DELETE", "OPTIONS", "POST" nebo "PATCH".

method: HttpMethods

Hodnota vlastnosti

HttpMethods

onDownloadProgress

Umožňuje sledovat průběh stahování příchozí odpovědi.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Hodnota vlastnosti

(progress: TransferProgressEvent) => void

onUploadProgress

Umožňuje sledovat průběh nahrávání odchozí žádosti.

onUploadProgress?: (progress: TransferProgressEvent) => void

Hodnota vlastnosti

(progress: TransferProgressEvent) => void

pathParameters

Slovník parametrů cesty, které je třeba nahradit skutečnými hodnotami v pathTemplate. Tady je klíč "path-parameter-name" a hodnota je "path-parameter-value". "path-parameter-value" může být typu "string" nebo typu "object". Formát objektu by se měl použít, když chcete přeskočit kódování adresy URL. Při použití formátu objektu musí mít objekt vlastnost s názvem value, která poskytuje "path-parameter-value". Příklad:

  • path-parameter-value ve formátu object: { "path-parameter-name": { value: "path-parameter-value", skipUrlEncoding: true } }
  • path-parameter-value ve formátu "string": { "path-parameter-name": "path-parameter-value" }.
pathParameters?: {[key: string]: any | ParameterValue}

Hodnota vlastnosti

{[key: string]: any | ParameterValue}

pathTemplate

Šablona cesty adresy URL požadavku. Buď zadejte "url" nebo "pathTemplate" v objektu options. Obě možnosti se vzájemně vylučují. Příklad: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}

pathTemplate?: string

Hodnota vlastnosti

string

queryParameters

Slovník parametrů dotazu, které se mají připojit k adrese URL, kde "klíč" je "query-parameter-name" a "value" je "query-parameter-value". "query-parameter-value" může být typu "string" nebo může být typu "object". Formát objektu by se měl použít, když chcete přeskočit kódování adresy URL. Při použití formátu objektu musí mít objekt vlastnost s názvem value, která poskytuje "query-parameter-value". Příklad:

  • query-parameter-value ve formátu object: { "query-parameter-name": { value: "query-parameter-value", skipUrlEncoding: true } }
  • query-parameter-value ve formátu "string": { "query-parameter-name": "query-parameter-value"}. Poznámka: Pokud už options.url obsahuje některé parametry dotazu, pak se k adrese URL připojí hodnota zadaná v options.queryParameters.
queryParameters?: {[key: string]: any | ParameterValue}

Hodnota vlastnosti

{[key: string]: any | ParameterValue}

serializationMapper

Obsahuje informace o tom, jak serializovat text požadavku.

serializationMapper?: Mapper

Hodnota vlastnosti

Mapper

spanOptions

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

spanOptions?: SpanOptions

Hodnota vlastnosti

@azure/core-tracing.SpanOptions

tracingContext

Trasování: Kontext použitý při vytváření spans.

tracingContext?: Context

Hodnota vlastnosti

@azure/core-tracing.Context

url

Adresa URL požadavku. Může nebo nemusí obsahovat parametry dotazu. Buď zadejte "url" nebo "pathTemplate" v objektu options. Obě možnosti se vzájemně vylučují.

url?: string

Hodnota vlastnosti

string