CreateSubscriptionOptions interface

Pacchetto:

@azure/service-bus

Rappresenta le opzioni impostabili in una sottoscrizione

Extends

OperationOptions

Proprietà

autoDeleteOnIdle	Tempo massimo di inattività prima dell'eliminazione dell'entità. Questo valore deve essere specificato nel formato di durata ISO-8601, ad esempio "PT1M" per 1 minuto, "PT5S" per 5 secondi. Altre informazioni sul formato di durata ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations
availabilityStatus	Stato di disponibilità dell'entità di messaggistica.
deadLetteringOnFilterEvaluationExceptions	Determina il modo in cui il bus di servizio gestisce un messaggio che causa un'eccezione durante la valutazione del filtro di una sottoscrizione. Se il valore è impostato su true, il messaggio che ha causato l'eccezione verrà spostato nella coda secondaria dei messaggi non recapitabili della sottoscrizione. In caso contrario, verrà rimosso. Per impostazione predefinita, questo parametro è impostato su true, consentendo all'utente di analizzare la causa dell'eccezione. Il problema può essere dovuto a un messaggio in formato non corretto o a ipotesi errate nel filtro in relazione al formato del messaggio. Può essere impostata solo al momento della creazione dell'argomento.
deadLetteringOnMessageExpiration	Se è abilitato e scade un messaggio, il bus di servizio sposta il messaggio dalla coda nella sotto-coda della sottoscrizione. Se disabilitato, il messaggio verrà eliminato definitivamente dalla coda principale della sottoscrizione. La proprietà può essere impostata solo al momento della creazione della sottoscrizione.
defaultMessageTimeToLive	Determina la durata di un messaggio nella sottoscrizione. In base al fatto che la lettera non recapitabile sia abilitata, verrà spostato un messaggio il cui TTL è scaduto verrà spostato nell'oggetto DeadLtterQueue associato alla sottoscrizione o eliminato definitivamente. Questo valore deve essere specificato nel formato di durata ISO-8601, ad esempio "PT1M" per 1 minuto, "PT5S" per 5 secondi. Altre informazioni sul formato di durata ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations
defaultRuleOptions	Rappresenta le opzioni per creare la regola predefinita per la sottoscrizione.
enableBatchedOperations	Specifica se le operazioni in batch devono essere consentite.
forwardDeadLetteredMessagesTo	URL assoluto o nome della coda o dell'argomento a cui devono essere inoltrati i messaggi non recapitati. Ad esempio, un input URL assoluto sarebbe del modulo sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>
forwardTo	URL assoluto o nome della coda o dell'argomento a cui devono essere inoltrati i messaggi. Ad esempio, un input URL assoluto sarebbe del modulo sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>
lockDuration	Per le sottoscrizioni per cui non è definita una durata di blocco, viene applicato il valore predefinito. Se le sessioni sono abilitate, questa durata di blocco è applicabile per le sessioni e non per i messaggi. Questo valore deve essere specificato nel formato di durata ISO-8601, ad esempio "PT1M" per 1 minuto, "PT5S" per 5 secondi. Altre informazioni sul formato di durata ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations
maxDeliveryCount	Numero massimo di messaggi dopo il quale, se non è ancora risolto, viene spostato nella sotto-coda di lettere non recapitabili.
requiresSession	Se impostato su true, la sottoscrizione sarà a conoscenza della sessione e sarà supportato solo SessionReceiver. La sottoscrizione con riconoscimento della sessione non è supportata tramite REST. La proprietà può essere impostata solo al momento della creazione della sottoscrizione.
status	Stato dell'entità di messaggistica.
userMetadata	L'utente ha fornito informazioni sui metadati associate alla sottoscrizione. Usato per specificare contenuto testuale, ad esempio tag, etichette e così via. Il valore non deve superare i 1024 byte codificati in utf-8.

Proprietà ereditate

abortSignal	Segnale che può essere usato per interrompere le richieste.
onResponse	Funzione da chiamare ogni volta che viene ricevuta una risposta dal server durante l'esecuzione dell'operazione richiesta. Può essere chiamato più volte.
requestOptions	Opzioni utilizzate durante la creazione e l'invio di richieste HTTP per questa operazione.
serializerOptions	Opzioni per eseguire l'override del comportamento di serializzazione/de-serializzazione.
tracingOptions	Opzioni utilizzate quando la traccia è abilitata.

Dettagli proprietà

autoDeleteOnIdle

Tempo massimo di inattività prima dell'eliminazione dell'entità. Questo valore deve essere specificato nel formato di durata ISO-8601, ad esempio "PT1M" per 1 minuto, "PT5S" per 5 secondi.

Altre informazioni sul formato di durata ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations

autoDeleteOnIdle?: string

Valore della proprietà

string

availabilityStatus

Stato di disponibilità dell'entità di messaggistica.

availabilityStatus?: EntityAvailabilityStatus

Valore della proprietà

EntityAvailabilityStatus

deadLetteringOnFilterEvaluationExceptions

