Compartilhar 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. 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.
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 fila. Se desabilitada, a mensagem será excluída permanentemente da fila. Configurável somente no momento da criação da fila.
defaultMessageTimeToLive

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

Especifica o período de tempo durante o qual o Barramento de Serviço detecta a duplicação da mensagem. 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
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

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

Determina o período em segundos no qual uma mensagem deverá estar bloqueada para processamento por um receptor. Depois desse período, a mensagem é desbloqueada e fica disponível para consumo pelo próximo receptor. (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.
maxMessageSizeInKilobytes

O tamanho máximo da mensagem em quilobytes para mensagens enviadas para essa fila.

(Configurável somente para o namespace do Barramento de Serviço de Camada Premium.)
maxSizeInMegabytes

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

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

Se definido como true, a fila terá reconhecimento de sessão e somente SessionReceiver terá suporte. Filas com conhecimento da sessão não são suportadas por meio do REST. Configurável somente 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 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

authorizationRules

Regras de autorização na fila

authorizationRules?: AuthorizationRule[]

Valor da propriedade

AuthorizationRule[]

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

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 fila. Se desabilitada, a mensagem será excluída permanentemente da fila. Configurável somente no momento da criação da fila.

deadLetteringOnMessageExpiration?: boolean

Valor da propriedade

boolean

defaultMessageTimeToLive

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

duplicateDetectionHistoryTimeWindow

Especifica o período de tempo durante o qual o Barramento de Serviço detecta a duplicação da mensagem. 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

duplicateDetectionHistoryTimeWindow?: string

Valor da propriedade

string

enableBatchedOperations

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

enableBatchedOperations?: boolean

Valor da propriedade

boolean

enableExpress

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

enableExpress?: boolean

Valor da propriedade

boolean

enablePartitioning

Especifica se a fila deve ser particionada.

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

Determina o período em segundos no qual uma mensagem deverá estar bloqueada para processamento por um receptor. Depois desse período, a mensagem é desbloqueada e fica disponível para consumo pelo próximo receptor. (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

maxMessageSizeInKilobytes

O tamanho máximo da mensagem em quilobytes para mensagens enviadas para essa fila.

(Configurável somente para o namespace do Barramento de Serviço de Camada Premium.)

maxMessageSizeInKilobytes?: number

Valor da propriedade

number

maxSizeInMegabytes

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

maxSizeInMegabytes?: number

Valor da propriedade

number

requiresDuplicateDetection

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

requiresDuplicateDetection?: boolean

Valor da propriedade

boolean

requiresSession

Se definido como true, a fila terá reconhecimento de sessão e somente SessionReceiver terá suporte. Filas com conhecimento da sessão não são suportadas por meio do REST. Configurável somente no momento da criação da fila.

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