MessagesDequeueOptionalParams interface

Paquete:

@azure/storage-queue

Parámetros opcionales.

Extends

CommonOptions

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 Tiempo de espera se expresa en segundos. Para obtener más información, vea Establecer tiempos de espera para 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 las 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

tracingOptions

Opciones para configurar intervalos creados al habilitar el seguimiento.

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 Tiempo de espera se expresa en segundos. Para obtener más información, vea Establecer tiempos de espera para 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 las 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

tracingOptions

Opciones para configurar intervalos creados al habilitar el seguimiento.

tracingOptions?: OperationTracingOptions

Valor de propiedad

OperationTracingOptions

Se hereda deCommonOptions.tracingOptions