Determina il modo in cui il bus di servizio gestisce un messaggio che causa un'eccezione durante la valutazione del filtro di una sottoscrizione. Se il valore è impostato su true, il messaggio che ha causato l'eccezione verrà spostato nella coda secondaria dei messaggi non recapitabili della sottoscrizione. In caso contrario, verrà rimosso. Per impostazione predefinita, questo parametro è impostato su true, consentendo all'utente di analizzare la causa dell'eccezione. Il problema può essere dovuto a un messaggio in formato non corretto o a ipotesi errate nel filtro in relazione al formato del messaggio. Può essere impostata solo al momento della creazione dell'argomento.

deadLetteringOnFilterEvaluationExceptions?: boolean

Valore della proprietà

boolean

deadLetteringOnMessageExpiration

Se è abilitato e scade un messaggio, il bus di servizio sposta il messaggio dalla coda nella sotto-coda della sottoscrizione. Se disabilitato, il messaggio verrà eliminato definitivamente dalla coda principale della sottoscrizione. La proprietà può essere impostata solo al momento della creazione della sottoscrizione.

deadLetteringOnMessageExpiration?: boolean

Valore della proprietà

boolean

defaultMessageTimeToLive

Determina la durata di un messaggio nella sottoscrizione. In base al fatto che la lettera non recapitabile sia abilitata, verrà spostato un messaggio il cui TTL è scaduto verrà spostato nell'oggetto DeadLtterQueue associato alla sottoscrizione o eliminato definitivamente. Questo valore deve essere specificato nel formato di durata ISO-8601, ad esempio "PT1M" per 1 minuto, "PT5S" per 5 secondi.

Altre informazioni sul formato di durata ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations

defaultMessageTimeToLive?: string

Valore della proprietà

string

defaultRuleOptions

Rappresenta le opzioni per creare la regola predefinita per la sottoscrizione.

defaultRuleOptions?: { action?: SqlRuleAction, filter?: CorrelationRuleFilter | SqlRuleFilter, name: string }

Valore della proprietà

{ action?: SqlRuleAction, filter?: CorrelationRuleFilter | SqlRuleFilter, name: string }

enableBatchedOperations

Specifica se le operazioni in batch devono essere consentite.

enableBatchedOperations?: boolean

Valore della proprietà

boolean

forwardDeadLetteredMessagesTo

URL assoluto o nome della coda o dell'argomento a cui devono essere inoltrati i messaggi non recapitati. Ad esempio, un input URL assoluto sarebbe del modulo sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>

forwardDeadLetteredMessagesTo?: string

Valore della proprietà

string

forwardTo

URL assoluto o nome della coda o dell'argomento a cui devono essere inoltrati i messaggi. Ad esempio, un input URL assoluto sarebbe del modulo sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>

forwardTo?: string

Valore della proprietà

string

lockDuration

Per le sottoscrizioni per cui non è definita una durata di blocco, viene applicato il valore predefinito. Se le sessioni sono abilitate, questa durata di blocco è applicabile per le sessioni e non per i messaggi.

Questo valore deve essere specificato nel formato di durata ISO-8601, ad esempio "PT1M" per 1 minuto, "PT5S" per 5 secondi.

Altre informazioni sul formato di durata ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations

lockDuration?: string

Valore della proprietà

string

maxDeliveryCount

Numero massimo di messaggi dopo il quale, se non è ancora risolto, viene spostato nella sotto-coda di lettere non recapitabili.

maxDeliveryCount?: number

Valore della proprietà

number

requiresSession

Se impostato su true, la sottoscrizione sarà a conoscenza della sessione e sarà supportato solo SessionReceiver. La sottoscrizione con riconoscimento della sessione non è supportata tramite REST. La proprietà può essere impostata solo al momento della creazione della sottoscrizione.

requiresSession?: boolean

Valore della proprietà

boolean

status

Stato dell'entità di messaggistica.

status?: EntityStatus

Valore della proprietà

EntityStatus

userMetadata

L'utente ha fornito informazioni sui metadati associate alla sottoscrizione. Usato per specificare contenuto testuale, ad esempio tag, etichette e così via. Il valore non deve superare i 1024 byte codificati in utf-8.

userMetadata?: string

Valore della proprietà

string

Dettagli proprietà ereditate

abortSignal

Segnale che può essere usato per interrompere le richieste.

abortSignal?: AbortSignalLike

Valore della proprietà

AbortSignalLike

Ereditato daOperationOptions.abortSignal

onResponse

Funzione da chiamare ogni volta che viene ricevuta una risposta dal server durante l'esecuzione dell'operazione richiesta. Può essere chiamato più volte.

onResponse?: RawResponseCallback

Valore della proprietà

RawResponseCallback

Ereditato daOperationOptions.onResponse

requestOptions

Opzioni utilizzate durante la creazione e l'invio di richieste HTTP per questa operazione.

requestOptions?: OperationRequestOptions

Valore della proprietà

OperationRequestOptions

Ereditato daOperationOptions.requestOptions

serializerOptions

Opzioni per eseguire l'override del comportamento di serializzazione/de-serializzazione.

serializerOptions?: SerializerOptions

Valore della proprietà

SerializerOptions

Ereditato daOperationOptions.serializerOptions

tracingOptions

Opzioni utilizzate quando la traccia è abilitata.

tracingOptions?: OperationTracingOptions

Valore della proprietà

OperationTracingOptions

Ereditato daOperationOptions.tracingOptions