Condividi tramite

CreateQueueOptions interface

  • Riferimento
Pacchetto:
@azure/service-bus

Rappresenta le opzioni impostabili in una coda

Extends
OperationOptions

Proprietà

authorizationRules

Regole di autorizzazione nella coda
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.
deadLetteringOnMessageExpiration

Se è abilitato e scade un messaggio, il bus di servizio sposta il messaggio dalla coda alla coda dei messaggi non recapitabili della coda. Se disabilitato, il messaggio verrà eliminato definitivamente dalla coda. Può essere impostata solo al momento della creazione della coda.
defaultMessageTimeToLive

A seconda che DeadLettering sia abilitato, un messaggio viene automaticamente spostato nella coda secondaria dei messaggi non recapitabili o eliminato se è stato archiviato nella coda per più tempo del tempo specificato. Questo valore viene sovrascritto dalla durata (TTL) specificata per il messaggio solo se tale durata è inferiore a quella specificata per la coda. Questo valore non è modificabile dopo la creazione della coda. 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
duplicateDetectionHistoryTimeWindow

Specifica l'intervallo di tempo durante il quale il bus di servizio rileva la duplicazione dei 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
enableBatchedOperations

Specifica se le operazioni in batch devono essere consentite.
enableExpress

Specifica se le entità express sono abilitate nella coda.
enablePartitioning

Specifica se la coda deve essere partizionata.
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 sarà del modulo sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>
forwardTo

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

Determina l'intervallo di tempo, in secondi, in cui un messaggio deve essere bloccato per consentire l'elaborazione da parte di un ricevitore. Trascorso questo intervallo di tempo, il messaggio viene sbloccato ed è disponibile per il ricevitore successivo. 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

Il numero massimo di messaggi dopo il quale, se non è ancora risolto, viene spostato nella coda secondaria dei messaggi non recapitabili.
maxMessageSizeInKilobytes

Dimensione massima del messaggio in kilobyte per i messaggi inviati a questa coda.

(Configurabile solo per lo spazio dei nomi del bus di servizio di livello Premium).
maxSizeInMegabytes

Specifica la dimensione massima consentita per la coda in megabyte. Avrà esito negativo qualsiasi tentativo di accodare un messaggio che causi un superamento di tale valore da parte della coda.
requiresDuplicateDetection

Se abilitata, l'argomento rileverà i messaggi duplicati nell'intervallo di tempo specificato dalla proprietà DuplicateDetectionHistoryTimeWindow. Può essere impostata solo al momento della creazione della coda.
requiresSession

Se impostato su true, la coda sarà compatibile con la sessione e sarà supportato solo SessionReceiver. Le code in grado di riconoscere le sessioni non sono supportate tramite REST. Può essere impostata solo al momento della creazione della coda.
status

Stato dell'entità di messaggistica.
userMetadata

L'utente ha fornito informazioni sui metadati associate alla coda. 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

Una 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à

authorizationRules

Regole di autorizzazione nella coda

authorizationRules?: AuthorizationRule[]

Valore della proprietà

AuthorizationRule[]

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

deadLetteringOnMessageExpiration

Se è abilitato e scade un messaggio, il bus di servizio sposta il messaggio dalla coda alla coda dei messaggi non recapitabili della coda. Se disabilitato, il messaggio verrà eliminato definitivamente dalla coda. Può essere impostata solo al momento della creazione della coda.

deadLetteringOnMessageExpiration?: boolean

Valore della proprietà

boolean

defaultMessageTimeToLive

A seconda che DeadLettering sia abilitato, un messaggio viene automaticamente spostato nella coda secondaria dei messaggi non recapitabili o eliminato se è stato archiviato nella coda per più tempo del tempo specificato. Questo valore viene sovrascritto dalla durata (TTL) specificata per il messaggio solo se tale durata è inferiore a quella specificata per la coda. Questo valore non è modificabile dopo la creazione della coda. 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

duplicateDetectionHistoryTimeWindow

Specifica l'intervallo di tempo durante il quale il bus di servizio rileva la duplicazione dei 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

duplicateDetectionHistoryTimeWindow?: string

Valore della proprietà

string

enableBatchedOperations

Specifica se le operazioni in batch devono essere consentite.

enableBatchedOperations?: boolean

Valore della proprietà

boolean

enableExpress

Specifica se le entità express sono abilitate nella coda.

enableExpress?: boolean

Valore della proprietà

boolean

enablePartitioning

Specifica se la coda deve essere partizionata.

enablePartitioning?: 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 sarà 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 inoltrare i messaggi. Ad esempio, un input URL assoluto sarà del modulo sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>

forwardTo?: string

Valore della proprietà

string

lockDuration

Determina l'intervallo di tempo, in secondi, in cui un messaggio deve essere bloccato per consentire l'elaborazione da parte di un ricevitore. Trascorso questo intervallo di tempo, il messaggio viene sbloccato ed è disponibile per il ricevitore successivo. 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

Il numero massimo di messaggi dopo il quale, se non è ancora risolto, viene spostato nella coda secondaria dei messaggi non recapitabili.

maxDeliveryCount?: number

Valore della proprietà

number

maxMessageSizeInKilobytes

Dimensione massima del messaggio in kilobyte per i messaggi inviati a questa coda.

(Configurabile solo per lo spazio dei nomi del bus di servizio di livello Premium).

maxMessageSizeInKilobytes?: number

Valore della proprietà

number

maxSizeInMegabytes

Specifica la dimensione massima consentita per la coda in megabyte. Avrà esito negativo qualsiasi tentativo di accodare un messaggio che causi un superamento di tale valore da parte della coda.

maxSizeInMegabytes?: number

Valore della proprietà

number

requiresDuplicateDetection

Se abilitata, l'argomento rileverà i messaggi duplicati nell'intervallo di tempo specificato dalla proprietà DuplicateDetectionHistoryTimeWindow. Può essere impostata solo al momento della creazione della coda.

requiresDuplicateDetection?: boolean

Valore della proprietà

boolean

requiresSession

Se impostato su true, la coda sarà compatibile con la sessione e sarà supportato solo SessionReceiver. Le code in grado di riconoscere le sessioni non sono supportate tramite REST. Può essere impostata solo al momento della creazione della coda.

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

Una 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