ServiceBusMessage interface

Pacchetto:

@azure/service-bus

Descrive il messaggio da inviare al bus di servizio.

Proprietà

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 il MessageId di un messaggio a cui viene inviata una risposta. 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 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 esatta in ordine e il demultiplexing. Per le entità senza riconoscimento della sessione, questo valore viene ignorato. Sessioni di messaggi.
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 è "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 automaticamente se lo fa. Vedere Scadenza.
to	Indirizzo "a". 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 concatenamento automatico basato su regole per indicare la destinazione logica prevista del messaggio.

Dettagli proprietà

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}

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

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

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 inviata una risposta. Vedere Routing e correlazione dei messaggi.

correlationId?: string | number | Buffer

Valore della proprietà

string | number | Buffer

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

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

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

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

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

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

sessionId?: string

Valore della proprietà

string

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

subject?: string

Valore della proprietà

string

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 automaticamente se lo fa. Vedere Scadenza.

timeToLive?: number

Valore della proprietà

number

to

Indirizzo "a". 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 concatenamento automatico basato su regole per indicare la destinazione logica prevista del messaggio.

to?: string

Valore della proprietà

string