MessagesEnqueueOptionalParams 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.
messageTimeToLive	Fakultatywny. Określa interwał czasu wygaśnięcia komunikatu w sekundach. Przed wersją 2017-07-29 maksymalny dozwolony czas wygaśnięcia wynosi 7 dni. W przypadku wersji 2017-07-29 lub nowszej maksymalny czas wygaśnięcia może być dowolną liczbą dodatnią, a także -1 wskazującą, że komunikat nie wygasa. Jeśli ten parametr zostanie pominięty, domyślny czas wygaśnięcia to 7 dni.
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. W przypadku określenia żądania należy użyć x-ms-version 2011-08-18 lub nowszego. Jeśli nie zostanie określony, wartość domyślna to 0. Określa nową wartość limitu czasu widoczności w sekundach względem czasu serwera. Nowa wartość musi być większa lub równa 0 i nie może być większa niż 7 dni. Limit czasu widoczności komunikatu nie może być ustawiony na wartość późniejszą niż czas wygaśnięcia. limit czasu widoczności powinien być ustawiony na wartość mniejszą niż wartość czasu 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

messageTimeToLive

Fakultatywny. Określa interwał czasu wygaśnięcia komunikatu w sekundach. Przed wersją 2017-07-29 maksymalny dozwolony czas wygaśnięcia wynosi 7 dni. W przypadku wersji 2017-07-29 lub nowszej maksymalny czas wygaśnięcia może być dowolną liczbą dodatnią, a także -1 wskazującą, że komunikat nie wygasa. Jeśli ten parametr zostanie pominięty, domyślny czas wygaśnięcia to 7 dni.

messageTimeToLive?: 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. W przypadku określenia żądania należy użyć x-ms-version 2011-08-18 lub nowszego. Jeśli nie zostanie określony, wartość domyślna to 0. Określa nową wartość limitu czasu widoczności w sekundach względem czasu serwera. Nowa wartość musi być większa lub równa 0 i nie może być większa niż 7 dni. Limit czasu widoczności komunikatu nie może być ustawiony na wartość późniejszą niż czas wygaśnięcia. limit czasu widoczności powinien być ustawiony na wartość mniejszą niż wartość czasu wygaśnięcia.

visibilityTimeout?: number

Wartość właściwości

number