Compartir a través de

CreateSubscriptionOptions interface

  • Referencia
Paquete:
@azure/service-bus

Representa las opciones que se pueden establecer en una suscripción.

Extends
OperationOptions

Propiedades

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

Determina cómo service Bus controla un mensaje que provoca una excepción durante la evaluación de filtros de una suscripción. Si el valor se establece en true, el mensaje que provocó la excepción se moverá a la sub cola de mensajes fallidos de la suscripción. De lo contrario, se descartará. De forma predeterminada, este parámetro se establece en true, lo que permite al usuario investigar la causa de la excepción. Puede producirse un mensaje formado incorrectamente o algunas suposiciones incorrectas que se realizan en el filtro respecto a la forma del mensaje. Configurable solo en el momento de la creación del tema.
deadLetteringOnMessageExpiration

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

Determina el tiempo que vive un mensaje en la suscripción. En función de si la entrega de mensajes fallidos está habilitada, un mensaje cuyo TTL ha expirado se moverá al deadLtterQueue asociado de la suscripción o se eliminará permanentemente. 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
defaultRuleOptions

Representa las opciones para crear la regla predeterminada para la suscripción.
enableBatchedOperations

Especifica si se deben permitir operaciones por lotes.
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

La duración de bloqueo predeterminada se aplica a las suscripciones que no definen una duración de bloqueo. (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.
requiresSession

Si se establece en true, la suscripción será compatible con la sesión y solo se admitirá SessionReceiver. La suscripción compatible con la sesión no se admite a través de REST. Configurable solo en el momento de la creación de la suscripción.
status

Estado de la entidad de mensajería.
userMetadata

El usuario proporcionó información de metadatos asociada a la suscripción. 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

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

deadLetteringOnFilterEvaluationExceptions

Determina cómo service Bus controla un mensaje que provoca una excepción durante la evaluación de filtros de una suscripción. Si el valor se establece en true, el mensaje que provocó la excepción se moverá a la sub cola de mensajes fallidos de la suscripción. De lo contrario, se descartará. De forma predeterminada, este parámetro se establece en true, lo que permite al usuario investigar la causa de la excepción. Puede producirse un mensaje formado incorrectamente o algunas suposiciones incorrectas que se realizan en el filtro respecto a la forma del mensaje. Configurable solo en el momento de la creación del tema.

deadLetteringOnFilterEvaluationExceptions?: boolean

Valor de propiedad

boolean

deadLetteringOnMessageExpiration

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

deadLetteringOnMessageExpiration?: boolean

Valor de propiedad

boolean

defaultMessageTimeToLive

Determina el tiempo que vive un mensaje en la suscripción. En función de si la entrega de mensajes fallidos está habilitada, un mensaje cuyo TTL ha expirado se moverá al deadLtterQueue asociado de la suscripción o se eliminará permanentemente. 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

defaultRuleOptions

Representa las opciones para crear la regla predeterminada para la suscripción.

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

Valor de propiedad

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

enableBatchedOperations

Especifica si se deben permitir operaciones por lotes.

enableBatchedOperations?: 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

La duración de bloqueo predeterminada se aplica a las suscripciones que no definen una duración de bloqueo. (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

requiresSession

Si se establece en true, la suscripción será compatible con la sesión y solo se admitirá SessionReceiver. La suscripción compatible con la sesión no se admite a través de REST. Configurable solo en el momento de la creación de la suscripción.

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 suscripción. 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