Sdílet prostřednictvím

RequestPrepareOptions interface

  • Reference
Balíček:
@azure/ms-rest-js

Vlastnosti

abortSignal
baseUrl

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

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

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

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

Pokud je nastavená hodnota true, dává klientovi pokyn, aby nenastavil hlavičku x-ms-client-request-id na nový identifikátor GUID().
disableJsonStringifyOnBody

Určuje, zda má tato metoda JSON.stringify() text požadavku. Výchozí hodnota: false.
formData
headers

Slovník hlaviček požadavků, které je potřeba použít na požadavek. 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 možnost options.bodyIsStream nastavená na hodnotu true, je ve výchozím nastavení nastavená hodnota "Transfer-Encoding" na hodnotu "bloked".
  • Vlastnost Content-Type je ve výchozím nastavení nastavená na application/octet-stream, pokud je parametr options.bodyIsStream nastavený na hodnotu true.
  • Ve výchozím nastavení je "accept-language" nastavena na "en-US"
  • Ve výchozím nastavení je parametr x-ms-client-request-id nastavený na nový identifikátor GUID. Pokud nechcete vygenerovat identifikátor GUID pro požadavek, nastavte 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
onUploadProgress
pathParameters

Slovník parametrů cesty, které je potřeba nahradit skutečnými hodnotami v pathTemplate. Tady je klíč "path-parameter-name" a hodnota je "path-parameter-value". Hodnota path-parameter-value může být typu "string" nebo může být typu "object". Formát "object" by se měl použít, pokud chcete přeskočit kódování adresy URL. Při použití formátu objektu musí mít objekt vlastnost pojmenovanou hodnotu, 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. Zadejte "url" nebo zadejte "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 má připojit k adrese URL, kde "klíč" je "název parametru dotazu" a "hodnota" je "query-parameter-value". Parametr query-parameter-value může být typu "string" nebo může být typu "object". Formát "object" by se měl použít, pokud chcete přeskočit kódování adresy URL. Při použití formátu objektu musí mít objekt vlastnost pojmenovanou hodnotu, 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 options.url již obsahuje některé parametry dotazu, pak hodnota zadaná v options.queryParameters bude připojena k adrese URL.
redirectLimit

Omezte počet přesměrování sledovaných pro tento požadavek. Pokud je nastavená hodnota 0, přesměrování nebude následovat. Pokud ponecháte nedefinované výchozí chování přesměrování podkladového node_fetch se použije.
serializationMapper

Poskytuje informace o tom, jak serializovat tělo požadavku.
streamResponseBody
url

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

Podrobnosti vlastnosti

abortSignal 

abortSignal?: AbortSignalLike

Hodnota vlastnosti

AbortSignalLike

baseUrl

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

baseUrl?: string

Hodnota vlastnosti

string

body

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

body?: any

Hodnota vlastnosti

any

bodyIsStream

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

bodyIsStream?: boolean

Hodnota vlastnosti

boolean

deserializationMapper

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

deserializationMapper?: object

Hodnota vlastnosti

object

disableClientRequestId

Pokud je nastavená hodnota true, dává klientovi pokyn, aby nenastavil hlavičku x-ms-client-request-id na nový identifikátor GUID().

disableClientRequestId?: boolean

Hodnota vlastnosti

boolean

disableJsonStringifyOnBody

Určuje, zda má tato metoda JSON.stringify() text požadavku. Výchozí hodnota: false.

disableJsonStringifyOnBody?: boolean

Hodnota vlastnosti

boolean

formData 

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

Hodnota vlastnosti

{[key: string]: any}

headers

Slovník hlaviček požadavků, které je potřeba použít na požadavek. 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 možnost options.bodyIsStream nastavená na hodnotu true, je ve výchozím nastavení nastavená hodnota "Transfer-Encoding" na hodnotu "bloked".
  • Vlastnost Content-Type je ve výchozím nastavení nastavená na application/octet-stream, pokud je parametr options.bodyIsStream nastavený na hodnotu true.
  • Ve výchozím nastavení je "accept-language" nastavena na "en-US"
  • Ve výchozím nastavení je parametr x-ms-client-request-id nastavený na nový identifikátor GUID. Pokud nechcete vygenerovat identifikátor GUID pro požadavek, nastavte 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 

onDownloadProgress?: (progress: TransferProgressEvent) => void

Hodnota vlastnosti

(progress: TransferProgressEvent) => void

onUploadProgress 

onUploadProgress?: (progress: TransferProgressEvent) => void

Hodnota vlastnosti

(progress: TransferProgressEvent) => void

pathParameters

Slovník parametrů cesty, které je potřeba nahradit skutečnými hodnotami v pathTemplate. Tady je klíč "path-parameter-name" a hodnota je "path-parameter-value". Hodnota path-parameter-value může být typu "string" nebo může být typu "object". Formát "object" by se měl použít, pokud chcete přeskočit kódování adresy URL. Při použití formátu objektu musí mít objekt vlastnost pojmenovanou hodnotu, 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. Zadejte "url" nebo zadejte "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 má připojit k adrese URL, kde "klíč" je "název parametru dotazu" a "hodnota" je "query-parameter-value". Parametr query-parameter-value může být typu "string" nebo může být typu "object". Formát "object" by se měl použít, pokud chcete přeskočit kódování adresy URL. Při použití formátu objektu musí mít objekt vlastnost pojmenovanou hodnotu, 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 options.url již obsahuje některé parametry dotazu, pak hodnota zadaná v options.queryParameters bude připojena k adrese URL.
queryParameters?: {[key: string]: any | ParameterValue}

Hodnota vlastnosti

{[key: string]: any | ParameterValue}

redirectLimit

Omezte počet přesměrování sledovaných pro tento požadavek. Pokud je nastavená hodnota 0, přesměrování nebude následovat. Pokud ponecháte nedefinované výchozí chování přesměrování podkladového node_fetch se použije.

redirectLimit?: number

Hodnota vlastnosti

number

serializationMapper

Poskytuje informace o tom, jak serializovat tělo požadavku.

serializationMapper?: Mapper

Hodnota vlastnosti

Mapper

streamResponseBody 

streamResponseBody?: boolean

Hodnota vlastnosti

boolean

url

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

url?: string

Hodnota vlastnosti

string