ServiceBusReceivedMessage interface

Pacchetto:

@azure/service-bus

Descrive il messaggio ricevuto dal bus di servizio durante le operazioni di anteprima e quindi non può essere risolto.

Extends

ServiceBusMessage

Proprietà

deadLetterErrorDescription	Descrizione dell'errore per l'deadlettering del messaggio.
deadLetterReason	Motivo della deadlettering del messaggio.
deadLetterSource	Nome della coda o della sottoscrizione in cui il messaggio è stato accodato, prima che sia stato disattivato. Impostato solo nei messaggi non recapitati e successivamente inoltrati automaticamente dalla sotto-coda di lettere non recapitabili a un'altra entità. Indica l'entità in cui il messaggio è stato impostato come non recapitabile.
deliveryCount	Numero di tentativi di recapito per questo messaggio. Il conteggio viene incrementato quando scade un blocco di messaggi oppure il messaggio viene abbandonato in modo esplicito usando il abandon() metodo nel messaggio.
enqueuedSequenceNumber	Numero di sequenza originale del messaggio. Per i messaggi inoltrati automaticamente questa proprietà rispecchia il numero di sequenza assegnato inizialmente al messaggio nel punto di invio originale.
enqueuedTimeUtc	Ora UTC in cui il messaggio è stato accettato e archiviato nel bus di servizio.
expiresAtUtc	Istante UTC in cui il messaggio viene contrassegnato per la rimozione e non risulta più disponibile per il recupero dall'entità a causa della scadenza. Questa proprietà viene calcolata da 2 altre proprietà nel messaggio: enqueuedTimeUtc + timeToLive.
lockedUntilUtc	L'istante UTC fino al quale il messaggio viene bloccato nella coda o nella sottoscrizione. Al termine del blocco, l'oggetto deliveryCount viene incrementato e il messaggio è nuovamente disponibile per il recupero. Non applicabile quando il messaggio viene ricevuto in receiveAndDelete modalità di ricezione. .
lockToken	Il token di blocco è un riferimento al blocco mantenuto dal broker in peekLock modalità di ricezione. I blocchi vengono usati internamente per risolvere i messaggi, come illustrato nella documentazione del prodotto in modo più dettagliato Non applicabile quando il messaggio viene ricevuto in receiveAndDelete modalità di ricezione. .
sequenceNumber	Numero univoco assegnato a un messaggio dal bus di servizio. Il numero di sequenza è un numero intero univoco a 64 bit assegnato a un messaggio quando viene accettato e archiviato dal broker. Viene usato come identificatore effettivo del messaggio. Per le entità partizionate, i primi 16 bit rispecchiano l'identificatore della partizione. I numeri di sequenza aumentano monotonicamente. Viene eseguito il rollover a 0 all'esaurimento dell'intervallo compreso tra 48 e 64 bit. Numero intero massimo sicuro attualmente supportato da Javascript è 2^53 - 1. Il numero di sequenza è un tipo AMQP Long che può essere fino a 64 bit lunghi. Per rappresentare che si usa una libreria denominata long.js. Si prevede che i clienti usino il Long tipo esportato da questa libreria.
state	Lo stato del messaggio può essere attivo, posticipato o pianificato. I messaggi posticipati hanno stato posticipato, i messaggi pianificati hanno stato pianificato, tutti gli altri messaggi hanno stato attivo.

Proprietà ereditate

