Freigeben über

RequestPrepareOptions interface

  • Referenz
Paket:
@azure/core-http

Optionen zum Vorbereiten einer ausgehenden HTTP-Anforderung.

Eigenschaften

abortSignal

Signal eines abgebrochenen Controllers. Kann verwendet werden, um sowohl das Senden einer Netzwerkanforderung als auch das Warten auf eine Antwort abzubrechen.
baseUrl

Die Basis-URL der Anforderung. Standardwert ist: "https://management.azure.com". Dies gilt nur für pathTemplate. Wenn Sie "options.url" angeben, wird erwartet, dass Sie die vollständige URL angeben.
body

Der Anforderungstext. Er kann beliebiger Art sein. Dieser Wert wird serialisiert, wenn es sich nicht um einen Datenstrom handelt.
bodyIsStream

Gibt an, ob der Anforderungstext ein Datenstrom ist (nützlich für Dateiuploadszenarien).
deserializationMapper

Enthält Informationen zum Deserialisieren des Antworttexts.
disableClientRequestId

Wenn dieser wert auf "true" festgelegt ist, weist der Client an, den Header "x-ms-client-request-id" nicht auf eine neue Guid() festzulegen.
disableJsonStringifyOnBody

Gibt an, ob diese Methode den Anforderungstext JSON.stringify() aufweisen soll. Standardwert: false.
formData

Formulardaten, die zum Erstellen des Anforderungstexts verwendet werden.
headers

Ein Wörterbuch mit Anforderungsheadern, die auf die Anforderung angewendet werden müssen. Hier ist der Schlüssel der "Headername", und der Wert ist der "header-value". Der Headerwert MUSS vom Typ Zeichenfolge sein.

  • ContentType muss mit dem Schlüsselnamen als "Content-Type" angegeben werden. Standardwert "application/json; charset=utf-8".
  • "Transfer-Encoding" ist standardmäßig auf "chunked" festgelegt, wenn "options.bodyIsStream" auf "true" festgelegt ist.
  • "Content-Type" ist standardmäßig auf "application/octet-stream" festgelegt, wenn "options.bodyIsStream" auf "true" festgelegt ist.
  • "accept-language" ist standardmäßig auf "en-US" festgelegt.
  • "x-ms-client-request-id" ist standardmäßig auf eine neue GUID festgelegt. Um keine GUID für die Anforderung zu generieren, legen Sie "options.disableClientRequestId" auf "true" fest.
mappers

Ein Wörterbuch mit Mappern, die während der [de]Serialisierung verwendet werden können.
method

Die HTTP-Anforderungsmethode. Gültige Werte sind "GET", "PUT", "HEAD", "DELETE", "OPTIONS", "POST" oder "PATCH".
onDownloadProgress

Ermöglicht das Nachverfolgen des Fortschritts des Herunterladens der eingehenden Antwort.
onUploadProgress

Ermöglicht das Nachverfolgen des Fortschritts des Hochladens der ausgehenden Anforderung.
pathParameters

Ein Wörterbuch mit Pfadparametern, die durch tatsächliche Werte in der pathTemplate ersetzt werden müssen. Hier ist der Schlüssel der "Pfadparametername", und der Wert ist der "path-parameter-value". Der "path-parameter-value" kann vom Typ "string" sein oder vom Typ "object" sein. Das Format "object" sollte verwendet werden, wenn Sie die URL-Codierung überspringen möchten. Bei Verwendung des Objektformats muss das Objekt über eine Eigenschaft mit dem Namen "path-parameter-value" verfügen. Beispiel:

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

Die Pfadvorlage der Anforderungs-URL. Geben Sie entweder die "url" an, oder geben Sie die "pathTemplate" im Optionsobjekt an. Beide Optionen schließen sich gegenseitig aus. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}
queryParameters

