Condividi tramite

RequestPrepareOptions interface

  • Riferimento
Pacchetto:
@azure/core-http

Opzioni per preparare una richiesta HTTP in uscita.

Proprietà

abortSignal

Segnale di un controller di interruzione. Può essere usato per interrompere l'invio di una richiesta di rete e l'attesa di una risposta.
baseUrl

URL di base della richiesta. Il valore predefinito è: "https://management.azure.com". Questa opzione è applicabile solo con pathTemplate. Se si specifica options.url, è previsto che venga fornito l'URL completo.
body

Corpo della richiesta. Può essere di qualsiasi tipo. Questo valore verrà serializzato se non è un flusso.
bodyIsStream

Indica se il corpo della richiesta è un flusso (utile per gli scenari di caricamento di file).
deserializationMapper

Fornisce informazioni su come deserializzare il corpo della risposta.
disableClientRequestId

Se impostato su true, indica al client di non impostare l'intestazione "x-ms-client-request-id" su un nuovo Guid().
disableJsonStringifyOnBody

Indica se questo metodo deve essere JSON.stringify() il corpo della richiesta. Valore predefinito: false.
formData

Dati del modulo, usati per compilare il corpo della richiesta.
headers

Dizionario di intestazioni di richiesta che devono essere applicate alla richiesta. Qui la chiave è "header-name" e il valore è "header-value". Il valore dell'intestazione DEVE essere di tipo string.

  • ContentType deve essere fornito con il nome della chiave come "Content-Type". Valore predefinito "application/json; charset=utf-8".
  • "Transfer-Encoding" è impostato su "chunked" per impostazione predefinita se "options.bodyIsStream" è impostato su true.
  • "Content-Type" è impostato su "application/octet-stream" per impostazione predefinita se "options.bodyIsStream" è impostato su true.
  • "accept-language" per impostazione predefinita è impostato su "en-US"
  • Per impostazione predefinita, "x-ms-client-request-id" è impostato su un nuovo GUID. Per non generare un GUID per la richiesta, impostare options.disableClientRequestId su true
mappers

Dizionario di mapper che possono essere usati durante la serializzazione [de].
method

Metodo della richiesta HTTP. I valori validi sono "GET", "PUT", "HEAD", "DELETE", "OPTIONS", "POST" o "PATCH".
onDownloadProgress

Consente di tenere traccia dello stato di avanzamento del download della risposta in ingresso.
onUploadProgress

Consente di tenere traccia dello stato di avanzamento del caricamento della richiesta in uscita.
pathParameters

Dizionario dei parametri di percorso che devono essere sostituiti con i valori effettivi nel pathTemplate. Qui la chiave è "path-parameter-name" e il valore è "path-parameter-value". "path-parameter-value" può essere di tipo "string" oppure può essere di tipo "object". Il formato "object" deve essere usato quando si vuole ignorare la codifica url. Quando si usa il formato dell'oggetto, l'oggetto deve avere un valore denominato proprietà che fornisce il valore "path-parameter-value". Esempio:

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

Modello di percorso dell'URL della richiesta. Specificare "url" o specificare "pathTemplate" nell'oggetto options. Entrambe le opzioni si escludono a vicenda. Esempio: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}
queryParameters

Dizionario di parametri di query da aggiungere all'URL, dove "key" è "query-parameter-name" e "value" è "query-parameter-value". "query-parameter-value" può essere di tipo "string" oppure può essere di tipo "object". Il formato "object" deve essere usato quando si vuole ignorare la codifica url. Quando si usa il formato dell'oggetto, l'oggetto deve avere una proprietà denominata value che fornisce il valore "query-parameter-value". Esempio:

  • query-parameter-value in formato "object": { "query-parameter-name": { value: "query-parameter-value", skipUrlEncoding: true } }
  • query-parameter-value in formato "string": { "query-parameter-name": "query-parameter-value"}. Nota: "Se options.url ha già alcuni parametri di query, il valore fornito in options.queryParameters verrà aggiunto all'URL.
serializationMapper

Fornisce informazioni su come serializzare il corpo della richiesta.
spanOptions

Traccia: opzioni usate per creare un intervallo quando la traccia è abilitata.
tracingContext

Traccia: contesto usato durante la creazione di intervalli.
url

URL della richiesta. Può avere o meno parametri di query. Specificare "url" o specificare "pathTemplate" nell'oggetto options. Entrambe le opzioni si escludono a vicenda.

Dettagli proprietà

abortSignal

Segnale di un controller di interruzione. Può essere usato per interrompere l'invio di una richiesta di rete e l'attesa di una risposta.

abortSignal?: AbortSignalLike

Valore della proprietà

AbortSignalLike

baseUrl

URL di base della richiesta. Il valore predefinito è: "https://management.azure.com". Questa opzione è applicabile solo con pathTemplate. Se si specifica options.url, è previsto che venga fornito l'URL completo.

baseUrl?: string

Valore della proprietà

string

body

Corpo della richiesta. Può essere di qualsiasi tipo. Questo valore verrà serializzato se non è un flusso.

body?: any

