Partilhar via

CreateSubscriptionOptions interface

  • Referência
Pacote:
@azure/service-bus

Representa opções configuráveis em uma assinatura

Extends
OperationOptions

Propriedades

autoDeleteOnIdle

Tempo ocioso máximo antes que a entidade seja excluída. Isto deve ser especificado no formato de duração ISO-8601, como "PT1M" por 1 minuto, "PT5S" por 5 segundos.

Mais informações sobre o formato de duração ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations
availabilityStatus

Status de disponibilidade da entidade de mensagens.
deadLetteringOnFilterEvaluationExceptions

Determina como o Service Bus lida com uma mensagem que causa uma exceção durante a avaliação do filtro de uma assinatura. Se o valor for definido como true, a mensagem que causou a exceção será movida para a subfila de letras mortas da assinatura. Caso contrário, será descartado. Por padrão, esse parâmetro é definido como true, permitindo que o usuário investigue a causa da exceção. Pode ocorrer a partir de uma mensagem malformada ou de algumas suposições incorretas sendo feitas no filtro sobre a forma da mensagem. Configurável apenas no momento da criação do tópico.
deadLetteringOnMessageExpiration

Se estiver habilitado e uma mensagem expirar, o Service Bus moverá a mensagem da fila para a subfila de letra morta da assinatura. Se desativada, a mensagem será excluída permanentemente da fila principal da assinatura. Configurável apenas no momento da criação da subscrição.
defaultMessageTimeToLive

Determina quanto tempo uma mensagem permanece na assinatura. Com base em se o lettering morto está habilitado, uma mensagem cujo TTL expirou será movida para o DeadLtterQueue associado à assinatura ou excluída permanentemente. Isto deve ser especificado no formato de duração ISO-8601, como "PT1M" por 1 minuto, "PT5S" por 5 segundos.

Mais informações sobre o formato de duração ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations
defaultRuleOptions

Representa as opções para criar a regra padrão para a assinatura.
enableBatchedOperations

Especifica se as operações em lote devem ser permitidas.
forwardDeadLetteredMessagesTo

URL absoluto ou o nome da fila ou tópico para o qual as mensagens com letras mortas devem ser encaminhadas. Por exemplo, uma entrada de URL absoluta seria do formato sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>
forwardTo

URL absoluto ou o nome da fila ou tópico para o qual as mensagens devem ser encaminhadas. Por exemplo, uma entrada de URL absoluta seria do formato sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>
lockDuration

A duração de bloqueio padrão é aplicada a assinaturas que não definem uma duração de bloqueio. (Se as sessões estiverem habilitadas, essa duração de bloqueio será aplicável para sessões e não para mensagens.)

Isto deve ser especificado no formato de duração ISO-8601, como "PT1M" por 1 minuto, "PT5S" por 5 segundos.

Mais informações sobre o formato de duração ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations
maxDeliveryCount

A contagem máxima de entrega de mensagens, após a qual, se ainda não estiver resolvida, é movida para a subfila de letra morta.
requiresSession

Se definido como true, a assinatura terá reconhecimento de sessão e somente SessionReceiver será suportado. A subscrição com reconhecimento de sessão não é suportada através do REST. Configurável apenas no momento da criação da subscrição.
status

Status da entidade de mensagens.
userMetadata

O usuário forneceu informações de metadados associadas à assinatura. Usado para especificar conteúdo textual, como tags, rótulos, etc. O valor não deve exceder 1024 bytes codificados em utf-8.

Propriedades Herdadas

abortSignal

O sinal que pode ser usado para abortar solicitações.
onResponse

Uma função a ser chamada cada vez que uma resposta é recebida do servidor durante a execução da operação solicitada. Pode ser chamado várias vezes.
requestOptions

Opções usadas ao criar e enviar solicitações HTTP para esta operação.
serializerOptions

Opções para substituir o comportamento de serialização/desserialização.
tracingOptions

Opções usadas quando o rastreamento está habilitado.

Detalhes de Propriedade

autoDeleteOnIdle

Tempo ocioso máximo antes que a entidade seja excluída. Isto deve ser especificado no formato de duração ISO-8601, como "PT1M" por 1 minuto, "PT5S" por 5 segundos.

Mais informações sobre o formato de duração ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations

autoDeleteOnIdle?: string

Valor de Propriedade

string

availabilityStatus

Status de disponibilidade da entidade de mensagens.

availabilityStatus?: EntityAvailabilityStatus

Valor de Propriedade

EntityAvailabilityStatus

deadLetteringOnFilterEvaluationExceptions

