Dela via

RequestPrepareOptions interface

  • Referens
Paket:
@azure/ms-rest-js

Egenskaper

abortSignal
baseUrl

Bas-URL:en för begäran. Standardvärdet är: "https://management.azure.com". Detta gäller endast för pathTemplate. Om du tillhandahåller options.url förväntas du ange den fullständiga URL:en.
body

Begärandetexten. Det kan vara av vilken typ som helst. Det här värdet serialiseras om det inte är en ström.
bodyIsStream

Anger om begärandetexten är en ström (användbart för filuppladdningsscenarier).
deserializationMapper

Innehåller information om hur du deserialiserar svarstexten.
disableClientRequestId

När värdet är true instruerar du klienten att inte ange rubriken "x-ms-client-request-id" till ett nytt Guid().
disableJsonStringifyOnBody

Anger om den här metoden ska JSON.stringify() begärandetexten. Standardvärde: false.
formData
headers

En ordlista med begärandehuvuden som måste tillämpas på begäran. Här är nyckeln "header-name" och värdet är "header-value". Huvudvärdet MÅSTE vara av typen sträng.

  • ContentType måste anges med nyckelnamnet som "Innehållstyp". Standardvärdet "application/json; charset=utf-8".
  • "Transfer-Encoding" är inställt på "segmenterad" som standard om "options.bodyIsStream" är inställt på true.
  • "Content-Type" är inställt på "application/octet-stream" som standard om "options.bodyIsStream" är inställt på true.
  • "accept-language" är som standard inställt på "en-US"
  • "x-ms-client-request-id" är som standard inställt på ett nytt guid. Om du inte vill generera ett guid för begäran anger du options.disableClientRequestId till true
mappers

En ordlista med mappare som kan användas under [de]serialisering.
method

HTTP-begärandemetoden. Giltiga värden är "GET", "PUT", "HEAD", "DELETE", "OPTIONS", "POST" eller "PATCH".
onDownloadProgress
onUploadProgress
pathParameters

En ordlista med sökvägsparametrar som måste ersättas med faktiska värden i pathTemplate. Här är nyckeln "path-parameter-name" och värdet är "path-parameter-value". "path-parameter-value" kan vara av typen "sträng" eller så kan det vara av typen "objekt". Formatet "object" ska användas när du vill hoppa över URL-kodning. När objektformatet används måste objektet ha en egenskap med namnet value som tillhandahåller "path-parameter-value". Exempel:

  • path-parameter-value i "object"-format: { "path-parameter-name": { value: "path-parameter-value", skipUrlEncoding: true } }
  • path-parameter-value i "string"-format: { "path-parameter-name": "path-parameter-value" }.
pathTemplate

Sökvägsmallen för begärande-URL:en. Ange antingen "url" eller ange "pathTemplate" i alternativobjektet. Båda alternativen är ömsesidigt uteslutande. Exempel: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}"
queryParameters

En ordlista med frågeparametrar som ska läggas till i URL:en, där "nyckeln" är "query-parameter-name" och "value" är "query-parameter-value". "query-parameter-value" kan vara av typen "string" eller så kan det vara av typen "object". Formatet "object" ska användas när du vill hoppa över URL-kodning. När objektformatet används måste objektet ha en egenskap med namnet value som tillhandahåller "query-parameter-value". Exempel:

  • query-parameter-value i "object"-format: { "query-parameter-name": { value: "query-parameter-value", skipUrlEncoding: true } }
  • query-parameter-value i "string"-format: { "query-parameter-name": "query-parameter-value"}. Obs! "Om options.url redan har några frågeparametrar läggs värdet i options.queryParameters till i URL:en.
redirectLimit

Begränsa antalet omdirigeringar som följs för den här begäran. Om värdet är 0 följs inte omdirigeringar. Om det lämnas odefinierat gäller standardomdirigeringsbeteendet för den underliggande node_fetch.
serializationMapper

Innehåller information om hur du serialiserar begärandetexten.
streamResponseBody
url

Begärande-URL:en. Den kanske har frågeparametrar i den. Ange antingen "url" eller ange "pathTemplate" i alternativobjektet. Båda alternativen är ömsesidigt uteslutande.

Egenskapsinformation

abortSignal 

abortSignal?: AbortSignalLike

Egenskapsvärde

AbortSignalLike

baseUrl

Bas-URL:en för begäran. Standardvärdet är: "https://management.azure.com". Detta gäller endast för pathTemplate. Om du tillhandahåller options.url förväntas du ange den fullständiga URL:en.

baseUrl?: string

Egenskapsvärde

string

body

Begärandetexten. Det kan vara av vilken typ som helst. Det här värdet serialiseras om det inte är en ström.

body?: any

Egenskapsvärde

any

bodyIsStream