applicationProperties	Proprietà specifiche dell'applicazione che possono essere usate per i metadati dei messaggi personalizzati.
body	Corpo del messaggio che deve essere inviato o ricevuto. Se l'applicazione che riceve il messaggio non usa questo SDK, convertire il payload del corpo in una matrice di byte o buffer per migliorare la compatibilità tra linguaggio.
contentType	Tipo di contenuto del messaggio. Facoltativamente descrive il payload del messaggio, con un descrittore che segue il formato RFC2045, Sezione 5, ad esempio "application/json".
correlationId	Identificatore di correlazione che consente a un'applicazione di specificare un contesto per il messaggio ai fini della correlazione, ad esempio riflettendo MessageId di un messaggio a cui viene risposto. Vedere Routing e correlazione dei messaggi.
messageId	Questo identificatore di messaggio è un valore definito dall'applicazione che identifica in modo univoco il messaggio e il rispettivo payload. Nota: i numeri non interi non sono consentiti.
partitionKey	Chiave di partizione per l'invio di un messaggio a un'entità partizionata. La lunghezza massima è di 128 caratteri. Per le entità partizionate, la configurazione di questo valore consente di assegnare i messaggi correlati alla stessa partizione interna, in modo che l'ordine della sequenza di invio sia registrato correttamente. La partizione viene scelta in base a una funzione hash su questo valore e non può essere scelta direttamente. Per le entità con riconoscimento della sessione, la proprietà esegue l'override sessionId di questo valore. Per le entità non partizionate, la chiave di partizione verrà ignorata
replyTo	Indirizzo di un'entità a cui inviare risposte. Questo valore facoltativo e definito dall'applicazione è un modo standard per esprimere un percorso di risposta verso il ricevitore del messaggio. Quando un mittente si aspetta una risposta, imposta il valore sul percorso assoluto o relativo della coda o dell'argomento a cui si prevede che venga inviata la risposta. Vedere Routing e correlazione dei messaggi.
replyToSessionId	Identificatore di sessione che aumenta l'indirizzo replyTo . La lunghezza massima è di 128 caratteri. Questo valore aumenta l'informazione ReplyTo e specifica quale valore SessionId deve essere impostato per la risposta in caso di invio all'entità di risposta. Vedere Routing e correlazione dei messaggi.
scheduledEnqueueTimeUtc	Data e ora utc in cui verrà eseguito il testo. Questa proprietà restituisce l'ora in formato UTC; quando si imposta la proprietà, il valore DateTime specificato deve essere anche in formato UTC. Questo valore è per l'invio di messaggi ritardati. Viene usato per ritardare l'invio di messaggi a un momento specifico in futuro. Il tempo di esecuzione del messaggio non significa che il messaggio verrà inviato contemporaneamente. Verrà eseguito il codice, ma il tempo di invio effettivo dipende dal carico di lavoro della coda e dal relativo stato.
sessionId	Identificatore di sessione per un'entità con riconoscimento della sessione. La lunghezza massima è di 128 caratteri. Per le entità con riconoscimento della sessione, questo valore definito dall'applicazione specifica l'affiliazione di sessione del messaggio. I messaggi con lo stesso identificatore di sessione sono soggetti al blocco di riepilogo e consentono l'elaborazione esatta in ordine e il demultiplexing. Per le entità senza riconoscimento della sessione, questo valore viene ignorato. Sessioni di messaggio.
subject	L'etichetta specifica dell'applicazione. Questa proprietà consente all'applicazione di indicare lo scopo del messaggio al ricevitore in un oggetto standardizzato. moda, simile a una riga dell'oggetto di posta elettronica. La proprietà AMQP mappata è "soggetto".
timeToLive	Valore TTL del messaggio. Questo valore è la durata relativa dopo la quale il messaggio scade, a partire dall'istante in cui il messaggio è stato accettato e archiviato dal broker, come acquisito in enqueuedTimeUtc. Se non è configurata in modo esplicito, il valore predefinito è il DefaultTimeToLive per la coda o l'argomento corrispondente. Un valore a livello timeToLive di messaggio non può essere più lungo dell'impostazione DefaultTimeToLive dell'entità e viene modificato in modo invisibile se lo esegue. Vedere Scadenza.
to	Indirizzo "to". Questa proprietà è riservata per l'uso futuro negli scenari di routing e viene attualmente ignorata dal broker. Le applicazioni possono usare questo valore negli scenari di inoltro automatico basati su regole per indicare la destinazione logica prevista del messaggio.

Dettagli proprietà

deadLetterErrorDescription

Descrizione dell'errore per l'deadlettering del messaggio.

deadLetterErrorDescription?: string

Valore della proprietà

string

deadLetterReason

Motivo della deadlettering del messaggio.

deadLetterReason?: string

Valore della proprietà

string

deadLetterSource

Nome della coda o della sottoscrizione in cui il messaggio è stato accodato, prima che sia stato disattivato. Impostato solo nei messaggi non recapitati e successivamente inoltrati automaticamente dalla sotto-coda di lettere non recapitabili a un'altra entità. Indica l'entità in cui il messaggio è stato impostato come non recapitabile.

deadLetterSource?: string

Valore della proprietà

string

deliveryCount

Numero di tentativi di recapito per questo messaggio. Il conteggio viene incrementato quando scade un blocco di messaggi oppure il messaggio viene abbandonato in modo esplicito usando il abandon() metodo nel messaggio.

