Criar Assinatura

Importante

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

Cria uma nova assinatura. Depois de criado, o manifesto do recurso de assinatura é imutável. Essa operação não é idempotente. Repetir a chamada de criação depois que uma assinatura com o mesmo nome (no mesmo tópico e namespace) foi criada com êxito, resulta em uma mensagem de erro 409 Conflict.

Se você criar uma assinatura com um nome que contenha caracteres especiais ou codificados (por exemplo, "teste? Name=value&", que é codificado para "test%3FName%3Dvalue%26"), uma exceção (401) Não autorizada é gerada.

Observe as seguintes restrições de nome de assinatura:

1. Só pode conter letras, números, pontos (.), hifens (-) e sublinhados (_).

2. Vários segmentos não permitidos.

3. Barra (/) não permitida como um prefixo ou sufixo do nome da assinatura.

4. O número máximo de caracteres é 50.

Solicitação

Método	URI da solicitação	Versão HTTP
PUT	https://management.core.windows.net/{subscription ID}/services/ServiceBus/Namespaces/Topics/Subscriptions/{Subscription Name}	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
Namespace	URL do ponto de extremidade de gerenciamento
x-ms-version	2012-03-01

A solicitação também requer um certificado de 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	Tipo	Descrição
DefaultMessageTimeToLive	Datetime XML	Com base em se as mensagens mortas estão habilitadas, se uma mensagem foi armazenada no tópico por mais do que a hora especificada, ela é movida automaticamente 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 no tópico. Esse valor é imutável depois que o tópico é criado: - Intervalo: 1 segundo a 14 dias. – Padrão: 14 dias.
LockDuration	Datetime XML	Essa configuração determina a quantidade de tempo, em segundos, em que uma mensagem deve ser 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 do tópico: - Intervalo: 0 a 5 min. 0 significa que a mensagem não está bloqueada. – Padrão: 30s.
RequiresSession	Booliano	Configurável somente no momento da criação do tópico. Se definido truecomo , o tópico estará ciente da sessão e só SessionReceiver terá suporte. Não há suporte para tópicos com reconhecimento de sessão por meio do REST. – Padrão: False.
EnableDeadLetteringOnMessageExpiration	Booliano	Configurável somente no momento da criação da assinatura. – Padrão: False. Esse campo determina como o Barramento de Serviço manipula uma mensagem com uma TTL expirada. Se true e uma mensagem expirarem, o Barramento de Serviço moverá a mensagem do tópico para a subconsulta de mensagens mortas para esse tópico. Se false, a mensagem será excluída permanentemente do tópico.
DeadLetteringOnFilterEvaluationExceptions		Determina como o Barramento de Serviço manipula uma mensagem que causa uma exceção durante uma avaliação de filtro de assinatura. Se true, a mensagem que causou a exceção será movida para a fila de mensagens mortas da assinatura. Caso contrário, ele será descartado. Por padrão, esse parâmetro é definido como true, permitindo investigar a causa da exceção. Isso pode ocorrer a partir de uma mensagem malformada ou suposições incorretas que estão sendo feitas no filtro sobre a forma da mensagem. Configurável somente no momento da criação do tópico. – Padrão: true
EnableBatchedOperations		Ativa ou desativa o comportamento de lote no lado do serviço ao realizar operações para a fila especificada. Quando habilitado, o Barramento de Serviço coleta/lotes várias operações para o back-end, para ser mais eficiente na conexão. Caso deseje menor latência de operação, desabilite esse recurso. Padrão: false
MaxDeliveryCount	Inteiro sem sinal	O número máximo de vezes que o Barramento de Serviço tenta entregar uma mensagem antes que a mensagem seja morta ou descartada. - Padrão: 10
MessageCount	Inteiro sem sinal	Relata o número de mensagens na assinatura ainda não removidas da fila, conforme relatado pelo sistema de monitoramento.

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 um namespace com um nome que contenha caracteres especiais ou codificados (por exemplo, test?Name=value&, que é codificado para test%3FName%3Dvalue%26), uma exceção (401) Não autorizada será gerada.

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

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

Cabeçalhos de resposta

Nenhum.

Corpo da resposta

A descrição da assinatura é retornada, pois quando a solicitação PUT não especifica valores para todos os atributos da assinatura, algumas propriedades de descrição podem conter valores padrão.