QueueReceiveMessageOptions interface

Paket:

@azure/storage-queue

Alternativ för att konfigurera åtgärden receiveMessages

Extends

MessagesDequeueOptionalParams,CommonOptions

Egenskaper

abortSignal

En implementering av AbortSignalLike-gränssnittet för att signalera begäran om att avbryta åtgärden. Använd till exempel @azure/abort-controller för att skapa en AbortSignal.

Ärvda egenskaper

numberOfMessages	Valfri. Ett heltalsvärde som inte är noll och som anger hur många meddelanden som ska hämtas från kön, upp till högst 32. Om färre visas returneras de synliga meddelandena. Som standard hämtas ett enda meddelande från kön med den här åtgärden.
requestId	Tillhandahåller ett klientgenererat, täckande värde med en gräns på 1 KB som registreras i analysloggarna när loggning av lagringsanalys är aktiverad.
timeoutInSeconds	Parametern Timeout uttrycks i sekunder. Mer information finns i Ställa in tidsgränser för kötjänståtgärder.
tracingOptions	Alternativ för att konfigurera intervall som skapas när spårning är aktiverat.
visibilityTimeout	Valfri. Anger det nya tidsgränsvärdet för synlighet, i sekunder, i förhållande till servertid. Standardvärdet är 30 sekunder. Ett angivet värde måste vara större än eller lika med 1 sekund och får inte vara större än 7 dagar eller större än 2 timmar i REST-protokollversioner före version 2011-08-18. Tidsgränsen för synlighet för ett meddelande kan anges till ett värde senare än förfallotiden.

Egenskapsinformation

abortSignal

En implementering av AbortSignalLike-gränssnittet för att signalera begäran om att avbryta åtgärden. Använd till exempel @azure/abort-controller för att skapa en AbortSignal.

abortSignal?: AbortSignalLike

Egenskapsvärde

AbortSignalLike

Information om ärvda egenskaper

numberOfMessages

Valfri. Ett heltalsvärde som inte är noll och som anger hur många meddelanden som ska hämtas från kön, upp till högst 32. Om färre visas returneras de synliga meddelandena. Som standard hämtas ett enda meddelande från kön med den här åtgärden.

numberOfMessages?: number

Egenskapsvärde

number

ärvd frånMessagesDequeueOptionalParams.numberOfMessages

requestId

Tillhandahåller ett klientgenererat, täckande värde med en gräns på 1 KB som registreras i analysloggarna när loggning av lagringsanalys är aktiverad.

requestId?: string

Egenskapsvärde

string

ärvd frånMessagesDequeueOptionalParams.requestId

timeoutInSeconds

Parametern Timeout uttrycks i sekunder. Mer information finns i Ställa in tidsgränser för kötjänståtgärder.

timeoutInSeconds?: number

Egenskapsvärde

number

ärvd frånMessagesDequeueOptionalParams.timeoutInSeconds

tracingOptions

Alternativ för att konfigurera intervall som skapas när spårning är aktiverat.

tracingOptions?: OperationTracingOptions

Egenskapsvärde

OperationTracingOptions

ärvd frånCommonOptions.tracingOptions

visibilityTimeout

Valfri. Anger det nya tidsgränsvärdet för synlighet, i sekunder, i förhållande till servertid. Standardvärdet är 30 sekunder. Ett angivet värde måste vara större än eller lika med 1 sekund och får inte vara större än 7 dagar eller större än 2 timmar i REST-protokollversioner före version 2011-08-18. Tidsgränsen för synlighet för ett meddelande kan anges till ett värde senare än förfallotiden.

visibilityTimeout?: number

Egenskapsvärde

number

ärvd frånMessagesDequeueOptionalParams.visibilityTimeout