QueuePeekMessagesOptions interface

Pacote:

@azure/storage-queue

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

Extends

MessagesPeekOptionalParams,CommonOptions

Propriedades

abortSignal

Uma implementação da interface AbortSignalLike para sinalizar a solicitação para cancelar a operação. Por exemplo, use o controlador de @azure/anulação 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 de tempo limite é 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 intervalos criados quando o rastreamento está habilitado.

Detalhes da propriedade

abortSignal

Uma implementação da interface AbortSignalLike para sinalizar a solicitação para cancelar a operação. Por exemplo, use o controlador de @azure/anulação para criar um AbortSignal.

abortSignal?: AbortSignalLike

Valor da propriedade

AbortSignalLike

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 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 da propriedade

number

Herdado deMessagesPeekOptionalParams.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 da propriedade

string

Herdado deMessagesPeekOptionalParams.requestId

timeoutInSeconds

O parâmetro de tempo limite é expresso em segundos. Para obter mais informações, consulte Definindo 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