Determina como o Service Bus lida com uma mensagem que causa uma exceção durante a avaliação do filtro de uma assinatura. Se o valor for definido como true, a mensagem que causou a exceção será movida para a subfila de letras mortas da assinatura. Caso contrário, será descartado. Por padrão, esse parâmetro é definido como true, permitindo que o usuário investigue a causa da exceção. Pode ocorrer a partir de uma mensagem malformada ou de algumas suposições incorretas sendo feitas no filtro sobre a forma da mensagem. Configurável apenas no momento da criação do tópico.

deadLetteringOnFilterEvaluationExceptions?: boolean

Valor de Propriedade

boolean

deadLetteringOnMessageExpiration

Se estiver habilitado e uma mensagem expirar, o Service Bus moverá a mensagem da fila para a subfila de letra morta da assinatura. Se desativada, a mensagem será excluída permanentemente da fila principal da assinatura. Configurável apenas no momento da criação da subscrição.

deadLetteringOnMessageExpiration?: boolean

Valor de Propriedade

boolean

defaultMessageTimeToLive

Determina quanto tempo uma mensagem permanece na assinatura. Com base em se o lettering morto está habilitado, uma mensagem cujo TTL expirou será movida para o DeadLtterQueue associado à assinatura ou excluída permanentemente. Isto deve ser especificado no formato de duração ISO-8601, como "PT1M" por 1 minuto, "PT5S" por 5 segundos.

Mais informações sobre o formato de duração ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations

defaultMessageTimeToLive?: string

Valor de Propriedade

string

defaultRuleOptions

Representa as opções para criar a regra padrão para a assinatura.

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

Valor de Propriedade

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

enableBatchedOperations

Especifica se as operações em lote devem ser permitidas.

enableBatchedOperations?: boolean

Valor de Propriedade

boolean

forwardDeadLetteredMessagesTo

URL absoluto ou o nome da fila ou tópico para o qual as mensagens com letras mortas devem ser encaminhadas. Por exemplo, uma entrada de URL absoluta seria do formato sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>

forwardDeadLetteredMessagesTo?: string

Valor de Propriedade

string

forwardTo

URL absoluto ou o nome da fila ou tópico para o qual as mensagens devem ser encaminhadas. Por exemplo, uma entrada de URL absoluta seria do formato sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>

forwardTo?: string

Valor de Propriedade

string

lockDuration

A duração de bloqueio padrão é aplicada a assinaturas que não definem uma duração de bloqueio. (Se as sessões estiverem habilitadas, essa duração de bloqueio será aplicável para sessões e não para mensagens.)

Isto deve ser especificado no formato de duração ISO-8601, como "PT1M" por 1 minuto, "PT5S" por 5 segundos.

Mais informações sobre o formato de duração ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations

lockDuration?: string

Valor de Propriedade

string

maxDeliveryCount

A contagem máxima de entrega de mensagens, após a qual, se ainda não estiver resolvida, é movida para a subfila de letra morta.

maxDeliveryCount?: number

Valor de Propriedade

number

requiresSession

Se definido como true, a assinatura terá reconhecimento de sessão e somente SessionReceiver será suportado. A subscrição com reconhecimento de sessão não é suportada através do REST. Configurável apenas no momento da criação da subscrição.

requiresSession?: boolean

Valor de Propriedade

boolean

status

Status da entidade de mensagens.

status?: EntityStatus

Valor de Propriedade

EntityStatus

userMetadata

O usuário forneceu informações de metadados associadas à assinatura. Usado para especificar conteúdo textual, como tags, rótulos, etc. O valor não deve exceder 1024 bytes codificados em utf-8.

userMetadata?: string

Valor de Propriedade

string

Detalhes da Propriedade Herdada

abortSignal

O sinal que pode ser usado para abortar solicitações.

abortSignal?: AbortSignalLike

Valor de Propriedade

AbortSignalLike

herdado de OperationOptions.abortSignal

onResponse

Uma função a ser chamada cada vez que uma resposta é recebida do servidor durante a execução da operação solicitada. Pode ser chamado várias vezes.

onResponse?: RawResponseCallback

Valor de Propriedade

RawResponseCallback

herdado do OperationOptions.onResponse

requestOptions

Opções usadas ao criar e enviar solicitações HTTP para esta operação.

requestOptions?: OperationRequestOptions

Valor de Propriedade

OperationRequestOptions

herdado deOperationOptions.requestOptions

serializerOptions

Opções para substituir o comportamento de serialização/desserialização.

serializerOptions?: SerializerOptions

Valor de Propriedade

SerializerOptions

herdado deOperationOptions.serializerOptions

tracingOptions

Opções usadas quando o rastreamento está habilitado.

tracingOptions?: OperationTracingOptions

Valor de Propriedade

OperationTracingOptions

herdado doOperationOptions.tracingOptions