deliveryCount?: number

Valore della proprietà

number

enqueuedSequenceNumber

Numero di sequenza originale del messaggio. Per i messaggi inoltrati automaticamente questa proprietà rispecchia il numero di sequenza assegnato inizialmente al messaggio nel punto di invio originale.

enqueuedSequenceNumber?: number

Valore della proprietà

number

enqueuedTimeUtc

Ora UTC in cui il messaggio è stato accettato e archiviato nel bus di servizio.

enqueuedTimeUtc?: Date

Valore della proprietà

Date

expiresAtUtc

Istante UTC in cui il messaggio viene contrassegnato per la rimozione e non risulta più disponibile per il recupero dall'entità a causa della scadenza. Questa proprietà viene calcolata da 2 altre proprietà nel messaggio: enqueuedTimeUtc + timeToLive.

expiresAtUtc?: Date

Valore della proprietà

Date

lockedUntilUtc

L'istante UTC fino al quale il messaggio viene bloccato nella coda o nella sottoscrizione. Al termine del blocco, l'oggetto deliveryCount viene incrementato e il messaggio è nuovamente disponibile per il recupero.

• Non applicabile quando il messaggio viene ricevuto in receiveAndDelete modalità di ricezione. .

lockedUntilUtc?: Date

Valore della proprietà

Date

lockToken

Il token di blocco è un riferimento al blocco mantenuto dal broker in peekLock modalità di ricezione. I blocchi vengono usati internamente per risolvere i messaggi, come illustrato nella documentazione del prodotto in modo più dettagliato

• Non applicabile quando il messaggio viene ricevuto in receiveAndDelete modalità di ricezione. .

lockToken?: string

Valore della proprietà

string

sequenceNumber

Numero univoco assegnato a un messaggio dal bus di servizio. Il numero di sequenza è un numero intero univoco a 64 bit assegnato a un messaggio quando viene accettato e archiviato dal broker. Viene usato come identificatore effettivo del messaggio. Per le entità partizionate, i primi 16 bit rispecchiano l'identificatore della partizione. I numeri di sequenza aumentano monotonicamente. Viene eseguito il rollover a 0 all'esaurimento dell'intervallo compreso tra 48 e 64 bit.

Numero intero massimo sicuro attualmente supportato da Javascript è 2^53 - 1. Il numero di sequenza è un tipo AMQP Long che può essere fino a 64 bit lunghi. Per rappresentare che si usa una libreria denominata long.js. Si prevede che i clienti usino il Long tipo esportato da questa libreria.

sequenceNumber?: Long

Valore della proprietà

Long

state

Lo stato del messaggio può essere attivo, posticipato o pianificato. I messaggi posticipati hanno stato posticipato, i messaggi pianificati hanno stato pianificato, tutti gli altri messaggi hanno stato attivo.

state: "active" | "deferred" | "scheduled"

Valore della proprietà

"active" | "deferred" | "scheduled"

Dettagli proprietà ereditate

applicationProperties

Proprietà specifiche dell'applicazione che possono essere usate per i metadati dei messaggi personalizzati.

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

Valore della proprietà

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

Ereditato daServiceBusMessage.applicationProperties

body

Corpo del messaggio che deve essere inviato o ricevuto. Se l'applicazione che riceve il messaggio non usa questo SDK, convertire il payload del corpo in una matrice di byte o buffer per migliorare la compatibilità tra linguaggio.

body: any

Valore della proprietà

any

Ereditato daServiceBusMessage.body

contentType

Tipo di contenuto del messaggio. Facoltativamente descrive il payload del messaggio, con un descrittore che segue il formato RFC2045, Sezione 5, ad esempio "application/json".

contentType?: string

Valore della proprietà

string

Ereditato daServiceBusMessage.contentType

correlationId

Identificatore di correlazione che consente a un'applicazione di specificare un contesto per il messaggio ai fini della correlazione, ad esempio riflettendo MessageId di un messaggio a cui viene risposto. Vedere Routing e correlazione dei messaggi.

correlationId?: string | number | Buffer

Valore della proprietà

string | number | Buffer

Ereditato daServiceBusMessage.correlationId

messageId

Questo identificatore di messaggio è un valore definito dall'applicazione che identifica in modo univoco il messaggio e il rispettivo payload.

Nota: i numeri non interi non sono consentiti.

messageId?: string | number | Buffer

Valore della proprietà

string | number | Buffer

