ServiceBusReceivedMessage interface

Pacchetto:

@azure/service-bus

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

Extends

ServiceBusMessage

Proprietà

deadLetterErrorDescription	Descrizione dell'errore per il deadlettering del messaggio.
deadLetterReason	Motivo del deadlettering del messaggio.
deadLetterSource	Nome della coda o della sottoscrizione in cui è stato accodato il messaggio, prima che fosse inattivo. Impostato solo nei messaggi non recapitabili e successivamente inoltrati automaticamente dalla coda secondaria dei messaggi non recapitabili a un'altra entità. Indica l'entità in cui il messaggio è stato recapitato in un messaggio non recapitato.
deliveryCount	Numero di consegne che sono state tentate per questo messaggio. Il conteggio viene incrementato alla scadenza di un blocco di messaggi oppure il messaggio viene abbandonato in modo esplicito usando il metodo abandon() nel messaggio.
enqueuedSequenceNumber	Numero di sequenza originale del messaggio. Per i messaggi inoltrati automaticamente, questa proprietà riflette il numero di sequenza assegnato per la prima volta al messaggio al punto di invio originale.
enqueuedTimeUtc	Istante 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 più disponibile per il recupero dall'entità a causa della scadenza. Questa proprietà viene calcolata da 2 altre proprietà nel messaggio: enqueuedTimeUtc + timeToLive.
lockedUntilUtc	Istante UTC fino al quale il messaggio viene bloccato nella coda o nella sottoscrizione. Quando il blocco scade, il deliveryCount viene incrementato e il messaggio è nuovamente disponibile per il recupero. Non applicabile quando il messaggio viene ricevuto in modalità di ricezione receiveAndDelete. modo.
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 modalità di ricezione receiveAndDelete. modo.
sequenceNumber	Numero univoco assegnato a un messaggio dal bus di servizio. Il numero di sequenza è un intero a 64 bit univoco assegnato a un messaggio perché viene accettato e archiviato dal broker e funziona come identificatore vero. Per le entità partizionate, i primi 16 bit riflettono l'identificatore di partizione. I numeri di sequenza aumentano in modo monotonico. Passano a 0 quando l'intervallo di 48-64 bit viene esaurito. max safe integer attualmente supportato da Javascript è 2^53 - 1. Il numero di sequenza è un tipo di Long AMQP che può essere lungo fino a 64 bit. Per rappresentare che si usa una libreria denominata long.js. Si prevede che i clienti usino il tipo Long 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 uno stato pianificato, tutti gli altri messaggi hanno lo stato attivo.

Proprietà ereditate

applicationProperties	Proprietà specifiche dell'applicazione che possono essere usate per i metadati del messaggio 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 una migliore compatibilità tra linguaggi.
contentType	Tipo di contenuto del messaggio. Facoltativamente, descrive il payload del messaggio, con un descrittore che segue il formato di 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 il MessageId di un messaggio a cui viene risposto. Vedere routing e correlazione dei messaggi.
messageId	L'identificatore del messaggio è un valore definito dall'applicazione che identifica in modo univoco il messaggio e il relativo 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 entità partizionate, l'impostazione di questo valore consente di assegnare messaggi correlati alla stessa partizione interna, in modo che l'ordine della sequenza di invio venga registrato correttamente. La partizione viene scelta da una funzione hash su questo valore e non può essere scelta direttamente. Per le entità con riconoscimento della sessione, la proprietà sessionId esegue l'override 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 al destinatario del messaggio. Quando un mittente prevede una risposta, imposta il valore sul percorso assoluto o relativo della coda o dell'argomento a cui si aspetta che la risposta venga inviata. Vedere routing e correlazione dei messaggi.
replyToSessionId	Identificatore di sessione che aumenta l'indirizzo replyTo. La lunghezza massima è di 128 caratteri. Questo valore aumenta le informazioni ReplyTo e specifica quale SessionId deve essere impostato per la risposta quando viene inviata all'entità di risposta. Vedere routing e correlazione dei messaggi.
scheduledEnqueueTimeUtc	Data e ora in formato UTC in cui verrà accodato il messaggio. Questa proprietà restituisce l'ora in formato UTC; quando si imposta la proprietà , anche il valore DateTime specificato deve essere in formato UTC. Questo valore è per l'invio ritardato del messaggio. Viene utilizzato per ritardare l'invio di messaggi a un momento specifico in futuro. Il tempo di accodamento dei messaggi non significa che il messaggio verrà inviato contemporaneamente. Verrà accodato, 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 e la demultiplexing esatte nell'ordine. Per le entità session-unware, questo valore viene ignorato. sessioni di messaggi.
subject	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 è "subject".
timeToLive	Valore di durata 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. Quando non è impostato in modo esplicito, il valore assunto è DefaultTimeToLive per la rispettiva coda o argomento. Un valore di timeToLive a livello di messaggio non può essere più lungo dell'impostazione DefaultTimeToLive dell'entità e viene modificato automaticamente se lo fa. Vedere Expiration.
to	Indirizzo "to". Questa proprietà è riservata per un uso futuro negli scenari di routing e attualmente ignorata dal broker stesso. Le applicazioni possono usare questo valore negli scenari di concatenamento automatico concatenamento automatico per indicare la destinazione logica prevista del messaggio.

