QueuePeekMessagesOptions interface

Paket:

@azure/storage-queue

Optionen zum Konfigurieren peekMessages Vorgangs

Extends

MessagesPeekOptionalParams,CommonOptions

Eigenschaften

abortSignal

Eine Implementierung der AbortSignalLike Schnittstelle, um die Anforderung zum Abbrechen des Vorgangs zu signalisieren. Verwenden Sie beispielsweise den @azure/Abort-Controller, um eine AbortSignalzu erstellen.

Geerbte Eigenschaften

numberOfMessages	Wahlfrei. Ein ganzzahliger Wert ungleich Null, der die Anzahl der Nachrichten angibt, die aus der Warteschlange abgerufen werden sollen, bis zu maximal 32. Wenn weniger sichtbar sind, werden die sichtbaren Nachrichten zurückgegeben. Standardmäßig wird eine einzelne Nachricht mit diesem Vorgang aus der Warteschlange abgerufen.
requestId	Stellt einen vom Client generierten, undurchsichtigen Wert mit einer Beschränkung von 1 KB Zeichen bereit, die in den Analyseprotokollen aufgezeichnet wird, wenn die Speicheranalyseprotokollierung aktiviert ist.
timeoutInSeconds	Der Timeoutparameter wird in Sekunden ausgedrückt. Weitere Informationen finden Sie unter Festlegen von Timeouts für Warteschlangendienstvorgänge.
tracingOptions	Optionen zum Konfigurieren von Spans created when tracing is enabled.

Details zur Eigenschaft

abortSignal

Eine Implementierung der AbortSignalLike Schnittstelle, um die Anforderung zum Abbrechen des Vorgangs zu signalisieren. Verwenden Sie beispielsweise den @azure/Abort-Controller, um eine AbortSignalzu erstellen.

abortSignal?: AbortSignalLike

Eigenschaftswert

AbortSignalLike

Geerbte Eigenschaftsdetails

numberOfMessages

Wahlfrei. Ein ganzzahliger Wert ungleich Null, der die Anzahl der Nachrichten angibt, die aus der Warteschlange abgerufen werden sollen, bis zu maximal 32. Wenn weniger sichtbar sind, werden die sichtbaren Nachrichten zurückgegeben. Standardmäßig wird eine einzelne Nachricht mit diesem Vorgang aus der Warteschlange abgerufen.

numberOfMessages?: number

Eigenschaftswert

number

vonMessagesPeekOptionalParams.numberOfMessages

requestId

Stellt einen vom Client generierten, undurchsichtigen Wert mit einer Beschränkung von 1 KB Zeichen bereit, die in den Analyseprotokollen aufgezeichnet wird, wenn die Speicheranalyseprotokollierung aktiviert ist.

requestId?: string

Eigenschaftswert

string

vonMessagesPeekOptionalParams.requestId

timeoutInSeconds

Der Timeoutparameter wird in Sekunden ausgedrückt. Weitere Informationen finden Sie unter Festlegen von Timeouts für Warteschlangendienstvorgänge.

timeoutInSeconds?: number

Eigenschaftswert

number

vonMessagesPeekOptionalParams.timeoutInSeconds geerbt

tracingOptions

Optionen zum Konfigurieren von Spans created when tracing is enabled.

tracingOptions?: OperationTracingOptions

Eigenschaftswert

OperationTracingOptions

von"CommonOptions.tracingOptions" geerbt