Condividi tramite

RequestPrepareOptions interface

Pacchetto:
@azure/ms-rest-js

Proprietà

abortSignal
baseUrl

URL di base della richiesta. Il valore predefinito è: "https://management.azure.com". Questa opzione è applicabile solo con pathTemplate. Se si specifica options.url, si prevede di specificare 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
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 "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"
  • "x-ms-client-request-id" per impostazione predefinita è 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 di richiesta HTTP. I valori validi sono "GET", "PUT", "HEAD", "DELETE", "OPTIONS", "POST" o "PATCH".
onDownloadProgress
onUploadProgress
pathParameters

Dizionario di parametri di percorso che devono essere sostituiti con 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 desidera ignorare la codifica url. Quando si usa il formato dell'oggetto, l'oggetto deve avere una proprietà denominata value 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 desidera 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.
redirectLimit

Limitare il numero di reindirizzamenti seguiti per questa richiesta. Se impostato su 0, i reindirizzamenti non verranno seguiti. Se non definito, verrà applicato il comportamento di reindirizzamento predefinito del node_fetch sottostante.
serializationMapper

Fornisce informazioni su come serializzare il corpo della richiesta.
streamResponseBody
url

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

Dettagli proprietà

abortSignal 

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, si prevede di specificare 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?: object

Valore della proprietà

object

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 

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 "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"
  • "x-ms-client-request-id" per impostazione predefinita è 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 di richiesta HTTP. I valori validi sono "GET", "PUT", "HEAD", "DELETE", "OPTIONS", "POST" o "PATCH".

method: HttpMethods

Valore della proprietà

HttpMethods

onDownloadProgress 

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valore della proprietà

(progress: TransferProgressEvent) => void

onUploadProgress 

onUploadProgress?: (progress: TransferProgressEvent) => void

Valore della proprietà

(progress: TransferProgressEvent) => void

pathParameters

Dizionario di parametri di percorso che devono essere sostituiti con 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 desidera ignorare la codifica url. Quando si usa il formato dell'oggetto, l'oggetto deve avere una proprietà denominata value 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 desidera 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}

redirectLimit

Limitare il numero di reindirizzamenti seguiti per questa richiesta. Se impostato su 0, i reindirizzamenti non verranno seguiti. Se non definito, verrà applicato il comportamento di reindirizzamento predefinito del node_fetch sottostante.

redirectLimit?: number

Valore della proprietà

number

serializationMapper

Fornisce informazioni su come serializzare il corpo della richiesta.

serializationMapper?: Mapper

Valore della proprietà

Mapper

streamResponseBody 

streamResponseBody?: boolean

Valore della proprietà

boolean

url

URL della richiesta. Potrebbe essere presente 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