QueuePeekMessagesOptions interface

Pacote:

@azure/storage-queue

Opções para configurar operação peekMessages

Extends

MessagesPeekOptionalParams,CommonOptions

Propriedades

abortSignal

Uma implementação da interface AbortSignalLike para sinalizar o pedido de cancelamento da operação. Por exemplo, use o controlador @azure/abort para criar um AbortSignal.

Propriedades Herdadas

numberOfMessages	Opcional. Um valor inteiro diferente de zero que especifica o número de mensagens a serem recuperadas da fila, até um máximo de 32. Se menos estiverem visíveis, as mensagens visíveis serão retornadas. Por padrão, uma única mensagem é recuperada da fila com essa operação.
requestId	Fornece um valor opaco gerado pelo cliente com um limite de caracteres de 1 KB que é registrado nos logs de análise quando o log de análise de armazenamento está habilitado.
timeoutInSeconds	O parâmetro The timeout é expresso em segundos. Para obter mais informações, consulte Definindo tempos limite para operações de serviço de fila.
tracingOptions	Opções para configurar extensões criadas quando o rastreamento está habilitado.

Detalhes de Propriedade

abortSignal

Uma implementação da interface AbortSignalLike para sinalizar o pedido de cancelamento da operação. Por exemplo, use o controlador @azure/abort para criar um AbortSignal.

abortSignal?: AbortSignalLike

Valor de Propriedade

AbortSignalLike

Detalhes da Propriedade Herdada

numberOfMessages

Opcional. Um valor inteiro diferente de zero que especifica o número de mensagens a serem recuperadas da fila, até um máximo de 32. Se menos estiverem visíveis, as mensagens visíveis serão retornadas. Por padrão, uma única mensagem é recuperada da fila com essa operação.

numberOfMessages?: number

Valor de Propriedade

number

herdado de MessagesPeekOptionalParams.numberOfMessages

requestId

Fornece um valor opaco gerado pelo cliente com um limite de caracteres de 1 KB que é registrado nos logs de análise quando o log de análise de armazenamento está habilitado.

requestId?: string

Valor de Propriedade

string

herdado de MessagesPeekOptionalParams.requestId

timeoutInSeconds

O parâmetro The timeout é expresso em segundos. Para obter mais informações, consulte Definindo tempos limite para operações de serviço de fila.

timeoutInSeconds?: number

Valor de Propriedade

number

herdado de MessagesPeekOptionalParams.timeoutInSeconds

tracingOptions

Opções para configurar extensões criadas quando o rastreamento está habilitado.

tracingOptions?: OperationTracingOptions

Valor de Propriedade

OperationTracingOptions

herdado deCommonOptions.tracingOptions