Criar fila

Importante

Essa API está obsoleta e foi retirada a partir de 11/1/2021 e não deve mais ser usada.

Cria uma nova fila. Depois de criado, o manifesto do recurso da fila é imutável. Essa operação é idempotente. Repetir a chamada de criação depois que uma fila com o mesmo nome tiver sido criada com sucesso resulta em uma mensagem de erro 409 Conflito.

Solicitação

Método URI da solicitação Versão HTTP
PUT https://management.core.windows.net/{subscription ID}/services/ServiceBus/Namespaces/{Namespace}/Queues/{Queue Path} HTTP/1.1

Cabeçalhos de solicitação

A tabela a seguir descreve os cabeçalhos de solicitação obrigatórios e opcionais.

Cabeçalho da solicitação Descrição
Tipo de conteúdo application/xml;type=entry;charset=utf-8
x-ms-version 2012-03-01

A solicitação também exige um certificado do cliente. Esse certificado deve corresponder ao carregado para uma assinatura específica.

Corpo da solicitação

A tabela a seguir descreve os principais elementos do corpo da solicitação:

Nome da Propriedade Type Obrigatório Descrição
MaxQueueSizeInMegaBytes Inteiro sem sinal Obrigatório Esse parâmetro 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á. Somente conteúdo do usuário é relevante para esse valor. Configurável no momento da criação da fila e no tempo de execução:

- Intervalo: 1 a 5*1024.

- Padrão: 1 * 1024.
QueueSizeinBytes Inteiro sem sinal Somente leitura. Não é necessário na criação. Esse parâmetro reflete os bytes reais que as mensagens na fila atualmente ocupam com relação à cota da fila.

Intervalo: 0 –MaxTopicSizeinMlitaBytes
QueueDepth Inteiro sem sinal Somente leitura. Não é necessário na criação. Esse parâmetro mostra o número de mensagens atualmente na fila.
DefaultMessageTimeToLive Datetime XML Opcional, o padrão é 14 dias. Dependendo se as mensagens mortas estão habilitadas, se uma mensagem ficou armazenada na fila por um tempo maior que o especificado, ela é automaticamente movida para a fila de mensagens mortas ou é excluída. Esse valor é substituído por um TTL especificado na mensagem se o TTL da mensagem for menor que o TTL definido na fila. Esse valor é imutável depois que a fila é criada:

- Intervalo: 1 segundo a 14 dias.

- Padrão: 14 dias.
LockDuration Datetime XML Opcional, o padrão é 30 segundos. Essa configuração determina o período em segundos no qual uma mensagem deve estar bloqueada para processamento por um receptor. Depois desse período, a mensagem é desbloqueada e fica disponível para consumo pelo próximo receptor. Configurável somente no momento da criação da fila:

- Intervalo: 0 a 5 min. 0 significa que a mensagem não está bloqueada.

- Padrão: 30 segundos.
RequiresSession Boolean Opcional Configurável somente no momento da criação da fila. Se estiver definido como true, a fila tem conhecimento da sessão e somente SessionReceiver tem suporte. Filas com conhecimento da sessão não são suportadas por meio do REST.

- Padrão: False.
RequiresDuplicateDetection Boolean Opcional Configurável somente no momento da criação da fila.

- Padrão para a fila durável: false.
EnableDeadLetteringOnMessageExpiration Boolean Opcional Configurável somente no momento da criação da fila.

- Padrão: false.

Esse campo determina como Barramento de Serviço lida com uma mensagem com um TTL expirado. Se true e uma mensagem expirar, Barramento de Serviço a mensagem da fila para a subfila de mensagens mortas da fila. Se for false, a mensagem é permanentemente excluída da fila.
DuplicateDetectionHistoryTimeWindow Período de tempo Opcional. Uma propriedade que especifica o período durante o qual o Barramento de Serviço detecta a duplicação de mensagens.

- Intervalo: 1 segundo a 7 dias.

- Padrão: 10 minutos.
Status String Somente leitura. Não é necessário na criação. Pode ser um dos seguintes valores:

  • Ativo
  • Criando
  • Excluir
  • ReceiveDisabled
  • SendDisabled
  • Desabilitado
  • Renomear
  • Restoring
  • Unknown

Resposta

A resposta inclui um código de status HTTP e um conjunto de cabeçalhos de resposta.

Códigos de resposta

Observação

Se você criar uma fila com um nome que contenha caracteres especiais ou codificados (por exemplo, "test?Name=value&", que é codificado como "test%3FName%3Dvalue%26"), uma exceção de solicitação inválida (400) é gerada.

Código Descrição
201 Fila criada.
400 Corpo da solicitação inválido.
401 Falha de autorização.
403 Cota excedida; fila não criada.
409 A fila especificada já existe (ou o caminho especificado já está ocupado).
500 Erro interno.

Para obter informações sobre códigos de status, consulte status e códigos de erro.

Cabeçalhos de resposta

Nenhum.

Corpo da resposta

É retornada a descrição da fila. Algumas propriedades da descrição podem conter valores padrão se estiverem ausentes da solicitação PUT.