RequestPrepareOptions interface

abortSignal?: AbortSignalLike

Egenskapsvärde

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

baseUrl?: string

Egenskapsvärde

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

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

bodyIsStream?: boolean

Egenskapsvärde

Innehåller information om hur du deserialiserar svarstexten.

deserializationMapper?: object

Egenskapsvärde

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

disableClientRequestId?: boolean

Egenskapsvärde

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

disableJsonStringifyOnBody?: boolean

Egenskapsvärde

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

Egenskapsvärde

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å sant.
• "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

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

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

Egenskapsvärde

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

method: HttpMethods

Egenskapsvärde

onDownloadProgress?: (progress: TransferProgressEvent) => void

Egenskapsvärde

onUploadProgress?: (progress: TransferProgressEvent) => void

Egenskapsvärde

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 "objekt" ska användas när du vill hoppa över URL-kodning. När objektet använder objektformatet måste det 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

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

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 "sträng" eller av typen "objekt". Formatet "objekt" ska användas när du vill hoppa över URL-kodning. När objektet använder objektformatet måste det 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 som anges i options.queryParameters till i URL:en.

queryParameters?: {[key: string]: any | ParameterValue}

Egenskapsvärde

Begränsa antalet omdirigeringar som följs för den här begäran. Om värdet är 0 följs inte omdirigeringar. Om den lämnas odefinierad tillämpas standardomdirigeringsbeteendet för den underliggande node_fetch.

redirectLimit?: number

Egenskapsvärde

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

serializationMapper?: Mapper

Egenskapsvärde

streamResponseBody?: boolean

Egenskapsvärde

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

url?: string

Egenskapsvärde