RequestPrepareOptions interface

  • Referencia
Paquete:
@azure/ms-rest-js

Propiedades

abortSignal
baseUrl

Dirección URL base de la solicitud. El valor predeterminado es: "https://management.azure.com". Esto solo se aplica con pathTemplate. Si proporciona options.url, se espera que proporcione la dirección URL completa.
body

Cuerpo de la solicitud. Puede ser de cualquier tipo. Este valor se serializará si no es una secuencia.
bodyIsStream

Indica si el cuerpo de la solicitud es una secuencia (útil para escenarios de carga de archivos).
deserializationMapper

Proporciona información sobre cómo deserializar el cuerpo de la respuesta.
disableClientRequestId

Cuando se establece en true, indica al cliente que no establezca el encabezado "x-ms-client-request-id" en un nuevo Guid().
disableJsonStringifyOnBody

Indica si este método debe json.stringify() el cuerpo de la solicitud. Valor predeterminado: false.
formData
headers

Diccionario de encabezados de solicitud que se deben aplicar a la solicitud. Aquí la clave es "header-name" y el valor es "header-value". El valor de encabezado DEBE ser de tipo cadena.

  • ContentType debe proporcionarse con el nombre de clave como "Content-Type". Valor predeterminado "application/json; charset=utf-8".
  • "Transfer-Encoding" se establece en "fragmentado" de forma predeterminada si "options.bodyIsStream" está establecido en true.
  • "Content-Type" se establece en "application/octet-stream" de forma predeterminada si "options.bodyIsStream" está establecido en true.
  • "accept-language" de forma predeterminada se establece en "en-US"
  • "x-ms-client-request-id" de forma predeterminada se establece en un nuevo GUID. Para no generar un guid para la solicitud, establezca options.disableClientRequestId en true.
mappers

Diccionario de asignadores que se pueden usar mientras se [de]serialización.
method

Método de solicitud HTTP. Los valores válidos son "GET", "PUT", "HEAD", "DELETE", "OPTIONS", "POST" o "PATCH".
onDownloadProgress
onUploadProgress
pathParameters

Diccionario de parámetros de ruta de acceso que deben reemplazarse por valores reales en pathTemplate. Aquí la clave es "path-parameter-name" y el valor es "path-parameter-value". "path-parameter-value" puede ser de tipo "string" o puede ser de tipo "object". El formato "object" debe usarse cuando desee omitir la codificación url. Al usar el formato de objeto, el objeto debe tener una propiedad denominada value que proporcione el "path-parameter-value". Ejemplo:

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

Plantilla de ruta de acceso de la dirección URL de la solicitud. Proporcione la "url" o proporcione "pathTemplate" en el objeto options. Ambas opciones son mutuamente excluyentes. Ejemplo: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}"
queryParameters

Diccionario de parámetros de consulta que se van a anexar a la dirección URL, donde "key" es "query-parameter-name" y "value" es "query-parameter-value". "query-parameter-value" puede ser de tipo "string" o puede ser de tipo "object". El formato "object" debe usarse cuando desee omitir la codificación url. Al usar el formato de objeto, el objeto debe tener una propiedad denominada value que proporcione el "query-parameter-value". Ejemplo:

  • query-parameter-value en formato "object": { "query-parameter-name": { value: "query-parameter-value", skipUrlEncoding: true } }
  • query-parameter-value en formato "string": { "query-parameter-name": "query-parameter-value"}. Nota: "Si options.url ya tiene algunos parámetros de consulta, el valor proporcionado en options.queryParameters se anexará a la dirección URL.
redirectLimit

Limite el número de redireccionamientos seguidos para esta solicitud. Si se establece en 0, no se seguirán las redirecciones. Si se deja sin definir, se aplicará el comportamiento de redireccionamiento predeterminado del node_fetch subyacente.
serializationMapper

Proporciona información sobre cómo serializar el cuerpo de la solicitud.
streamResponseBody
url

Dirección URL de la solicitud. Puede que tenga o no parámetros de consulta en él. Proporcione la "url" o proporcione "pathTemplate" en el objeto options. Ambas opciones son mutuamente excluyentes.

Detalles de las propiedades

abortSignal 

abortSignal?: AbortSignalLike

Valor de propiedad

AbortSignalLike

baseUrl

Dirección URL base de la solicitud. El valor predeterminado es: "https://management.azure.com". Esto solo se aplica con pathTemplate. Si proporciona options.url, se espera que proporcione la dirección URL completa.

baseUrl?: string

Valor de propiedad

string

body

Cuerpo de la solicitud. Puede ser de cualquier tipo. Este valor se serializará si no es una secuencia.

body?: any

Valor de propiedad

any

bodyIsStream

Indica si el cuerpo de la solicitud es una secuencia (útil para escenarios de carga de archivos).

