Delen via

RequestPrepareOptions interface

  • Referentie
Pakket:
@azure/core-http

Opties voor het voorbereiden van een uitgaande HTTP-aanvraag.

Eigenschappen

abortSignal

Signaal van een afgebroken controller. Kan worden gebruikt om zowel het verzenden van een netwerkaanvraag als het wachten op een antwoord af te breken.
baseUrl

De basis-URL van de aanvraag. De standaardwaarde is: "https://management.azure.com". Dit is alleen van toepassing met pathTemplate. Als u options.url opgeeft, wordt verwacht dat u de volledige URL opgeeft.
body

De hoofdtekst van de aanvraag. Het kan van elk type zijn. Deze waarde wordt geserialiseerd als het geen stroom is.
bodyIsStream

Geeft aan of de aanvraagbody een stroom is (handig voor scenario's voor het uploaden van bestanden).
deserializationMapper

Bevat informatie over het deserialiseren van de hoofdtekst van het antwoord.
disableClientRequestId

Als deze optie is ingesteld op true, wordt de client geïnstrueerd om de header 'x-ms-client-request-id' niet in te stellen op een nieuwe Guid().
disableJsonStringifyOnBody

Geeft aan of deze methode JSON.stringify() de aanvraagbody moet gebruiken. Standaardwaarde: false.
formData

Formuliergegevens, die worden gebruikt om de aanvraagbody te maken.
headers

Een woordenlijst met aanvraagheaders die moeten worden toegepast op de aanvraag. Hier is de sleutel de 'header-name' en de waarde is de 'header-value'. De header-waarde MOET van het type tekenreeks zijn.

  • ContentType moet worden opgegeven met de sleutelnaam als 'Content-Type'. Standaardwaarde 'application/json; charset=utf-8".
  • 'Transfer-Encoding' is standaard ingesteld op 'chunked' als 'options.bodyIsStream' is ingesteld op true.
  • 'Content-Type' is standaard ingesteld op 'application/octet-stream' als 'options.bodyIsStream' is ingesteld op true.
  • 'accept-language' is standaard ingesteld op 'en-US'
  • 'x-ms-client-request-id' is standaard ingesteld op een nieuwe GUID. Als u geen GUID voor de aanvraag wilt genereren, stelt u options.disableClientRequestId in op true
mappers

Een woordenlijst met mappers die kan worden gebruikt tijdens [de]serialisatie.
method

De HTTP-aanvraagmethode. Geldige waarden zijn 'GET', 'PUT', 'HEAD', 'DELETE', 'OPTIONS', 'POST' of 'PATCH'.
onDownloadProgress

Hiermee kunt u de voortgang van het downloaden van het binnenkomende antwoord bijhouden.
onUploadProgress

Hiermee kunt u de voortgang van het uploaden van de uitgaande aanvraag bijhouden.
pathParameters

Een woordenlijst met padparameters die moeten worden vervangen door werkelijke waarden in pathTemplate. Hier is de sleutel de 'path-parameter-name' en de waarde is de 'path-parameter-value'. De 'path-parameter-value' kan van het type 'tekenreeks' zijn of van het type 'object'. De indeling 'object' moet worden gebruikt wanneer u URL-codering wilt overslaan. Wanneer u de objectindeling gebruikt, moet het object een eigenschap met de naam waarde hebben die de 'path-parameter-value' biedt. Voorbeeld:

  • path-parameter-value in objectindeling: { "path-parameter-name": { value: "path-parameter-value", skipUrlEncoding: true } }
  • path-parameter-value in tekenreeksindeling: { "path-parameter-name": "path-parameter-value" }.
pathTemplate

De padsjabloon van de aanvraag-URL. Geef de 'url' op of geef de 'pathTemplate' op in het object options. Beide opties sluiten elkaar uit. Voorbeeld: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}
queryParameters

