Delen via

RequestPrepareOptions interface

  • Referentie
Pakket:
@azure/ms-rest-js

Eigenschappen

abortSignal
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 deze geen stream 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, geeft de client de opdracht om de header 'x-ms-client-request-id' niet in te stellen op een nieuwe Guid().
disableJsonStringifyOnBody

Hiermee wordt aangegeven of deze methode JSON.stringify() de hoofdtekst van de aanvraag moet zijn. Standaardwaarde: onwaar.
formData
headers

Een woordenlijst met aanvraagheaders die op de aanvraag moeten worden toegepast. 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 van mappers die kunnen worden gebruikt tijdens [de]serialisatie.
method

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

Een woordenlijst met padparameters die moeten worden vervangen door werkelijke waarden in de 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. Tijdens het gebruik van de objectindeling moet het object een eigenschap met de naamwaarde hebben die de path-parameter-value levert. Voorbeeld:

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

De padsjabloon van de aanvraag-URL. Geef de URL op of geef het pathTemplate op in het optiesobject. Beide opties sluiten elkaar wederzijds 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 kan van het type 'object' zijn. De indeling 'object' moet worden gebruikt wanneer u url-codering wilt overslaan. Tijdens het gebruik van de objectindeling moet het object een eigenschap met de naamwaarde hebben die de 'query-parameter-value' levert. 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 een aantal queryparameters heeft, wordt de waarde in options.queryParameters toegevoegd aan de URL.
redirectLimit

Beperk het aantal omleidingen dat wordt gevolgd voor deze aanvraag. Als deze optie is ingesteld op 0, worden omleidingen niet gevolgd. Als het standaardomleidingsgedrag van de onderliggende node_fetch ongewijzigd blijft, is dit van toepassing.
serializationMapper

Bevat informatie over het serialiseren van de aanvraagbody.
streamResponseBody
url

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

Eigenschapdetails

abortSignal 

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 deze geen stream 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?: object

Waarde van eigenschap

object

disableClientRequestId

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

disableClientRequestId?: boolean

Waarde van eigenschap

boolean

disableJsonStringifyOnBody

Hiermee wordt aangegeven of deze methode JSON.stringify() de hoofdtekst van de aanvraag moet zijn. Standaardwaarde: onwaar.

disableJsonStringifyOnBody?: boolean

Waarde van eigenschap

boolean

formData 

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

Waarde van eigenschap

{[key: string]: any}

headers

Een woordenlijst met aanvraagheaders die op de aanvraag moeten worden toegepast. 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 van mappers die kunnen 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 

onDownloadProgress?: (progress: TransferProgressEvent) => void

Waarde van eigenschap

(progress: TransferProgressEvent) => void

onUploadProgress 

onUploadProgress?: (progress: TransferProgressEvent) => void

Waarde van eigenschap

(progress: TransferProgressEvent) => void

pathParameters

Een woordenlijst met padparameters die moeten worden vervangen door werkelijke waarden in de 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. Tijdens het gebruik van de objectindeling moet het object een eigenschap met de naamwaarde hebben die de path-parameter-value levert. Voorbeeld:

  • path-parameter-value in object-indeling: { "path-parameter-name": { value: "path-parameter-value", skipUrlEncoding: true } }
  • path-parameter-value in "string" format: { "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 het pathTemplate op in het optiesobject. Beide opties sluiten elkaar wederzijds 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 kan van het type 'object' zijn. De indeling 'object' moet worden gebruikt wanneer u url-codering wilt overslaan. Tijdens het gebruik van de objectindeling moet het object een eigenschap met de naamwaarde hebben die de 'query-parameter-value' levert. 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 een aantal queryparameters heeft, wordt de waarde in options.queryParameters toegevoegd aan de URL.
queryParameters?: {[key: string]: any | ParameterValue}

Waarde van eigenschap

{[key: string]: any | ParameterValue}

redirectLimit

Beperk het aantal omleidingen dat wordt gevolgd voor deze aanvraag. Als deze optie is ingesteld op 0, worden omleidingen niet gevolgd. Als het standaardomleidingsgedrag van de onderliggende node_fetch ongewijzigd blijft, is dit van toepassing.

redirectLimit?: number

Waarde van eigenschap

number

serializationMapper

Bevat informatie over het serialiseren van de aanvraagbody.

serializationMapper?: Mapper

Waarde van eigenschap

Mapper

streamResponseBody 

streamResponseBody?: boolean

Waarde van eigenschap

boolean

url

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

url?: string

Waarde van eigenschap

string