Compartir a través de

CreateQueueOptions interface

  • Referencia
Paquete:
@azure/service-bus

Representa las opciones que se pueden establecer en una cola.

Extends
OperationOptions

Propiedades

authorizationRules

Reglas de autorización en la cola
autoDeleteOnIdle

Tiempo de inactividad máximo antes de que se elimine la entidad. Se debe especificar en formato de duración ISO-8601, como "PT1M" durante 1 minuto, "PT5S" durante 5 segundos.

Más información sobre el formato de duración ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations
availabilityStatus

Estado de disponibilidad de la entidad de mensajería.
deadLetteringOnMessageExpiration

Si está habilitado y expira un mensaje, Service Bus mueve el mensaje de la cola a la subcola de mensajes fallidos de la cola. Si está deshabilitado, el mensaje se eliminará permanentemente de la cola. Configurable solo en el momento de la creación de la cola.
defaultMessageTimeToLive

Dependiendo de si DeadLettering está habilitado, un mensaje se mueve automáticamente a la sub cola de mensajes fallidos o se elimina si se ha almacenado en la cola durante más tiempo que el especificado. Este valor lo sobrescribe un TTL especificado en el mensaje si y solo si el TTL del mensaje es menor que el TTL establecido en la cola. Este valor es inmutable después de crear la cola. Se debe especificar en formato de duración ISO-8601, como "PT1M" durante 1 minuto, "PT5S" durante 5 segundos.

Más información sobre el formato de duración ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations
duplicateDetectionHistoryTimeWindow

Especifica el intervalo de tiempo durante el que Service Bus detecta la duplicación de mensajes. Se debe especificar en formato de duración ISO-8601, como "PT1M" durante 1 minuto, "PT5S" durante 5 segundos.

Más información sobre el formato de duración ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations
enableBatchedOperations

Especifica si se deben permitir operaciones por lotes.
enableExpress

Especifica si las entidades rápidas están habilitadas en la cola.
enablePartitioning

Especifica si la cola debe particionarse.
forwardDeadLetteredMessagesTo

Dirección URL absoluta o el nombre de la cola o el tema a los que se reenviarán los mensajes fallidos. Por ejemplo, una entrada de dirección URL absoluta sería del formato sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>
forwardTo

Dirección URL absoluta o el nombre de la cola o tema a los que se reenviarán los mensajes. Por ejemplo, una entrada de dirección URL absoluta sería del formato sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>
lockDuration

Determina la cantidad de tiempo en segundos que un mensaje debe estar bloqueado para el procesamiento por parte del receptor. Después de este período, el mensaje se desbloquea y está disponible para que el siguiente receptor lo consuma. (Si las sesiones están habilitadas, esta duración de bloqueo es aplicable a las sesiones y no a los mensajes).

Se debe especificar en formato de duración ISO-8601, como "PT1M" durante 1 minuto, "PT5S" durante 5 segundos.

Más información sobre el formato de duración ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations
maxDeliveryCount

El número máximo de entregas de mensajes después de los cuales, si aún no se ha liquidado, se mueve a la subcola de mensajes fallidos.
maxMessageSizeInKilobytes

Tamaño máximo de mensaje en kilobytes para los mensajes enviados a esta cola.

(Solo se puede configurar para el espacio de nombres de Service Bus de nivel Premium).
maxSizeInMegabytes

Especifica el tamaño máximo de la cola en megabytes. Cualquier intento de poner en cola un mensaje que provoque que la cola supere este valor provocará un error.
requiresDuplicateDetection

Si está habilitado, el tema detectará mensajes duplicados dentro del intervalo de tiempo especificado por la propiedad DuplicateDetectionHistoryTimeWindow. Configurable solo en el momento de la creación de la cola.
requiresSession

Si se establece en true, la cola será compatible con la sesión y solo se admitirá SessionReceiver. Las colas que tienen en cuenta la sesión no se admiten a través de REST. Configurable solo en el momento de la creación de la cola.
status

Estado de la entidad de mensajería.
userMetadata

El usuario proporcionó información de metadatos asociada a la cola. Se usa para especificar contenido textual, como etiquetas, etiquetas, etc. El valor no debe superar los 1024 bytes codificados en utf-8.

Propiedades heredadas

abortSignal

Señal que se puede usar para anular las solicitudes.
onResponse

Una función a la que se llamará cada vez que se recibe una respuesta del servidor mientras se realiza la operación solicitada. Se puede llamar varias veces.
requestOptions

Opciones usadas al crear y enviar solicitudes HTTP para esta operación.
serializerOptions

Opciones para invalidar el comportamiento de serialización o des serialización.
tracingOptions

Opciones usadas al habilitar el seguimiento.

Detalles de las propiedades

authorizationRules

Reglas de autorización en la cola

authorizationRules?: AuthorizationRule[]

Valor de propiedad

AuthorizationRule[]

autoDeleteOnIdle

Tiempo de inactividad máximo antes de que se elimine la entidad. Se debe especificar en formato de duración ISO-8601, como "PT1M" durante 1 minuto, "PT5S" durante 5 segundos.

Más información sobre el formato de duración ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations

autoDeleteOnIdle?: string

Valor de propiedad

string

availabilityStatus

Estado de disponibilidad de la entidad de mensajería.

availabilityStatus?: EntityAvailabilityStatus

Valor de propiedad

EntityAvailabilityStatus

deadLetteringOnMessageExpiration

Si está habilitado y expira un mensaje, Service Bus mueve el mensaje de la cola a la subcola de mensajes fallidos de la cola. Si está deshabilitado, el mensaje se eliminará permanentemente de la cola. Configurable solo en el momento de la creación de la cola.