Dettagli proprietà

deadLetterErrorDescription

Descrizione dell'errore per il deadlettering del messaggio.

deadLetterErrorDescription?: string

Valore della proprietà

string

deadLetterReason

Motivo del deadlettering del messaggio.

deadLetterReason?: string

Valore della proprietà

string

deadLetterSource

Nome della coda o della sottoscrizione in cui è stato accodato il messaggio, prima che fosse inattivo. Impostato solo nei messaggi non recapitabili e successivamente inoltrati automaticamente dalla coda secondaria dei messaggi non recapitabili a un'altra entità. Indica l'entità in cui il messaggio è stato recapitato in un messaggio non recapitato.

deadLetterSource?: string

Valore della proprietà

string

deliveryCount

Numero di consegne che sono state tentate per questo messaggio. Il conteggio viene incrementato alla scadenza di un blocco di messaggi oppure il messaggio viene abbandonato in modo esplicito usando il metodo abandon() nel messaggio.

deliveryCount?: number

Valore della proprietà

number

enqueuedSequenceNumber

Numero di sequenza originale del messaggio. Per i messaggi inoltrati automaticamente, questa proprietà riflette il numero di sequenza assegnato per la prima volta al messaggio al punto di invio originale.

enqueuedSequenceNumber?: number

Valore della proprietà

number

enqueuedTimeUtc

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

Istante UTC fino al quale il messaggio viene bloccato nella coda o nella sottoscrizione. Quando il blocco scade, il deliveryCount viene incrementato e il messaggio è nuovamente disponibile per il recupero.

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

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 modalità di ricezione receiveAndDelete. modo.

lockToken?: string

Valore della proprietà

string

sequenceNumber

Numero univoco assegnato a un messaggio dal bus di servizio. Il numero di sequenza è un intero a 64 bit univoco assegnato a un messaggio perché viene accettato e archiviato dal broker e funziona come identificatore vero. Per le entità partizionate, i primi 16 bit riflettono l'identificatore di partizione. I numeri di sequenza aumentano in modo monotonico. Passano a 0 quando l'intervallo di 48-64 bit viene esaurito.

max safe integer attualmente supportato da Javascript è 2^53 - 1. Il numero di sequenza è un tipo di Long AMQP che può essere lungo fino a 64 bit. Per rappresentare che si usa una libreria denominata long.js. Si prevede che i clienti usino il tipo Long 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 uno stato pianificato, tutti gli altri messaggi hanno lo 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 del messaggio 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 una migliore compatibilità tra linguaggi.

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 di 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 il 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

L'identificatore del messaggio è un valore definito dall'applicazione che identifica in modo univoco il messaggio e il relativo 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 entità partizionate, l'impostazione di questo valore consente di assegnare messaggi correlati alla stessa partizione interna, in modo che l'ordine della sequenza di invio venga registrato correttamente. La partizione viene scelta da una funzione hash su questo valore e non può essere scelta direttamente.

• Per le entità con riconoscimento della sessione, la proprietà sessionId esegue l'override 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 al destinatario del messaggio. Quando un mittente prevede una risposta, imposta il valore sul percorso assoluto o relativo della coda o dell'argomento a cui si aspetta che la risposta venga inviata. 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 le informazioni ReplyTo e specifica quale SessionId deve essere impostato per la risposta quando viene inviata all'entità di risposta. Vedere routing e correlazione dei messaggi.

replyToSessionId?: string

Valore della proprietà

string

Ereditato daServiceBusMessage.replyToSessionId

scheduledEnqueueTimeUtc

Data e ora in formato UTC in cui verrà accodato il messaggio. Questa proprietà restituisce l'ora in formato UTC; quando si imposta la proprietà , anche il valore DateTime specificato deve essere in formato UTC. Questo valore è per l'invio ritardato del messaggio. Viene utilizzato per ritardare l'invio di messaggi a un momento specifico in futuro. Il tempo di accodamento dei messaggi non significa che il messaggio verrà inviato contemporaneamente. Verrà accodato, 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 e la demultiplexing esatte nell'ordine. Per le entità session-unware, questo valore viene ignorato. sessioni di messaggi.

sessionId?: string

Valore della proprietà

string

Ereditato daServiceBusMessage.sessionId

subject

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 è "subject".

subject?: string

Valore della proprietà

string

Ereditato daServiceBusMessage.subject

timeToLive

Valore di durata 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. Quando non è impostato in modo esplicito, il valore assunto è DefaultTimeToLive per la rispettiva coda o argomento. Un valore di timeToLive a livello di messaggio non può essere più lungo dell'impostazione DefaultTimeToLive dell'entità e viene modificato automaticamente se lo fa. Vedere Expiration.

timeToLive?: number

Valore della proprietà

number

ereditato daServiceBusMessage.timeToLive

to

Indirizzo "to". Questa proprietà è riservata per un uso futuro negli scenari di routing e attualmente ignorata dal broker stesso. Le applicazioni possono usare questo valore negli scenari di concatenamento automatico concatenamento automatico per indicare la destinazione logica prevista del messaggio.

to?: string

Valore della proprietà

string

ereditato daServiceBusMessage.to