QueueReceiveMessageOptions interface

Pakiet:

@azure/storage-queue

Opcje konfigurowania operacji receiveMessages

Rozszerzenie

MessagesDequeueOptionalParams,CommonOptions

Właściwości

abortSignal

Implementacja interfejsu AbortSignalLike sygnalizuje żądanie anulowania operacji. Na przykład użyj @azure/abort-controller, aby utworzyć AbortSignal.

Właściwości dziedziczone

numberOfMessages	Fakultatywny. Niezerowa wartość całkowita określająca liczbę komunikatów do pobrania z kolejki, maksymalnie 32. Jeśli mniej jest widocznych, zwracane są widoczne komunikaty. Domyślnie pojedynczy komunikat jest pobierany z kolejki z tą operacją.
requestId	Zapewnia nieprzezroczystą wartość wygenerowaną przez klienta z limitem 1 KB znaków rejestrowanym w dziennikach analitycznych po włączeniu rejestrowania analizy magazynu.
timeoutInSeconds	Parametr limitu czasu jest wyrażony w sekundach. Aby uzyskać więcej informacji, zobacz Ustawianie limitów czasu dla operacji usługi kolejki.
tracingOptions	Opcje konfigurowania zakresów utworzonych po włączeniu śledzenia.
visibilityTimeout	Fakultatywny. Określa nową wartość limitu czasu widoczności w sekundach względem czasu serwera. Wartość domyślna to 30 sekund. Określona wartość musi być większa lub równa 1 sekundy i nie może być większa niż 7 dni lub większa niż 2 godziny w wersjach protokołu REST przed wersją 2011-08-18. Limit czasu widoczności komunikatu można ustawić na wartość później niż czas wygaśnięcia.

Szczegóły właściwości

abortSignal

Implementacja interfejsu AbortSignalLike sygnalizuje żądanie anulowania operacji. Na przykład użyj @azure/abort-controller, aby utworzyć AbortSignal.

abortSignal?: AbortSignalLike

Wartość właściwości

AbortSignalLike

Szczegóły właściwości dziedziczonej

numberOfMessages

Fakultatywny. Niezerowa wartość całkowita określająca liczbę komunikatów do pobrania z kolejki, maksymalnie 32. Jeśli mniej jest widocznych, zwracane są widoczne komunikaty. Domyślnie pojedynczy komunikat jest pobierany z kolejki z tą operacją.

numberOfMessages?: number

Wartość właściwości

number

dziedziczone zMessagesDequeueOptionalParams.numberOfMessages

requestId

Zapewnia nieprzezroczystą wartość wygenerowaną przez klienta z limitem 1 KB znaków rejestrowanym w dziennikach analitycznych po włączeniu rejestrowania analizy magazynu.

requestId?: string

Wartość właściwości

string

dziedziczone zMessagesDequeueOptionalParams.requestId

timeoutInSeconds

Parametr limitu czasu jest wyrażony w sekundach. Aby uzyskać więcej informacji, zobacz Ustawianie limitów czasu dla operacji usługi kolejki.

timeoutInSeconds?: number

Wartość właściwości

number

dziedziczone zMessagesDequeueOptionalParams.timeoutInSeconds

tracingOptions

Opcje konfigurowania zakresów utworzonych po włączeniu śledzenia.

tracingOptions?: OperationTracingOptions

Wartość właściwości

OperationTracingOptions

dziedziczone zCommonOptions.tracingOptions

visibilityTimeout

Fakultatywny. Określa nową wartość limitu czasu widoczności w sekundach względem czasu serwera. Wartość domyślna to 30 sekund. Określona wartość musi być większa lub równa 1 sekundy i nie może być większa niż 7 dni lub większa niż 2 godziny w wersjach protokołu REST przed wersją 2011-08-18. Limit czasu widoczności komunikatu można ustawić na wartość później niż czas wygaśnięcia.

visibilityTimeout?: number

Wartość właściwości

number

dziedziczone zMessagesDequeueOptionalParams.visibilityTimeout