Compartilhar via

QueuePeekMessagesOptions interface

  • Referência
Pacote:
@azure/storage-queue

Opções para configurar a operação peekMessages

Extends

MessagesPeekOptionalParams,CommonOptions

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 houver poucas 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 limite de caractere de 1 KB que será registrado nos logs de análise quando o registro em log da análise de armazenamento for habilitado.
timeoutInSeconds

O parâmetro De tempo limite é expresso em segundos. Para obter mais informações, consulte Configurando tempos limite para operações de serviço de fila.
tracingOptions

Opções para configurar intervalos criados quando o rastreamento está habilitado.

Detalhes das 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 houver poucas 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 da propriedade

number

Herdado deMessagesPeekOptionalParams.numberOfMessages

requestId

Fornece um valor opaco gerado pelo cliente com limite de caractere de 1 KB que será registrado nos logs de análise quando o registro em log da análise de armazenamento for habilitado.

requestId?: string

Valor da propriedade

string

Herdado deMessagesPeekOptionalParams.requestId

timeoutInSeconds

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

timeoutInSeconds?: number

Valor da propriedade

number

Herdado deMessagesPeekOptionalParams.timeoutInSeconds

tracingOptions

Opções para configurar intervalos criados quando o rastreamento está habilitado.

tracingOptions?: OperationTracingOptions

Valor da propriedade

OperationTracingOptions

Herdado deCommonOptions.tracingOptions