ServiceBusMessage interface

Pakiet:

@azure/service-bus

Opisuje komunikat, który ma zostać wysłany do usługi Service Bus.

Właściwości

applicationProperties	Właściwości specyficzne dla aplikacji, które mogą być używane na potrzeby niestandardowych metadanych komunikatów.
body	Treść wiadomości, która musi zostać wysłana lub odebrana. Jeśli aplikacja, która otrzymuje komunikat, nie używa tego zestawu SDK, przekonwertuj ładunek treści na tablicę bajtów lub bufor, aby uzyskać lepszą zgodność między językami.
contentType	Typ zawartości wiadomości. Opcjonalnie opisano ładunek komunikatu z deskryptorem w formacie RFC2045, sekcja 5, na przykład "application/json".
correlationId	Identyfikator korelacji, który umożliwia aplikacji określenie kontekstu komunikatu na potrzeby korelacji, na przykład odzwierciedlające identyfikator MessageId komunikatu, na który jest odpowiadana. Zobacz Routing i korelacja komunikatów.
messageId	Identyfikator komunikatu jest wartością zdefiniowaną przez aplikację, która jednoznacznie identyfikuje komunikat i jego ładunek. Uwaga: liczby, które nie są liczbami całkowitymi, są niedozwolone.
partitionKey	Klucz partycji do wysyłania komunikatu do jednostki podzielonej na partycje. Maksymalna długość to 128 znaków. W przypadku jednostek partycjonowanych ustawienie tej wartości umożliwia przypisywanie powiązanych komunikatów do tej samej partycji wewnętrznej, dzięki czemu kolejność sekwencji przesyłania jest poprawnie rejestrowana. Partycja jest wybierana przez funkcję skrótu dla tej wartości i nie można jej wybrać bezpośrednio. W przypadku jednostek obsługujących sesję sessionId właściwość zastępuje tę wartość. W przypadku jednostek bez partycjonowania klucz partycji zostanie zignorowany
replyTo	Adres jednostki do wysyłania odpowiedzi. Ta opcjonalna i zdefiniowana przez aplikację wartość jest standardowym sposobem wyrażania ścieżki odpowiedzi do odbiorcy komunikatu. Gdy nadawca oczekuje odpowiedzi, ustawia wartość na bezwzględną lub względną ścieżkę kolejki lub tematu, do których oczekuje wysłania odpowiedzi. Zobacz Routing i korelacja komunikatów.
replyToSessionId	Identyfikator sesji rozszerza replyTo adres. Maksymalna długość to 128 znaków. Ta wartość rozszerza informacje ReplyTo i określa, które identyfikator sesji powinny być ustawione dla odpowiedzi po wysłaniu do jednostki odpowiedzi. Zobacz Routing i korelacja komunikatów.
scheduledEnqueueTimeUtc	Data i godzina w formacie UTC, o której komunikat zostanie w kolejce. Ta właściwość zwraca czas w formacie UTC; podczas ustawiania właściwości podana wartość DateTime musi być również w formacie UTC. Ta wartość dotyczy opóźnionego wysyłania komunikatów. Służy do opóźniania wysyłania komunikatów do określonego czasu w przyszłości. Czas kolejkowania komunikatów nie oznacza, że wiadomość zostanie wysłana w tym samym czasie. Zostanie ono w kolejce, ale rzeczywisty czas wysyłania zależy od obciążenia kolejki i jego stanu.
sessionId	Identyfikator sesji dla jednostki obsługującej sesję. Maksymalna długość to 128 znaków. W przypadku jednostek obsługujących sesję ta wartość zdefiniowana przez aplikację określa przynależność sesji komunikatu. Komunikaty z tym samym identyfikatorem sesji podlegają blokadzie podsumowania i umożliwiają dokładne przetwarzanie w kolejności i demultiplexing. W przypadku jednostek nieświadomych sesji ta wartość jest ignorowana. Sesje komunikatów.
subject	Etykieta specyficzna dla aplikacji. Ta właściwość umożliwia aplikacji wskazanie przeznaczenia komunikatu odbiorcy w ustandaryzowanym. moda, podobna do wiersza tematu wiadomości e-mail. Zamapowana właściwość AMQP to "subject".
timeToLive	Czas wygaśnięcia wiadomości. Ta wartość jest względnym czasem trwania, po upływie którego komunikat wygasa, począwszy od momentu zaakceptowania wiadomości i jego przechowywania przez brokera w sposób przechwycony w enqueuedTimeUtcprogramie . Jeśli nie zostanie jawnie ustawiona, zakładana wartość to DefaultTimeToLive odpowiedniej kolejki lub tematu. Wartość na poziomie timeToLive komunikatu nie może być dłuższa niż ustawienie DefaultTimeToLive jednostki i jest ona w trybie dyskretnym dostosowywana, jeśli tak się stanie. Zobacz Wygaśnięcie.
to	Adres "do". Ta właściwość jest zarezerwowana do użytku w przyszłości w scenariuszach routingu i obecnie ignorowana przez samego brokera. Aplikacje mogą używać tej wartości w scenariuszach automatycznego przekazywania reguł w celu wskazania zamierzonego logicznego miejsca docelowego komunikatu.

Szczegóły właściwości

applicationProperties

Właściwości specyficzne dla aplikacji, które mogą być używane na potrzeby niestandardowych metadanych komunikatów.

applicationProperties?: {[key: string]: number | boolean | string | Date | null}

Wartość właściwości

{[key: string]: number | boolean | string | Date | null}

body

