Partilhar via

CreateQueueOptions interface

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

Representa opções configuráveis em uma fila

Extends
OperationOptions

Propriedades

authorizationRules

Regras de autorização na fila
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.
deadLetteringOnMessageExpiration

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

Dependendo se o DeadLettering está habilitado, uma mensagem é movida automaticamente para a subfila de letras mortas ou excluída se tiver sido armazenada na fila por mais tempo do que o tempo especificado. Esse valor é substituído por um TTL especificado na mensagem se e somente se o TTL da mensagem for menor do que o TTL definido na fila. Esse valor é imutável após a fila ter sido criada. 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
duplicateDetectionHistoryTimeWindow

Especifica o período de tempo durante o qual o Service Bus deteta duplicação de 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
enableBatchedOperations

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

Especifica se as entidades expressas estão habilitadas na fila.
enablePartitioning

Especifica se a fila deve ser particionada.
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

Determina a quantidade de tempo, em segundos, em que uma mensagem deve ser bloqueada para processamento por um recetor. Após este período, a mensagem é desbloqueada e fica disponível para consumo pelo próximo recetor. (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.
maxMessageSizeInKilobytes

O tamanho máximo de mensagens em kilobytes para mensagens enviadas para esta fila.

(Configurável somente para namespace do Service Bus de Camada Premium.)
maxSizeInMegabytes

Especifica o tamanho máximo da fila em megabytes. Qualquer tentativa de enfileirar uma mensagem que fará com que a fila exceda esse valor falhará.
requiresDuplicateDetection

Se habilitado, o tópico detetará mensagens duplicadas dentro do período de tempo especificado pela propriedade DuplicateDetectionHistoryTimeWindow. Configurável apenas no momento da criação da fila.
requiresSession

Se definido como true, a fila terá reconhecimento de sessão e apenas SessionReceiver será suportado. Não há suporte para filas com reconhecimento de sessão por meio do REST. Configurável apenas no momento da criação da fila.
status

Status da entidade de mensagens.
userMetadata

O usuário forneceu informações de metadados associadas à fila. 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

authorizationRules

Regras de autorização na fila

authorizationRules?: AuthorizationRule[]

Valor de Propriedade

AuthorizationRule[]

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

deadLetteringOnMessageExpiration

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

deadLetteringOnMessageExpiration?: boolean

Valor de Propriedade

boolean

defaultMessageTimeToLive

Dependendo se o DeadLettering está habilitado, uma mensagem é movida automaticamente para a subfila de letras mortas ou excluída se tiver sido armazenada na fila por mais tempo do que o tempo especificado. Esse valor é substituído por um TTL especificado na mensagem se e somente se o TTL da mensagem for menor do que o TTL definido na fila. Esse valor é imutável após a fila ter sido criada. 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

duplicateDetectionHistoryTimeWindow

Especifica o período de tempo durante o qual o Service Bus deteta duplicação de 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

duplicateDetectionHistoryTimeWindow?: string

Valor de Propriedade

string

enableBatchedOperations

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

enableBatchedOperations?: boolean

Valor de Propriedade

boolean

enableExpress

Especifica se as entidades expressas estão habilitadas na fila.

enableExpress?: boolean

Valor de Propriedade

boolean

enablePartitioning

Especifica se a fila deve ser particionada.

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

Determina a quantidade de tempo, em segundos, em que uma mensagem deve ser bloqueada para processamento por um recetor. Após este período, a mensagem é desbloqueada e fica disponível para consumo pelo próximo recetor. (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

maxMessageSizeInKilobytes

O tamanho máximo de mensagens em kilobytes para mensagens enviadas para esta fila.

(Configurável somente para namespace do Service Bus de Camada Premium.)

maxMessageSizeInKilobytes?: number

Valor de Propriedade

number

maxSizeInMegabytes

Especifica o tamanho máximo da fila em megabytes. Qualquer tentativa de enfileirar uma mensagem que fará com que a fila exceda esse valor falhará.

maxSizeInMegabytes?: number

Valor de Propriedade

number

requiresDuplicateDetection

Se habilitado, o tópico detetará mensagens duplicadas dentro do período de tempo especificado pela propriedade DuplicateDetectionHistoryTimeWindow. Configurável apenas no momento da criação da fila.

requiresDuplicateDetection?: boolean

Valor de Propriedade

boolean

requiresSession

Se definido como true, a fila terá reconhecimento de sessão e apenas SessionReceiver será suportado. Não há suporte para filas com reconhecimento de sessão por meio do REST. Configurável apenas no momento da criação da fila.

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 à fila. 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