RequestPrepareOptions interface

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

Eigenschaften

abortSignal
baseUrl

Die Basis-URL der Anforderung. Standardwert: "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

Anforderungstext Es kann von einem beliebigen Typ sein. Dieser Wert wird serialisiert, wenn es sich nicht um einen Stream handelt.
bodyIsStream

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

Enthält Informationen zum Deserialisieren des Antworttexts.
disableClientRequestId

Weist den Client bei Festlegung auf true an, den Header "x-ms-client-request-id" nicht auf eine neue Guid() festzulegen.
disableJsonStringifyOnBody

Gibt an, ob diese Methode den Anforderungstext JSON.stringify() verwenden soll. Standardwert: False
formData
headers

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

  • ContentType muss mit dem Schlüsselnamen "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 von 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
onUploadProgress
pathParameters

Ein Wörterbuch mit Pfadparametern, die durch tatsächliche Werte in pathTemplate ersetzt werden müssen. Hier ist der Schlüssel "path-parameter-name" und der Wert ist der "path-parameter-value". Der Pfadparameterwert 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 namens value verfügen, die den "path-parameter-value" bereitstellt. Beispiel:

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

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

Ein Wörterbuch von Abfrageparametern, die an die URL angefügt werden sollen, wobei "key" der "query-parameter-name" und der "value" der "query-parameter-value" ist. Der "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 namens value verfügen, die den "query-parameter-value" bereitstellt. 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 angegebene Wert an die URL angefügt.
redirectLimit

Beschränken Sie die Anzahl der Umleitungen, die für diese Anforderung befolgt werden. Wenn dieser Wert auf 0 festgelegt ist, werden Umleitungen nicht befolgt. Wenn undefiniert bleibt, gilt das standardbasierte Umleitungsverhalten des zugrunde liegenden node_fetch.
serializationMapper

Enthält Informationen zum Serialisieren des Anforderungstexts.
streamResponseBody
url

Die Anforderungs-URL. Es kann Abfrageparameter enthalten oder nicht. Geben Sie entweder die "url" an, oder geben Sie die "pathTemplate" im options-Objekt an. Beide Optionen schließen sich gegenseitig aus.

Details zur Eigenschaft

abortSignal 

abortSignal?: AbortSignalLike

Eigenschaftswert

AbortSignalLike

baseUrl

Die Basis-URL der Anforderung. Standardwert: "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

Anforderungstext Es kann von einem beliebigen Typ sein. Dieser Wert wird serialisiert, wenn es sich nicht um einen Stream handelt.

body?: any

Eigenschaftswert

any

bodyIsStream

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

bodyIsStream?: boolean

Eigenschaftswert

boolean

deserializationMapper

Enthält Informationen zum Deserialisieren des Antworttexts.

deserializationMapper?: object

Eigenschaftswert

object

disableClientRequestId

Weist den Client bei Festlegung auf true 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() verwenden soll. Standardwert: False

disableJsonStringifyOnBody?: boolean

Eigenschaftswert

boolean

formData 

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 "header-name" und der Wert ist der "header-value". Der Headerwert MUSS vom Typ string sein.

  • ContentType muss mit dem Schlüsselnamen "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 von 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 

onDownloadProgress?: (progress: TransferProgressEvent) => void

Eigenschaftswert

(progress: TransferProgressEvent) => void

onUploadProgress 

onUploadProgress?: (progress: TransferProgressEvent) => void

Eigenschaftswert

(progress: TransferProgressEvent) => void

pathParameters

Ein Wörterbuch mit Pfadparametern, die durch tatsächliche Werte in pathTemplate ersetzt werden müssen. Hier ist der Schlüssel "path-parameter-name" und der Wert ist der "path-parameter-value". Der Pfadparameterwert 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 namens value verfügen, die den "path-parameter-value" bereitstellt. Beispiel:

  • path-parameter-value im "object"-Format: { "path-parameter-name": { value: "path-parameter-value", skipUrlEncoding: true } }
  • path-parameter-value im "string"-Format: { "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 options-Objekt 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 von Abfrageparametern, die an die URL angefügt werden sollen, wobei "key" der "query-parameter-name" und der "value" der "query-parameter-value" ist. Der "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 namens value verfügen, die den "query-parameter-value" bereitstellt. 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 angegebene Wert an die URL angefügt.
queryParameters?: {[key: string]: any | ParameterValue}

Eigenschaftswert

{[key: string]: any | ParameterValue}

redirectLimit

Beschränken Sie die Anzahl der Umleitungen, die für diese Anforderung befolgt werden. Wenn dieser Wert auf 0 festgelegt ist, werden Umleitungen nicht befolgt. Wenn undefiniert bleibt, gilt das standardbasierte Umleitungsverhalten des zugrunde liegenden node_fetch.

redirectLimit?: number

Eigenschaftswert

number

serializationMapper

Enthält Informationen zum Serialisieren des Anforderungstexts.

serializationMapper?: Mapper

Eigenschaftswert

Mapper

streamResponseBody 

streamResponseBody?: boolean

Eigenschaftswert

boolean

url

Die Anforderungs-URL. Es kann Abfrageparameter enthalten oder nicht. Geben Sie entweder die "url" an, oder geben Sie die "pathTemplate" im options-Objekt an. Beide Optionen schließen sich gegenseitig aus.

url?: string

Eigenschaftswert

string