Valore della proprietà

any

bodyIsStream

Indica se il corpo della richiesta è un flusso (utile per gli scenari di caricamento di file).

bodyIsStream?: boolean

Valore della proprietà

boolean

deserializationMapper

Fornisce informazioni su come deserializzare il corpo della risposta.

deserializationMapper?: Record<string, unknown>

Valore della proprietà

Record<string, unknown>

disableClientRequestId

Se impostato su true, indica al client di non impostare l'intestazione "x-ms-client-request-id" su un nuovo Guid().

disableClientRequestId?: boolean

Valore della proprietà

boolean

disableJsonStringifyOnBody

Indica se questo metodo deve essere JSON.stringify() il corpo della richiesta. Valore predefinito: false.

disableJsonStringifyOnBody?: boolean

Valore della proprietà

boolean

formData

Dati del modulo, usati per compilare il corpo della richiesta.

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

Valore della proprietà

{[key: string]: any}

headers

Dizionario di intestazioni di richiesta che devono essere applicate alla richiesta. Qui la chiave è "header-name" e il valore è "header-value". Il valore dell'intestazione DEVE essere di tipo string.

  • ContentType deve essere fornito con il nome della chiave come "Content-Type". Valore predefinito "application/json; charset=utf-8".
  • "Transfer-Encoding" è impostato su "chunked" per impostazione predefinita se "options.bodyIsStream" è impostato su true.
  • "Content-Type" è impostato su "application/octet-stream" per impostazione predefinita se "options.bodyIsStream" è impostato su true.
  • "accept-language" per impostazione predefinita è impostato su "en-US"
  • Per impostazione predefinita, "x-ms-client-request-id" è impostato su un nuovo GUID. Per non generare un GUID per la richiesta, impostare options.disableClientRequestId su true
headers?: {[key: string]: any}

Valore della proprietà

{[key: string]: any}

mappers

Dizionario di mapper che possono essere usati durante la serializzazione [de].

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

Valore della proprietà

{[x: string]: any}

method

Metodo della richiesta HTTP. I valori validi sono "GET", "PUT", "HEAD", "DELETE", "OPTIONS", "POST" o "PATCH".

method: HttpMethods

Valore della proprietà

HttpMethods

onDownloadProgress

Consente di tenere traccia dello stato di avanzamento del download della risposta in ingresso.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valore della proprietà

(progress: TransferProgressEvent) => void

onUploadProgress

Consente di tenere traccia dello stato di avanzamento del caricamento della richiesta in uscita.

onUploadProgress?: (progress: TransferProgressEvent) => void

Valore della proprietà

(progress: TransferProgressEvent) => void

pathParameters

Dizionario dei parametri di percorso che devono essere sostituiti con i valori effettivi nel pathTemplate. Qui la chiave è "path-parameter-name" e il valore è "path-parameter-value". "path-parameter-value" può essere di tipo "string" oppure può essere di tipo "object". Il formato "object" deve essere usato quando si vuole ignorare la codifica url. Quando si usa il formato dell'oggetto, l'oggetto deve avere un valore denominato proprietà che fornisce il valore "path-parameter-value". Esempio:

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

Valore della proprietà

{[key: string]: any | ParameterValue}

pathTemplate

Modello di percorso dell'URL della richiesta. Specificare "url" o specificare "pathTemplate" nell'oggetto options. Entrambe le opzioni si escludono a vicenda. Esempio: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}

pathTemplate?: string

Valore della proprietà

string

queryParameters

Dizionario di parametri di query da aggiungere all'URL, dove "key" è "query-parameter-name" e "value" è "query-parameter-value". "query-parameter-value" può essere di tipo "string" oppure può essere di tipo "object". Il formato "object" deve essere usato quando si vuole ignorare la codifica url. Quando si usa il formato dell'oggetto, l'oggetto deve avere una proprietà denominata value che fornisce il valore "query-parameter-value". Esempio:

  • query-parameter-value in formato "object": { "query-parameter-name": { value: "query-parameter-value", skipUrlEncoding: true } }
  • query-parameter-value in formato "string": { "query-parameter-name": "query-parameter-value"}. Nota: "Se options.url ha già alcuni parametri di query, il valore fornito in options.queryParameters verrà aggiunto all'URL.
queryParameters?: {[key: string]: any | ParameterValue}

Valore della proprietà

{[key: string]: any | ParameterValue}

serializationMapper

Fornisce informazioni su come serializzare il corpo della richiesta.

serializationMapper?: Mapper

Valore della proprietà

Mapper

spanOptions

Traccia: opzioni usate per creare un intervallo quando la traccia è abilitata.

spanOptions?: SpanOptions

Valore della proprietà

@azure/core-tracing.SpanOptions

tracingContext

Traccia: contesto usato durante la creazione di intervalli.

tracingContext?: Context

Valore della proprietà

@azure/core-tracing.Context

url

URL della richiesta. Può avere o meno parametri di query. Specificare "url" o specificare "pathTemplate" nell'oggetto options. Entrambe le opzioni si escludono a vicenda.

url?: string

Valore della proprietà

string