QueuePeekMessagesOptions interface

Paket:

@azure/storage-queue

Optionen zum Konfigurieren <xref:QueueClient.peekMessages> Vorgangs

Extends

MessagesPeekOptionalParams

Eigenschaften

abortSignal	Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann.
customHeaders	wird angewendet, bevor die Anforderung gesendet wird.
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.
onDownloadProgress	Rückruf, der beim Downloadfortschritt ausgelöst wird.
onUploadProgress	Rückruf, der beim Uploadfortschritt ausgelöst wird.
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.
serializerOptions	Optionen zum Überschreiben des XML-Analyse-/Gebäudeverhaltens.
shouldDeserialize	Gibt an, ob die HttpOperationResponse deserialisiert werden soll. Wenn dies nicht definiert ist, sollte die HttpOperationResponse deserialisiert werden.
timeout	Die Anzahl der Millisekunden, die eine Anforderung annehmen kann, bevor sie automatisch beendet wird. Wenn die Anforderung beendet wird, wird ein AbortError ausgelöst.
timeoutInSeconds	Der Timeoutparameter wird in Sekunden ausgedrückt. Weitere Informationen finden Sie unter Festlegen von Timeouts für Warteschlangendienstvorgänge.
tracingContext	Ablaufverfolgung: Kontext, der beim Erstellen von Spans verwendet wird.
tracingOptions	Optionen zum Konfigurieren von Spans created when tracing is enabled.

Details zur Eigenschaft

abortSignal

Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann.

abortSignal?: AbortSignalLike

Eigenschaftswert

AbortSignalLike

customHeaders

wird angewendet, bevor die Anforderung gesendet wird.

customHeaders?: [key: string]: string

Eigenschaftswert

[key: string]: string

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

onDownloadProgress

Rückruf, der beim Downloadfortschritt ausgelöst wird.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Eigenschaftswert

(progress: TransferProgressEvent) => void

onUploadProgress

Rückruf, der beim Uploadfortschritt ausgelöst wird.

onUploadProgress?: (progress: TransferProgressEvent) => void

Eigenschaftswert

(progress: TransferProgressEvent) => void

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

serializerOptions

Optionen zum Überschreiben des XML-Analyse-/Gebäudeverhaltens.

serializerOptions?: SerializerOptions

Eigenschaftswert

SerializerOptions

shouldDeserialize

Gibt an, ob die HttpOperationResponse deserialisiert werden soll. Wenn dies nicht definiert ist, sollte die HttpOperationResponse deserialisiert werden.

shouldDeserialize?: boolean | (response: HttpOperationResponse) => boolean

Eigenschaftswert

boolean | (response: HttpOperationResponse) => boolean

timeout

Die Anzahl der Millisekunden, die eine Anforderung annehmen kann, bevor sie automatisch beendet wird. Wenn die Anforderung beendet wird, wird ein AbortError ausgelöst.

timeout?: number

Eigenschaftswert

number

timeoutInSeconds

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

timeoutInSeconds?: number

Eigenschaftswert

number

tracingContext

Ablaufverfolgung: Kontext, der beim Erstellen von Spans verwendet wird.

tracingContext?: Context

Eigenschaftswert

Context

tracingOptions

Optionen zum Konfigurieren von Spans created when tracing is enabled.

tracingOptions?: OperationTracingOptions

Eigenschaftswert

OperationTracingOptions