Compartilhar 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. Isso 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 Barramento de Serviço lida com uma mensagem que causa uma exceção durante a avaliação de filtro de uma assinatura. Se o valor for definido como true, a mensagem que causou a exceção será movida para a sub-fila de mensagens mortas da assinatura. Caso contrário, ele será descartado. Por padrão, esse parâmetro é definido como true, permitindo que o usuário tenha a chance de investigar a causa da exceção. Isto pode ocorrer devido a uma mensagem mal formada ou a algum pressuposto incorreto feito no filtro sobre a forma da mensagem. Configurável somente no momento da criação do tópico.
deadLetteringOnMessageExpiration

Se ele estiver habilitado e uma mensagem expirar, o Barramento de Serviço moverá a mensagem da fila para a sub-fila de mensagens mortas da assinatura. Se desabilitada, a mensagem será excluída permanentemente da fila principal da assinatura. Configurável somente no momento da criação da assinatura.
defaultMessageTimeToLive

Determina por quanto tempo uma mensagem existe na assinatura. Com base em se o dead-lettering está habilitado, uma mensagem cujo TTL expirou será movida para o DeadLtterQueue associado da assinatura ou excluído permanentemente. Isso 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

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

URL absoluta 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 formulário sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>
lockDuration

A duração padrão do bloqueio é 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 às sessões e não às mensagens.)

Isso 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, será movida para a sub-fila de mensagens mortas.
requiresSession

Se definido como true, a assinatura terá reconhecimento de sessão e somente SessionReceiver terá suporte. A assinatura com reconhecimento de sessão não tem suporte por meio do REST. Configurável somente no momento da criação da assinatura.
status

Status da entidade de mensagens.
userMetadata

O usuário forneceu informações de metadados associadas à assinatura. Usado para especificar conteúdo textual, como marcas, 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 anular solicitações.
onResponse

Uma função a ser chamada sempre 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 essa operação.
serializerOptions

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

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

Detalhes da propriedade

autoDeleteOnIdle

Tempo ocioso máximo antes que a entidade seja excluída. Isso 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 da propriedade

string

availabilityStatus

Status de disponibilidade da entidade de mensagens.

availabilityStatus?: EntityAvailabilityStatus

Valor da propriedade

EntityAvailabilityStatus

deadLetteringOnFilterEvaluationExceptions

Determina como o Barramento de Serviço lida com uma mensagem que causa uma exceção durante a avaliação de filtro de uma assinatura. Se o valor for definido como true, a mensagem que causou a exceção será movida para a sub-fila de mensagens mortas da assinatura. Caso contrário, ele será descartado. Por padrão, esse parâmetro é definido como true, permitindo que o usuário tenha a chance de investigar a causa da exceção. Isto pode ocorrer devido a uma mensagem mal formada ou a algum pressuposto incorreto feito no filtro sobre a forma da mensagem. Configurável somente no momento da criação do tópico.

deadLetteringOnFilterEvaluationExceptions?: boolean

Valor da propriedade

boolean

deadLetteringOnMessageExpiration

Se ele estiver habilitado e uma mensagem expirar, o Barramento de Serviço moverá a mensagem da fila para a sub-fila de mensagens mortas da assinatura. Se desabilitada, a mensagem será excluída permanentemente da fila principal da assinatura. Configurável somente no momento da criação da assinatura.

deadLetteringOnMessageExpiration?: boolean

Valor da propriedade

boolean

defaultMessageTimeToLive

Determina por quanto tempo uma mensagem existe na assinatura. Com base em se o dead-lettering está habilitado, uma mensagem cujo TTL expirou será movida para o DeadLtterQueue associado da assinatura ou excluído permanentemente. Isso 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 da 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 da propriedade

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

enableBatchedOperations

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

enableBatchedOperations?: boolean

Valor da propriedade

boolean

forwardDeadLetteredMessagesTo

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

forwardDeadLetteredMessagesTo?: string

Valor da propriedade

string

forwardTo

URL absoluta 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 formulário sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>

forwardTo?: string

Valor da propriedade

string

lockDuration

A duração padrão do bloqueio é 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 às sessões e não às mensagens.)

Isso 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 da propriedade

string

maxDeliveryCount

A contagem máxima de entrega de mensagens após a qual, se ainda não estiver resolvida, será movida para a sub-fila de mensagens mortas.

maxDeliveryCount?: number

Valor da propriedade

number

requiresSession

Se definido como true, a assinatura terá reconhecimento de sessão e somente SessionReceiver terá suporte. A assinatura com reconhecimento de sessão não tem suporte por meio do REST. Configurável somente no momento da criação da assinatura.

requiresSession?: boolean

Valor da propriedade

boolean

status

Status da entidade de mensagens.

status?: EntityStatus

Valor da propriedade

EntityStatus

userMetadata

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

userMetadata?: string

Valor da propriedade

string

Detalhes das propriedades herdadas

abortSignal

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

abortSignal?: AbortSignalLike

Valor da propriedade

AbortSignalLike

Herdado deOperationOptions.abortSignal

onResponse

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

onResponse?: RawResponseCallback

Valor da propriedade

RawResponseCallback

Herdado deOperationOptions.onResponse

requestOptions

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

requestOptions?: OperationRequestOptions

Valor da propriedade

OperationRequestOptions

Herdado deOperationOptions.requestOptions

serializerOptions

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

serializerOptions?: SerializerOptions

Valor da propriedade

SerializerOptions

Herdado deOperationOptions.serializerOptions

tracingOptions

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

tracingOptions?: OperationTracingOptions

Valor da propriedade

OperationTracingOptions

Herdado deOperationOptions.tracingOptions