deadLetteringOnMessageExpiration?: boolean

Valor de propiedad

boolean

defaultMessageTimeToLive

Dependiendo de si DeadLettering está habilitado, un mensaje se mueve automáticamente a la sub cola de mensajes fallidos o se elimina si se ha almacenado en la cola durante más tiempo que el especificado. Este valor lo sobrescribe un TTL especificado en el mensaje si y solo si el TTL del mensaje es menor que el TTL establecido en la cola. Este valor es inmutable después de crear la cola. Se debe especificar en formato de duración ISO-8601, como "PT1M" durante 1 minuto, "PT5S" durante 5 segundos.

Más información sobre el formato de duración ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations

defaultMessageTimeToLive?: string

Valor de propiedad

string

duplicateDetectionHistoryTimeWindow

Especifica el intervalo de tiempo durante el que Service Bus detecta la duplicación de mensajes. Se debe especificar en formato de duración ISO-8601, como "PT1M" durante 1 minuto, "PT5S" durante 5 segundos.

Más información sobre el formato de duración ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations

duplicateDetectionHistoryTimeWindow?: string

Valor de propiedad

string

enableBatchedOperations

Especifica si se deben permitir operaciones por lotes.

enableBatchedOperations?: boolean

Valor de propiedad

boolean

enableExpress

Especifica si las entidades rápidas están habilitadas en la cola.

enableExpress?: boolean

Valor de propiedad

boolean

enablePartitioning

Especifica si la cola debe particionarse.

enablePartitioning?: boolean

Valor de propiedad

boolean

forwardDeadLetteredMessagesTo

Dirección URL absoluta o el nombre de la cola o el tema a los que se reenviarán los mensajes fallidos. Por ejemplo, una entrada de dirección URL absoluta sería del formato sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>

forwardDeadLetteredMessagesTo?: string

Valor de propiedad

string

forwardTo

Dirección URL absoluta o el nombre de la cola o tema a los que se reenviarán los mensajes. Por ejemplo, una entrada de dirección URL absoluta sería del formato sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>

forwardTo?: string

Valor de propiedad

string

lockDuration

Determina la cantidad de tiempo en segundos que un mensaje debe estar bloqueado para el procesamiento por parte del receptor. Después de este período, el mensaje se desbloquea y está disponible para que el siguiente receptor lo consuma. (Si las sesiones están habilitadas, esta duración de bloqueo es aplicable a las sesiones y no a los mensajes).

Se debe especificar en formato de duración ISO-8601, como "PT1M" durante 1 minuto, "PT5S" durante 5 segundos.

Más información sobre el formato de duración ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations

lockDuration?: string

Valor de propiedad

string

maxDeliveryCount

El número máximo de entregas de mensajes después de los cuales, si aún no se ha liquidado, se mueve a la subcola de mensajes fallidos.

maxDeliveryCount?: number

Valor de propiedad

number

maxMessageSizeInKilobytes

Tamaño máximo de mensaje en kilobytes para los mensajes enviados a esta cola.

(Solo se puede configurar para el espacio de nombres de Service Bus de nivel Premium).

maxMessageSizeInKilobytes?: number

Valor de propiedad

number

maxSizeInMegabytes

Especifica el tamaño máximo de la cola en megabytes. Cualquier intento de poner en cola un mensaje que provoque que la cola supere este valor provocará un error.

maxSizeInMegabytes?: number

Valor de propiedad

number

requiresDuplicateDetection

Si está habilitado, el tema detectará mensajes duplicados dentro del intervalo de tiempo especificado por la propiedad DuplicateDetectionHistoryTimeWindow. Configurable solo en el momento de la creación de la cola.

requiresDuplicateDetection?: boolean

Valor de propiedad

boolean

requiresSession

Si se establece en true, la cola será compatible con la sesión y solo se admitirá SessionReceiver. Las colas que tienen en cuenta la sesión no se admiten a través de REST. Configurable solo en el momento de la creación de la cola.

requiresSession?: boolean

Valor de propiedad

boolean

status

Estado de la entidad de mensajería.

status?: EntityStatus

Valor de propiedad

EntityStatus

userMetadata

El usuario proporcionó información de metadatos asociada a la cola. Se usa para especificar contenido textual, como etiquetas, etiquetas, etc. El valor no debe superar los 1024 bytes codificados en utf-8.

userMetadata?: string

Valor de propiedad

string

Detalles de las propiedades heredadas

abortSignal

Señal que se puede usar para anular las solicitudes.

abortSignal?: AbortSignalLike

Valor de propiedad

AbortSignalLike

Heredado deOperationOptions.abortSignal

onResponse

Una función a la que se llamará cada vez que se recibe una respuesta del servidor mientras se realiza la operación solicitada. Se puede llamar varias veces.

onResponse?: RawResponseCallback

Valor de propiedad

RawResponseCallback

Heredado deOperationOptions.onResponse

requestOptions

Opciones usadas al crear y enviar solicitudes HTTP para esta operación.

requestOptions?: OperationRequestOptions

Valor de propiedad

OperationRequestOptions

Heredado deOperationOptions.requestOptions

serializerOptions

Opciones para invalidar el comportamiento de serialización o des serialización.

serializerOptions?: SerializerOptions

Valor de propiedad

SerializerOptions

Heredado deOperationOptions.serializerOptions

tracingOptions

Opciones usadas al habilitar el seguimiento.

tracingOptions?: OperationTracingOptions

Valor de propiedad

OperationTracingOptions

Heredado deOperationOptions.tracingOptions