MessagesDequeueOptionalParams interface

Pakiet:

@azure/storage-queue

Parametry opcjonalne.

Rozszerzenie

RequestOptionsBase

Właściwości

abortSignal	Sygnał, który może służyć do przerwania żądań.
customHeaders	zostanie zastosowana przed wysłaniem żądania.
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ą.
onDownloadProgress	Wywołanie zwrotne uruchamiane po postępie pobierania.
onUploadProgress	Wywołanie zwrotne uruchamiane po postępie przekazywania.
requestId	Zapewnia nieprzezroczystą wartość wygenerowaną przez klienta z limitem 1 KB znaków rejestrowanym w dziennikach analitycznych po włączeniu rejestrowania analizy magazynu.
serializerOptions	Opcje zastępowania zachowania analizowania/tworzenia kodu XML.
shouldDeserialize	Określa, czy element HttpOperationResponse powinien być deserializowany. Jeśli jest to niezdefiniowane, polecenie HttpOperationResponse powinno zostać zdeserializowane.
timeout	Liczba milisekund, które może przyjąć żądanie przed automatycznym zakończeniem. Jeśli żądanie zostanie zakończone, zostanie zgłoszony AbortError.
timeoutInSeconds	Parametr limitu czasu jest wyrażony w sekundach. Aby uzyskać więcej informacji, zobacz Ustawianie limitów czasu dla operacji usługi kolejki.
tracingContext	Śledzenie: kontekst używany podczas tworzenia zakresów.
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

Sygnał, który może służyć do przerwania żądań.

abortSignal?: AbortSignalLike

Wartość właściwości

AbortSignalLike

customHeaders

zostanie zastosowana przed wysłaniem żądania.

customHeaders?: [key: string]: string

Wartość właściwości

[key: string]: string

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

onDownloadProgress

Wywołanie zwrotne uruchamiane po postępie pobierania.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Wartość właściwości

(progress: TransferProgressEvent) => void

onUploadProgress

Wywołanie zwrotne uruchamiane po postępie przekazywania.

onUploadProgress?: (progress: TransferProgressEvent) => void

Wartość właściwości

(progress: TransferProgressEvent) => void

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

serializerOptions

Opcje zastępowania zachowania analizowania/tworzenia kodu XML.

serializerOptions?: SerializerOptions

Wartość właściwości

SerializerOptions

shouldDeserialize

Określa, czy element HttpOperationResponse powinien być deserializowany. Jeśli jest to niezdefiniowane, polecenie HttpOperationResponse powinno zostać zdeserializowane.

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

Wartość właściwości

boolean | (response: HttpOperationResponse) => boolean

timeout

Liczba milisekund, które może przyjąć żądanie przed automatycznym zakończeniem. Jeśli żądanie zostanie zakończone, zostanie zgłoszony AbortError.

timeout?: number

Wartość właściwości

number

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

tracingContext

Śledzenie: kontekst używany podczas tworzenia zakresów.

tracingContext?: Context

Wartość właściwości

Context

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