MessagesDequeueOptionalParams interface

Paquete:

@azure/storage-queue

Parámetros opcionales.

Extends

RequestOptionsBase

Propiedades

numberOfMessages	Opcional. Valor entero distinto de cero que especifica el número de mensajes que se deben recuperar de la cola, hasta un máximo de 32. Si hay un número menor de mensajes visibles, se devuelven los mensajes visibles. De forma predeterminada, con esta operación se recupera un solo mensaje de la cola.
requestId	Proporciona un valor opaco generado por el cliente con un límite de caracteres de 1 KB registrado en los registros de análisis cuando está habilitado registro del análisis de almacenamiento.
timeoutInSeconds	El parámetro Timeout se expresa en segundos. Para obtener más información, consulte Configuración de tiempos de espera para las operaciones de Queue Service.
visibilityTimeout	Opcional. Especifica el nuevo valor del tiempo de espera de visibilidad, en segundos, relativo a la hora del servidor. El valor predeterminado es 30 segundos. Un valor especificado debe ser mayor o igual que 1 segundo y no puede ser mayor que 7 días o superior a 2 horas en versiones del protocolo REST anteriores a la versión 2011-08-18. El tiempo de espera de visibilidad de un mensaje puede establecerse en un valor posterior a la hora de expiración.

Propiedades heredadas

abortSignal	Señal de un controlador de anulación. Se puede usar para anular el envío de una solicitud de red y la espera de una respuesta.
customHeaders	se aplicará antes de enviar la solicitud.
onDownloadProgress	Devolución de llamada que se activa tras el progreso de la descarga.
onUploadProgress	Devolución de llamada que se activa tras el progreso de la carga.
serializerOptions	Opciones para invalidar el comportamiento de compilación y análisis de XML.
shouldDeserialize	Si se debe deserializar o no HttpOperationResponse. Si no está definido, se debe deserializar HttpOperationResponse.
timeout	El número de milisegundos que una solicitud puede realizar antes de finalizarse automáticamente. Si se finaliza la solicitud, se produce una AbortError excepción .
tracingContext	Seguimiento: contexto utilizado al crear intervalos.

Detalles de las propiedades

numberOfMessages

Opcional. Valor entero distinto de cero que especifica el número de mensajes que se deben recuperar de la cola, hasta un máximo de 32. Si hay un número menor de mensajes visibles, se devuelven los mensajes visibles. De forma predeterminada, con esta operación se recupera un solo mensaje de la cola.

numberOfMessages?: number

Valor de propiedad

number

requestId

Proporciona un valor opaco generado por el cliente con un límite de caracteres de 1 KB registrado en los registros de análisis cuando está habilitado registro del análisis de almacenamiento.

requestId?: string

Valor de propiedad

string

timeoutInSeconds

El parámetro Timeout se expresa en segundos. Para obtener más información, consulte Configuración de tiempos de espera para las operaciones de Queue Service.

timeoutInSeconds?: number

Valor de propiedad

number

visibilityTimeout

Opcional. Especifica el nuevo valor del tiempo de espera de visibilidad, en segundos, relativo a la hora del servidor. El valor predeterminado es 30 segundos. Un valor especificado debe ser mayor o igual que 1 segundo y no puede ser mayor que 7 días o superior a 2 horas en versiones del protocolo REST anteriores a la versión 2011-08-18. El tiempo de espera de visibilidad de un mensaje puede establecerse en un valor posterior a la hora de expiración.

visibilityTimeout?: number

Valor de propiedad

number

Detalles de las propiedades heredadas

abortSignal

Señal de un controlador de anulación. Se puede usar para anular el envío de una solicitud de red y la espera de una respuesta.

abortSignal?: AbortSignalLike

Valor de propiedad

AbortSignalLike

Heredado de RequestOptionsBase.abortSignal

customHeaders

se aplicará antes de enviar la solicitud.

customHeaders?: {[key: string]: string}

Valor de propiedad

{[key: string]: string}

Heredado de RequestOptionsBase.customHeaders

onDownloadProgress

Devolución de llamada que se activa tras el progreso de la descarga.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valor de propiedad

(progress: TransferProgressEvent) => void

Heredado de RequestOptionsBase.onDownloadProgress

onUploadProgress

Devolución de llamada que se activa tras el progreso de la carga.

onUploadProgress?: (progress: TransferProgressEvent) => void

Valor de propiedad

(progress: TransferProgressEvent) => void

Heredado de RequestOptionsBase.onUploadProgress

serializerOptions

Opciones para invalidar el comportamiento de compilación y análisis de XML.

serializerOptions?: SerializerOptions

Valor de propiedad

SerializerOptions

Heredado de RequestOptionsBase.serializerOptions

shouldDeserialize

Si se debe deserializar o no HttpOperationResponse. Si no está definido, se debe deserializar HttpOperationResponse.

shouldDeserialize?: boolean | (response: HttpOperationResponse) => boolean

Valor de propiedad

boolean | (response: HttpOperationResponse) => boolean

Heredado de RequestOptionsBase.shouldDeserialize

timeout

El número de milisegundos que una solicitud puede realizar antes de finalizarse automáticamente. Si se finaliza la solicitud, se produce una AbortError excepción .

timeout?: number

Valor de propiedad

number

Heredado de RequestOptionsBase.timeout

tracingContext

Seguimiento: contexto utilizado al crear intervalos.

tracingContext?: Context

Valor de propiedad

@azure/core-tracing.Context

Heredado de RequestOptionsBase.tracingContext