Een woordenlijst met queryparameters die moeten worden toegevoegd aan de URL, waarbij de 'sleutel' de 'query-parameter-name' is en de 'waarde' de 'query-parameter-value'. De 'query-parameter-value' kan van het type 'tekenreeks' zijn of van het type 'object'. De indeling 'object' moet worden gebruikt wanneer u URL-codering wilt overslaan. Wanneer u de objectindeling gebruikt, moet het object een eigenschap met de naam waarde hebben die de 'query-parameter-value' biedt. Voorbeeld:

  • query-parameter-value in objectindeling: { "query-parameter-name": { value: "query-parameter-value", skipUrlEncoding: true } }
  • query-parameter-value in tekenreeksindeling: { "query-parameter-name": "query-parameter-value"}. Opmerking: 'Als options.url al enkele queryparameters heeft, wordt de waarde in options.queryParameters toegevoegd aan de URL.
serializationMapper

Biedt informatie over het serialiseren van de aanvraagbody.
spanOptions

Tracering: opties die worden gebruikt om een span te maken wanneer tracering is ingeschakeld.
tracingContext

Tracering: Context die wordt gebruikt bij het maken van spans.
url

De aanvraag-URL. Het kan al dan niet queryparameters bevatten. Geef de 'url' op of geef de 'pathTemplate' op in het object options. Beide opties sluiten elkaar uit.

Eigenschapdetails

abortSignal

Signaal van een afgebroken controller. Kan worden gebruikt om zowel het verzenden van een netwerkaanvraag als het wachten op een antwoord af te breken.

abortSignal?: AbortSignalLike

Waarde van eigenschap

AbortSignalLike

baseUrl

De basis-URL van de aanvraag. De standaardwaarde is: "https://management.azure.com". Dit is alleen van toepassing met pathTemplate. Als u options.url opgeeft, wordt verwacht dat u de volledige URL opgeeft.

baseUrl?: string

Waarde van eigenschap

string

body

De hoofdtekst van de aanvraag. Het kan van elk type zijn. Deze waarde wordt geserialiseerd als het geen stroom is.

body?: any

Waarde van eigenschap

any

bodyIsStream

