QueueSendMessageOptions interface

Paquete:

@azure/storage-queue

Opciones para configurar la operación sendMessage

Extends

MessagesEnqueueOptionalParams,CommonOptions

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.
messageTimeToLive	Opcional. Especifica el intervalo del período de vida para el mensaje, en segundos. Antes de la versión 2017-07-29, el período máximo de vida permitido es de 7 días. Para la versión 2017-07-29 o posterior, el período máximo de vida puede ser cualquier número positivo, así como -1 que indica que el mensaje no expira. Si se omite este parámetro, el período de vida predeterminado es de 7 días.
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.
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.
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 .
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.
tracingContext	Seguimiento: contexto utilizado al crear intervalos.
tracingOptions	Opciones para configurar intervalos creados al habilitar el seguimiento.
visibilityTimeout	Opcional. Si se especifica, la solicitud debe realizarse con una versión x-ms-version de 2011-08-18 o posterior. Si no se especifica ningún valor, se utiliza el valor predeterminado 0. Especifica el nuevo valor del tiempo de espera de visibilidad, en segundos, relativo a la hora del servidor. El nuevo valor debe ser mayor o igual que 0, y no puede ser mayor de 7 días. El tiempo de espera de visibilidad de un mensaje no puede establecerse en un valor posterior a la hora de expiración. visibilitytimeout debe establecerse en un valor menor que el valor de período de vida.

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 deMessagesEnqueueOptionalParams.abortSignal

customHeaders

se aplicará antes de enviar la solicitud.

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

Valor de propiedad

{[key: string]: string}

Heredado deMessagesEnqueueOptionalParams.customHeaders

messageTimeToLive

Opcional. Especifica el intervalo del período de vida para el mensaje, en segundos. Antes de la versión 2017-07-29, el período máximo de vida permitido es de 7 días. Para la versión 2017-07-29 o posterior, el período máximo de vida puede ser cualquier número positivo, así como -1 que indica que el mensaje no expira. Si se omite este parámetro, el período de vida predeterminado es de 7 días.

messageTimeToLive?: number

Valor de propiedad

number

Heredado deMessagesEnqueueOptionalParams.messageTimeToLive

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 deMessagesEnqueueOptionalParams.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 deMessagesEnqueueOptionalParams.onUploadProgress

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

Heredado deMessagesEnqueueOptionalParams.requestId

serializerOptions

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

serializerOptions?: SerializerOptions

Valor de propiedad

SerializerOptions

Heredado deMessagesEnqueueOptionalParams.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 deMessagesEnqueueOptionalParams.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 deMessagesEnqueueOptionalParams.timeout

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

Heredado deMessagesEnqueueOptionalParams.timeoutInSeconds

tracingContext

Seguimiento: contexto utilizado al crear intervalos.

tracingContext?: Context

Valor de propiedad

@azure/core-tracing.Context

Heredado deMessagesEnqueueOptionalParams.tracingContext

tracingOptions

Opciones para configurar intervalos creados al habilitar el seguimiento.

tracingOptions?: OperationTracingOptions

Valor de propiedad

OperationTracingOptions

Heredado deCommonOptions.tracingOptions

visibilityTimeout

Opcional. Si se especifica, la solicitud debe realizarse con una versión x-ms-version de 2011-08-18 o posterior. Si no se especifica ningún valor, se utiliza el valor predeterminado 0. Especifica el nuevo valor del tiempo de espera de visibilidad, en segundos, relativo a la hora del servidor. El nuevo valor debe ser mayor o igual que 0, y no puede ser mayor de 7 días. El tiempo de espera de visibilidad de un mensaje no puede establecerse en un valor posterior a la hora de expiración. visibilitytimeout debe establecerse en un valor menor que el valor de período de vida.

visibilityTimeout?: number

Valor de propiedad

number

Heredado deMessagesEnqueueOptionalParams.visibilityTimeout