bodyIsStream?: boolean

Valor de propiedad

boolean

deserializationMapper

Proporciona información sobre cómo deserializar el cuerpo de la respuesta.

deserializationMapper?: object

Valor de propiedad

object

disableClientRequestId

Cuando se establece en true, indica al cliente que no establezca el encabezado "x-ms-client-request-id" en un nuevo Guid().

disableClientRequestId?: boolean

Valor de propiedad

boolean

disableJsonStringifyOnBody

Indica si este método debe json.stringify() el cuerpo de la solicitud. Valor predeterminado: false.

disableJsonStringifyOnBody?: boolean

Valor de propiedad

boolean

formData 

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

Valor de propiedad

{[key: string]: any}

headers

Diccionario de encabezados de solicitud que se deben aplicar a la solicitud. Aquí la clave es "header-name" y el valor es "header-value". El valor de encabezado DEBE ser de tipo cadena.

  • ContentType debe proporcionarse con el nombre de clave como "Content-Type". Valor predeterminado "application/json; charset=utf-8".
  • "Transfer-Encoding" se establece en "fragmentado" de forma predeterminada si "options.bodyIsStream" está establecido en true.
  • "Content-Type" se establece en "application/octet-stream" de forma predeterminada si "options.bodyIsStream" está establecido en true.
  • "accept-language" de forma predeterminada se establece en "en-US"
  • "x-ms-client-request-id" de forma predeterminada se establece en un nuevo GUID. Para no generar un guid para la solicitud, establezca options.disableClientRequestId en true.
headers?: {[key: string]: any}

Valor de propiedad

{[key: string]: any}

mappers

Diccionario de asignadores que se pueden usar mientras se [de]serialización.

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

Valor de propiedad

{[x: string]: any}

method

Método de solicitud HTTP. Los valores válidos son "GET", "PUT", "HEAD", "DELETE", "OPTIONS", "POST" o "PATCH".

method: HttpMethods

Valor de propiedad

HttpMethods

onDownloadProgress 

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valor de propiedad

(progress: TransferProgressEvent) => void

onUploadProgress 

onUploadProgress?: (progress: TransferProgressEvent) => void

Valor de propiedad

(progress: TransferProgressEvent) => void

pathParameters

Diccionario de parámetros de ruta de acceso que deben reemplazarse por valores reales en pathTemplate. Aquí la clave es "path-parameter-name" y el valor es "path-parameter-value". "path-parameter-value" puede ser de tipo "string" o puede ser de tipo "object". El formato "object" debe usarse cuando desee omitir la codificación url. Al usar el formato de objeto, el objeto debe tener una propiedad denominada value que proporcione el "path-parameter-value". Ejemplo:

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

Valor de propiedad

{[key: string]: any | ParameterValue}

pathTemplate

Plantilla de ruta de acceso de la dirección URL de la solicitud. Proporcione la "url" o proporcione "pathTemplate" en el objeto options. Ambas opciones son mutuamente excluyentes. Ejemplo: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}"

pathTemplate?: string

Valor de propiedad

string

queryParameters

Diccionario de parámetros de consulta que se van a anexar a la dirección URL, donde "key" es "query-parameter-name" y "value" es "query-parameter-value". "query-parameter-value" puede ser de tipo "string" o puede ser de tipo "object". El formato "object" debe usarse cuando desee omitir la codificación url. Al usar el formato de objeto, el objeto debe tener una propiedad denominada value que proporcione el "query-parameter-value". Ejemplo:

  • query-parameter-value en formato "object": { "query-parameter-name": { value: "query-parameter-value", skipUrlEncoding: true } }
  • query-parameter-value en formato "string": { "query-parameter-name": "query-parameter-value"}. Nota: "Si options.url ya tiene algunos parámetros de consulta, el valor proporcionado en options.queryParameters se anexará a la dirección URL.
queryParameters?: {[key: string]: any | ParameterValue}

Valor de propiedad

{[key: string]: any | ParameterValue}

redirectLimit

Limite el número de redireccionamientos seguidos para esta solicitud. Si se establece en 0, no se seguirán las redirecciones. Si se deja sin definir, se aplicará el comportamiento de redireccionamiento predeterminado del node_fetch subyacente.

redirectLimit?: number

Valor de propiedad

number

serializationMapper

Proporciona información sobre cómo serializar el cuerpo de la solicitud.

serializationMapper?: Mapper

Valor de propiedad

Mapper

streamResponseBody 

streamResponseBody?: boolean

Valor de propiedad

boolean

url

Dirección URL de la solicitud. Puede que tenga o no parámetros de consulta en él. Proporcione la "url" o proporcione "pathTemplate" en el objeto options. Ambas opciones son mutuamente excluyentes.

url?: string

Valor de propiedad

string