QueueSendMessageOptions interface

Pakiet:

@azure/storage-queue

Opcje konfigurowania operacji sendMessage

Rozszerzenie

MessagesEnqueueOptionalParams,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

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.
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. 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

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

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

dziedziczone zMessagesEnqueueOptionalParams.messageTimeToLive

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 zMessagesEnqueueOptionalParams.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 zMessagesEnqueueOptionalParams.timeoutInSeconds

tracingOptions

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

tracingOptions?: OperationTracingOptions

Wartość właściwości

OperationTracingOptions

dziedziczone zCommonOptions.tracingOptions

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

dziedziczone zMessagesEnqueueOptionalParams.visibilityTimeout