Ein Wörterbuch mit Abfrageparametern, das an die URL angefügt werden soll, wobei "key" der "query-parameter-name" ist, und der "Wert" der "query-parameter-value". Der Wert "query-parameter-value" kann vom Typ "string" oder vom Typ "object" sein. Das Format "object" sollte verwendet werden, wenn Sie die URL-Codierung überspringen möchten. Bei Verwendung des Objektformats muss das Objekt über eine Eigenschaft mit dem Namen "query-parameter-value" verfügen. Beispiel:

  • query-parameter-value im "object"-Format: { "query-parameter-name": { value: "query-parameter-value", skipUrlEncoding: true } }
  • query-parameter-value im Format "string": { "query-parameter-name": "query-parameter-value"}. Hinweis: "Wenn options.url bereits einige Abfrageparameter enthält, wird der in options.queryParameters bereitgestellte Wert an die URL angefügt.
serializationMapper

Enthält Informationen zum Serialisieren des Anforderungstexts.
spanOptions

Ablaufverfolgung: Optionen zum Erstellen einer Spanne, wenn die Ablaufverfolgung aktiviert ist.
tracingContext

Ablaufverfolgung: Kontext, der beim Erstellen von Spans verwendet wird.
url

Die Anforderungs-URL. Er enthält möglicherweise Abfrageparameter. Geben Sie entweder die "url" an, oder geben Sie die "pathTemplate" im Optionsobjekt an. Beide Optionen schließen sich gegenseitig aus.

Details zur Eigenschaft

abortSignal

Signal eines abgebrochenen Controllers. Kann verwendet werden, um sowohl das Senden einer Netzwerkanforderung als auch das Warten auf eine Antwort abzubrechen.

abortSignal?: AbortSignalLike

Eigenschaftswert

AbortSignalLike

baseUrl

Die Basis-URL der Anforderung. Standardwert ist: "https://management.azure.com". Dies gilt nur für pathTemplate. Wenn Sie "options.url" angeben, wird erwartet, dass Sie die vollständige URL angeben.

baseUrl?: string

Eigenschaftswert

string

body

Der Anforderungstext. Er kann beliebiger Art sein. Dieser Wert wird serialisiert, wenn es sich nicht um einen Datenstrom handelt.

body?: any

Eigenschaftswert

any

bodyIsStream

Gibt an, ob der Anforderungstext ein Datenstrom ist (nützlich für Dateiuploadszenarien).

bodyIsStream?: boolean

Eigenschaftswert

boolean

deserializationMapper

Enthält Informationen zum Deserialisieren des Antworttexts.

deserializationMapper?: Record<string, unknown>

Eigenschaftswert

Record<string, unknown>

disableClientRequestId

Wenn dieser wert auf "true" festgelegt ist, weist der Client an, den Header "x-ms-client-request-id" nicht auf eine neue Guid() festzulegen.

disableClientRequestId?: boolean

Eigenschaftswert

boolean

disableJsonStringifyOnBody

Gibt an, ob diese Methode den Anforderungstext JSON.stringify() aufweisen soll. Standardwert: false.

disableJsonStringifyOnBody?: boolean

Eigenschaftswert

boolean

formData

Formulardaten, die zum Erstellen des Anforderungstexts verwendet werden.

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

Eigenschaftswert

{[key: string]: any}

headers

Ein Wörterbuch mit Anforderungsheadern, die auf die Anforderung angewendet werden müssen. Hier ist der Schlüssel der "Headername", und der Wert ist der "header-value". Der Headerwert MUSS vom Typ Zeichenfolge sein.

  • ContentType muss mit dem Schlüsselnamen als "Content-Type" angegeben werden. Standardwert "application/json; charset=utf-8".
  • "Transfer-Encoding" ist standardmäßig auf "chunked" festgelegt, wenn "options.bodyIsStream" auf "true" festgelegt ist.
  • "Content-Type" ist standardmäßig auf "application/octet-stream" festgelegt, wenn "options.bodyIsStream" auf "true" festgelegt ist.
  • "accept-language" ist standardmäßig auf "en-US" festgelegt.
  • "x-ms-client-request-id" ist standardmäßig auf eine neue GUID festgelegt. Um keine GUID für die Anforderung zu generieren, legen Sie "options.disableClientRequestId" auf "true" fest.