Geeft aan of de aanvraagbody een stroom is (handig voor scenario's voor het uploaden van bestanden).

bodyIsStream?: boolean

Waarde van eigenschap

boolean

deserializationMapper

Bevat informatie over het deserialiseren van de hoofdtekst van het antwoord.

deserializationMapper?: Record<string, unknown>

Waarde van eigenschap

Record<string, unknown>

disableClientRequestId

Als deze optie is ingesteld op true, wordt de client geïnstrueerd om de header 'x-ms-client-request-id' niet in te stellen op een nieuwe Guid().

disableClientRequestId?: boolean

Waarde van eigenschap

boolean

disableJsonStringifyOnBody

Geeft aan of deze methode JSON.stringify() de aanvraagbody moet gebruiken. Standaardwaarde: false.

disableJsonStringifyOnBody?: boolean

Waarde van eigenschap

boolean

formData

Formuliergegevens, die worden gebruikt om de aanvraagbody te maken.

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

Waarde van eigenschap

{[key: string]: any}

headers

Een woordenlijst met aanvraagheaders die moeten worden toegepast op de aanvraag. Hier is de sleutel de 'header-name' en de waarde is de 'header-value'. De header-waarde MOET van het type tekenreeks zijn.

  • ContentType moet worden opgegeven met de sleutelnaam als 'Content-Type'. Standaardwaarde 'application/json; charset=utf-8".
  • 'Transfer-Encoding' is standaard ingesteld op 'chunked' als 'options.bodyIsStream' is ingesteld op true.
  • 'Content-Type' is standaard ingesteld op 'application/octet-stream' als 'options.bodyIsStream' is ingesteld op true.
  • 'accept-language' is standaard ingesteld op 'en-US'
  • 'x-ms-client-request-id' is standaard ingesteld op een nieuwe GUID. Als u geen GUID voor de aanvraag wilt genereren, stelt u options.disableClientRequestId in op true
headers?: {[key: string]: any}

Waarde van eigenschap

{[key: string]: any}

mappers

Een woordenlijst met mappers die kan worden gebruikt tijdens [de]serialisatie.

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

Waarde van eigenschap

{[x: string]: any}

method

De HTTP-aanvraagmethode. Geldige waarden zijn 'GET', 'PUT', 'HEAD', 'DELETE', 'OPTIONS', 'POST' of 'PATCH'.

method: HttpMethods

Waarde van eigenschap

HttpMethods

onDownloadProgress

Hiermee kunt u de voortgang van het downloaden van het binnenkomende antwoord bijhouden.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Waarde van eigenschap

(progress: TransferProgressEvent) => void

onUploadProgress

Hiermee kunt u de voortgang van het uploaden van de uitgaande aanvraag bijhouden.

onUploadProgress?: (progress: TransferProgressEvent) => void

Waarde van eigenschap

(progress: TransferProgressEvent) => void

pathParameters

Een woordenlijst met padparameters die moeten worden vervangen door werkelijke waarden in pathTemplate. Hier is de sleutel de 'path-parameter-name' en de waarde is de 'path-parameter-value'. De 'path-parameter-value' kan van het type 'tekenreeks' zijn of van het type 'object'. De indeling 'object' moet worden gebruikt wanneer u URL-codering wilt overslaan. Wanneer u de objectindeling gebruikt, moet het object een eigenschap met de naam waarde hebben die de 'path-parameter-value' biedt. Voorbeeld:

  • path-parameter-value in objectindeling: { "path-parameter-name": { value: "path-parameter-value", skipUrlEncoding: true } }
  • path-parameter-value in tekenreeksindeling: { "path-parameter-name": "path-parameter-value" }.
pathParameters?: {[key: string]: any | ParameterValue}

Waarde van eigenschap

{[key: string]: any | ParameterValue}

pathTemplate

De padsjabloon van de aanvraag-URL. Geef de 'url' op of geef de 'pathTemplate' op in het object options. Beide opties sluiten elkaar uit. Voorbeeld: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}

pathTemplate?: string

Waarde van eigenschap

string

queryParameters

Een woordenlijst met queryparameters die moeten worden toegevoegd aan de URL, waarbij de 'sleutel' de 'query-parameter-name' is en de 'waarde' de 'query-parameter-value'. De 'query-parameter-value' kan van het type 'tekenreeks' zijn of van het type 'object'. De indeling 'object' moet worden gebruikt wanneer u URL-codering wilt overslaan. Wanneer u de objectindeling gebruikt, moet het object een eigenschap met de naam waarde hebben die de 'query-parameter-value' biedt. Voorbeeld:

  • query-parameter-value in objectindeling: { "query-parameter-name": { value: "query-parameter-value", skipUrlEncoding: true } }
  • query-parameter-value in tekenreeksindeling: { "query-parameter-name": "query-parameter-value"}. Opmerking: 'Als options.url al enkele queryparameters heeft, wordt de waarde in options.queryParameters toegevoegd aan de URL.
queryParameters?: {[key: string]: any | ParameterValue}

Waarde van eigenschap

{[key: string]: any | ParameterValue}

serializationMapper

Biedt informatie over het serialiseren van de aanvraagbody.

serializationMapper?: Mapper

Waarde van eigenschap

Mapper

spanOptions

Tracering: opties die worden gebruikt om een span te maken wanneer tracering is ingeschakeld.

spanOptions?: SpanOptions

Waarde van eigenschap

@azure/core-tracing.SpanOptions

tracingContext

Tracering: Context die wordt gebruikt bij het maken van spans.

tracingContext?: Context

Waarde van eigenschap

@azure/core-tracing.Context

url

De aanvraag-URL. Het kan al dan niet queryparameters bevatten. Geef de 'url' op of geef de 'pathTemplate' op in het object options. Beide opties sluiten elkaar uit.

url?: string

Waarde van eigenschap

string