Ereditato daServiceBusMessage.messageId

partitionKey

Chiave di partizione per l'invio di un messaggio a un'entità partizionata. La lunghezza massima è di 128 caratteri. Per le entità partizionate, la configurazione di questo valore consente di assegnare i messaggi correlati alla stessa partizione interna, in modo che l'ordine della sequenza di invio sia registrato correttamente. La partizione viene scelta in base a una funzione hash su questo valore e non può essere scelta direttamente.

• Per le entità con riconoscimento della sessione, la proprietà esegue l'override sessionId di questo valore.
• Per le entità non partizionate, la chiave di partizione verrà ignorata

partitionKey?: string

Valore della proprietà

string

Ereditato daServiceBusMessage.partitionKey

replyTo

Indirizzo di un'entità a cui inviare risposte. Questo valore facoltativo e definito dall'applicazione è un modo standard per esprimere un percorso di risposta verso il ricevitore del messaggio. Quando un mittente si aspetta una risposta, imposta il valore sul percorso assoluto o relativo della coda o dell'argomento a cui si prevede che venga inviata la risposta. Vedere Routing e correlazione dei messaggi.

replyTo?: string

Valore della proprietà

string

Ereditato daServiceBusMessage.replyTo

replyToSessionId

Identificatore di sessione che aumenta l'indirizzo replyTo . La lunghezza massima è di 128 caratteri. Questo valore aumenta l'informazione ReplyTo e specifica quale valore SessionId deve essere impostato per la risposta in caso di invio all'entità di risposta. Vedere Routing e correlazione dei messaggi.

replyToSessionId?: string

Valore della proprietà

string

Ereditato daServiceBusMessage.replyToSessionId

scheduledEnqueueTimeUtc

Data e ora utc in cui verrà eseguito il testo. Questa proprietà restituisce l'ora in formato UTC; quando si imposta la proprietà, il valore DateTime specificato deve essere anche in formato UTC. Questo valore è per l'invio di messaggi ritardati. Viene usato per ritardare l'invio di messaggi a un momento specifico in futuro. Il tempo di esecuzione del messaggio non significa che il messaggio verrà inviato contemporaneamente. Verrà eseguito il codice, ma il tempo di invio effettivo dipende dal carico di lavoro della coda e dal relativo stato.

scheduledEnqueueTimeUtc?: Date

Valore della proprietà

Date

Ereditato daServiceBusMessage.scheduledEnqueueTimeUtc

sessionId

Identificatore di sessione per un'entità con riconoscimento della sessione. La lunghezza massima è di 128 caratteri. Per le entità con riconoscimento della sessione, questo valore definito dall'applicazione specifica l'affiliazione di sessione del messaggio. I messaggi con lo stesso identificatore di sessione sono soggetti al blocco di riepilogo e consentono l'elaborazione esatta in ordine e il demultiplexing. Per le entità senza riconoscimento della sessione, questo valore viene ignorato. Sessioni di messaggio.

sessionId?: string

Valore della proprietà

string

Ereditato daServiceBusMessage.sessionId

subject

L'etichetta specifica dell'applicazione. Questa proprietà consente all'applicazione di indicare lo scopo del messaggio al ricevitore in un oggetto standardizzato. moda, simile a una riga dell'oggetto di posta elettronica. La proprietà AMQP mappata è "soggetto".

subject?: string

Valore della proprietà

string

Ereditato daServiceBusMessage.subject

timeToLive

Valore TTL del messaggio. Questo valore è la durata relativa dopo la quale il messaggio scade, a partire dall'istante in cui il messaggio è stato accettato e archiviato dal broker, come acquisito in enqueuedTimeUtc. Se non è configurata in modo esplicito, il valore predefinito è il DefaultTimeToLive per la coda o l'argomento corrispondente. Un valore a livello timeToLive di messaggio non può essere più lungo dell'impostazione DefaultTimeToLive dell'entità e viene modificato in modo invisibile se lo esegue. Vedere Scadenza.

timeToLive?: number

Valore della proprietà

number

Ereditato daServiceBusMessage.timeToLive

to

Indirizzo "to". Questa proprietà è riservata per l'uso futuro negli scenari di routing e viene attualmente ignorata dal broker. Le applicazioni possono usare questo valore negli scenari di inoltro automatico basati su regole per indicare la destinazione logica prevista del messaggio.

to?: string

Valore della proprietà

string

Ereditato daServiceBusMessage.to