Anger om begärandetexten är en ström (användbart för filuppladdningsscenarier).

bodyIsStream?: boolean

Egenskapsvärde

boolean

deserializationMapper

Innehåller information om hur du deserialiserar svarstexten.

deserializationMapper?: object

Egenskapsvärde

object

disableClientRequestId

När värdet är true instruerar du klienten att inte ange rubriken "x-ms-client-request-id" till ett nytt Guid().

disableClientRequestId?: boolean

Egenskapsvärde

boolean

disableJsonStringifyOnBody

Anger om den här metoden ska JSON.stringify() begärandetexten. Standardvärde: false.

disableJsonStringifyOnBody?: boolean

Egenskapsvärde

boolean

formData 

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

Egenskapsvärde

{[key: string]: any}

headers

En ordlista med begärandehuvuden som måste tillämpas på begäran. Här är nyckeln "header-name" och värdet är "header-value". Huvudvärdet MÅSTE vara av typen sträng.

  • ContentType måste anges med nyckelnamnet som "Innehållstyp". Standardvärdet "application/json; charset=utf-8".
  • "Transfer-Encoding" är inställt på "segmenterad" som standard om "options.bodyIsStream" är inställt på true.
  • "Content-Type" är inställt på "application/octet-stream" som standard om "options.bodyIsStream" är inställt på true.
  • "accept-language" är som standard inställt på "en-US"
  • "x-ms-client-request-id" är som standard inställt på ett nytt guid. Om du inte vill generera ett guid för begäran anger du options.disableClientRequestId till true
headers?: {[key: string]: any}

Egenskapsvärde

{[key: string]: any}

mappers

En ordlista med mappare som kan användas under [de]serialisering.

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

Egenskapsvärde

{[x: string]: any}

method

HTTP-begärandemetoden. Giltiga värden är "GET", "PUT", "HEAD", "DELETE", "OPTIONS", "POST" eller "PATCH".

method: HttpMethods

Egenskapsvärde

HttpMethods

onDownloadProgress 

onDownloadProgress?: (progress: TransferProgressEvent) => void

Egenskapsvärde

(progress: TransferProgressEvent) => void

onUploadProgress 

onUploadProgress?: (progress: TransferProgressEvent) => void

Egenskapsvärde

(progress: TransferProgressEvent) => void

pathParameters

En ordlista med sökvägsparametrar som måste ersättas med faktiska värden i pathTemplate. Här är nyckeln "path-parameter-name" och värdet är "path-parameter-value". "path-parameter-value" kan vara av typen "sträng" eller så kan det vara av typen "objekt". Formatet "object" ska användas när du vill hoppa över URL-kodning. När objektformatet används måste objektet ha en egenskap med namnet value som tillhandahåller "path-parameter-value". Exempel:

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

Egenskapsvärde

{[key: string]: any | ParameterValue}

pathTemplate

Sökvägsmallen för begärande-URL:en. Ange antingen "url" eller ange "pathTemplate" i alternativobjektet. Båda alternativen är ömsesidigt uteslutande. Exempel: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}"

pathTemplate?: string

Egenskapsvärde

string

queryParameters

En ordlista med frågeparametrar som ska läggas till i URL:en, där "nyckeln" är "query-parameter-name" och "value" är "query-parameter-value". "query-parameter-value" kan vara av typen "string" eller så kan det vara av typen "object". Formatet "object" ska användas när du vill hoppa över URL-kodning. När objektformatet används måste objektet ha en egenskap med namnet value som tillhandahåller "query-parameter-value". Exempel:

  • query-parameter-value i "object"-format: { "query-parameter-name": { value: "query-parameter-value", skipUrlEncoding: true } }
  • query-parameter-value i "string"-format: { "query-parameter-name": "query-parameter-value"}. Obs! "Om options.url redan har några frågeparametrar läggs värdet i options.queryParameters till i URL:en.
queryParameters?: {[key: string]: any | ParameterValue}

Egenskapsvärde

{[key: string]: any | ParameterValue}

redirectLimit

Begränsa antalet omdirigeringar som följs för den här begäran. Om värdet är 0 följs inte omdirigeringar. Om det lämnas odefinierat gäller standardomdirigeringsbeteendet för den underliggande node_fetch.

redirectLimit?: number

Egenskapsvärde

number

serializationMapper

Innehåller information om hur du serialiserar begärandetexten.

serializationMapper?: Mapper

Egenskapsvärde

Mapper

streamResponseBody 

streamResponseBody?: boolean

Egenskapsvärde

boolean

url

Begärande-URL:en. Den kanske har frågeparametrar i den. Ange antingen "url" eller ange "pathTemplate" i alternativobjektet. Båda alternativen är ömsesidigt uteslutande.

url?: string

Egenskapsvärde

string