Treść wiadomości, która musi zostać wysłana lub odebrana. Jeśli aplikacja, która otrzymuje komunikat, nie używa tego zestawu SDK, przekonwertuj ładunek treści na tablicę bajtów lub bufor, aby uzyskać lepszą zgodność między językami.

body: any

Wartość właściwości

any

contentType

Typ zawartości wiadomości. Opcjonalnie opisano ładunek komunikatu z deskryptorem w formacie RFC2045, sekcja 5, na przykład "application/json".

contentType?: string

Wartość właściwości

string

correlationId

Identyfikator korelacji, który umożliwia aplikacji określenie kontekstu komunikatu na potrzeby korelacji, na przykład odzwierciedlające identyfikator MessageId komunikatu, na który jest odpowiadana. Zobacz Routing i korelacja komunikatów.

correlationId?: string | number | Buffer

Wartość właściwości

string | number | Buffer

messageId

Identyfikator komunikatu jest wartością zdefiniowaną przez aplikację, która jednoznacznie identyfikuje komunikat i jego ładunek.

Uwaga: liczby, które nie są liczbami całkowitymi, są niedozwolone.

messageId?: string | number | Buffer

Wartość właściwości

string | number | Buffer

partitionKey

Klucz partycji do wysyłania komunikatu do jednostki podzielonej na partycje. Maksymalna długość to 128 znaków. W przypadku jednostek partycjonowanych ustawienie tej wartości umożliwia przypisywanie powiązanych komunikatów do tej samej partycji wewnętrznej, dzięki czemu kolejność sekwencji przesyłania jest poprawnie rejestrowana. Partycja jest wybierana przez funkcję skrótu dla tej wartości i nie można jej wybrać bezpośrednio.

• W przypadku jednostek obsługujących sesję sessionId właściwość zastępuje tę wartość.
• W przypadku jednostek bez partycjonowania klucz partycji zostanie zignorowany

partitionKey?: string

Wartość właściwości

string

replyTo

Adres jednostki do wysyłania odpowiedzi. Ta opcjonalna i zdefiniowana przez aplikację wartość jest standardowym sposobem wyrażania ścieżki odpowiedzi do odbiorcy komunikatu. Gdy nadawca oczekuje odpowiedzi, ustawia wartość na bezwzględną lub względną ścieżkę kolejki lub tematu, do których oczekuje wysłania odpowiedzi. Zobacz Routing i korelacja komunikatów.

replyTo?: string

Wartość właściwości

string

replyToSessionId

Identyfikator sesji rozszerza replyTo adres. Maksymalna długość to 128 znaków. Ta wartość rozszerza informacje ReplyTo i określa, które identyfikator sesji powinny być ustawione dla odpowiedzi po wysłaniu do jednostki odpowiedzi. Zobacz Routing i korelacja komunikatów.

replyToSessionId?: string

Wartość właściwości

string

scheduledEnqueueTimeUtc

Data i godzina w formacie UTC, o której komunikat zostanie w kolejce. Ta właściwość zwraca czas w formacie UTC; podczas ustawiania właściwości podana wartość DateTime musi być również w formacie UTC. Ta wartość dotyczy opóźnionego wysyłania komunikatów. Służy do opóźniania wysyłania komunikatów do określonego czasu w przyszłości. Czas kolejkowania komunikatów nie oznacza, że wiadomość zostanie wysłana w tym samym czasie. Zostanie ono w kolejce, ale rzeczywisty czas wysyłania zależy od obciążenia kolejki i jego stanu.

scheduledEnqueueTimeUtc?: Date

Wartość właściwości

Date

sessionId

Identyfikator sesji dla jednostki obsługującej sesję. Maksymalna długość to 128 znaków. W przypadku jednostek obsługujących sesję ta wartość zdefiniowana przez aplikację określa przynależność sesji komunikatu. Komunikaty z tym samym identyfikatorem sesji podlegają blokadzie podsumowania i umożliwiają dokładne przetwarzanie w kolejności i demultiplexing. W przypadku jednostek nieświadomych sesji ta wartość jest ignorowana. Sesje komunikatów.

sessionId?: string

Wartość właściwości

string

subject

Etykieta specyficzna dla aplikacji. Ta właściwość umożliwia aplikacji wskazanie przeznaczenia komunikatu odbiorcy w ustandaryzowanym. moda, podobna do wiersza tematu wiadomości e-mail. Zamapowana właściwość AMQP to "subject".

subject?: string

Wartość właściwości

string

timeToLive

Czas wygaśnięcia wiadomości. Ta wartość jest względnym czasem trwania, po upływie którego komunikat wygasa, począwszy od momentu zaakceptowania wiadomości i jego przechowywania przez brokera w sposób przechwycony w enqueuedTimeUtcprogramie . Jeśli nie zostanie jawnie ustawiona, zakładana wartość to DefaultTimeToLive odpowiedniej kolejki lub tematu. Wartość na poziomie timeToLive komunikatu nie może być dłuższa niż ustawienie DefaultTimeToLive jednostki i jest ona w trybie dyskretnym dostosowywana, jeśli tak się stanie. Zobacz Wygaśnięcie.

timeToLive?: number

Wartość właściwości

number

to

Adres "do". Ta właściwość jest zarezerwowana do użytku w przyszłości w scenariuszach routingu i obecnie ignorowana przez samego brokera. Aplikacje mogą używać tej wartości w scenariuszach automatycznego przekazywania reguł w celu wskazania zamierzonego logicznego miejsca docelowego komunikatu.

to?: string

Wartość właściwości

string