headers?: {[key: string]: any}

Eigenschaftswert

{[key: string]: any}

mappers

Ein Wörterbuch mit Mappern, die während der [de]Serialisierung verwendet werden können.

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

Eigenschaftswert

{[x: string]: any}

method

Die HTTP-Anforderungsmethode. Gültige Werte sind "GET", "PUT", "HEAD", "DELETE", "OPTIONS", "POST" oder "PATCH".

method: HttpMethods

Eigenschaftswert

HttpMethods

onDownloadProgress

Ermöglicht das Nachverfolgen des Fortschritts des Herunterladens der eingehenden Antwort.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Eigenschaftswert

(progress: TransferProgressEvent) => void

onUploadProgress

Ermöglicht das Nachverfolgen des Fortschritts des Hochladens der ausgehenden Anforderung.

onUploadProgress?: (progress: TransferProgressEvent) => void

Eigenschaftswert

(progress: TransferProgressEvent) => void

pathParameters

Ein Wörterbuch mit Pfadparametern, die durch tatsächliche Werte in der pathTemplate ersetzt werden müssen. Hier ist der Schlüssel der "Pfadparametername", und der Wert ist der "path-parameter-value". Der "path-parameter-value" kann vom Typ "string" sein oder vom Typ "object" sein. Das Format "object" sollte verwendet werden, wenn Sie die URL-Codierung überspringen möchten. Bei Verwendung des Objektformats muss das Objekt über eine Eigenschaft mit dem Namen "path-parameter-value" verfügen. Beispiel:

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

Eigenschaftswert

{[key: string]: any | ParameterValue}

pathTemplate

Die Pfadvorlage der Anforderungs-URL. Geben Sie entweder die "url" an, oder geben Sie die "pathTemplate" im Optionsobjekt an. Beide Optionen schließen sich gegenseitig aus. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}

pathTemplate?: string

Eigenschaftswert

string

queryParameters

Ein Wörterbuch mit Abfrageparametern, das an die URL angefügt werden soll, wobei "key" der "query-parameter-name" ist, und der "Wert" der "query-parameter-value". Der Wert "query-parameter-value" kann vom Typ "string" oder vom Typ "object" sein. Das Format "object" sollte verwendet werden, wenn Sie die URL-Codierung überspringen möchten. Bei Verwendung des Objektformats muss das Objekt über eine Eigenschaft mit dem Namen "query-parameter-value" verfügen. Beispiel:

  • query-parameter-value im "object"-Format: { "query-parameter-name": { value: "query-parameter-value", skipUrlEncoding: true } }
  • query-parameter-value im Format "string": { "query-parameter-name": "query-parameter-value"}. Hinweis: "Wenn options.url bereits einige Abfrageparameter enthält, wird der in options.queryParameters bereitgestellte Wert an die URL angefügt.
queryParameters?: {[key: string]: any | ParameterValue}

Eigenschaftswert

{[key: string]: any | ParameterValue}

serializationMapper

Enthält Informationen zum Serialisieren des Anforderungstexts.

serializationMapper?: Mapper

Eigenschaftswert

Mapper

spanOptions

Ablaufverfolgung: Optionen zum Erstellen einer Spanne, wenn die Ablaufverfolgung aktiviert ist.

spanOptions?: SpanOptions

Eigenschaftswert

@azure/core-tracing.SpanOptions

tracingContext

Ablaufverfolgung: Kontext, der beim Erstellen von Spans verwendet wird.

tracingContext?: Context

Eigenschaftswert

@azure/core-tracing.Context

url

Die Anforderungs-URL. Er enthält möglicherweise Abfrageparameter. Geben Sie entweder die "url" an, oder geben Sie die "pathTemplate" im Optionsobjekt an. Beide Optionen schließen sich gegenseitig aus.

url?: string

Eigenschaftswert

string