Criar um hub de notificação

Artigo
05/26/2023

Cria um novo hub de notificação, que contém credenciais para os Serviços de Notificação de Plataforma suportados (WNS, APNS, GCM).

Pedir

Método	URI do pedido	Versão HTTP
PUT	`https://{namespace}.servicebus.windows.net/{Notification Hub}?api-version=2015-01`	HTTP/1.1

Cabeçalhos do pedido

A tabela seguinte descreve os cabeçalhos de pedido obrigatórios e opcionais.

Cabeçalho do pedido	Descrição
Content-Type	`application/xml;type=entry;charset=utf-8`
Autorização	Token de SAS gerado conforme especificado em Autenticação de Assinatura de Acesso Partilhado com o Service Bus.
x-ms-version	2015-01

Corpo do pedido

O corpo do pedido contém uma entrada Atom com um elemento NotificationHubDescription. Por exemplo:

<?xml version="1.0" encoding="utf-8"?>
<entry xmlns="http://www.w3.org/2005/Atom">
<content type="application/xml">
    <NotificationHubDescription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect">
        <ApnsCredential>
            <Properties>
                <Property>
                    <Name>Endpoint</Name> 
                    <Value>gateway.push.apple.com</Value> 
                </Property>
                <Property>
                    <Name>ApnsCertificate</Name> 
                    <Value>{APNS certificate in Base64}</Value> 
                </Property>
                <Property>
                    <Name>CertificateKey</Name> 
                    <Value>{APNS certificate key}</Value> 
                </Property>
            </Properties>
        </ApnsCredential>
        <RegistrationTtl>P39D</RegistrationTtl> 
        <WnsCredential>
            <Properties>
                <Property>
                    <Name>PackageSid</Name> 
                    <Value>{PackageSid}</Value> 
                </Property>
                <Property>
                    <Name>SecretKey</Name> 
                    <Value>{SecretKey}</Value> 
                </Property>
            </Properties>
        </WnsCredential>
        <GcmCredential>
            <Properties>
                <Property>
                    <Name>GoogleApiKey</Name> 
                    <Value>{ApiKey}</Value> 
                </Property>
            </Properties>
        </GcmCredential>
        <MpnsCredential>
            <Properties>
                <Property>
                    <Name>MpnsCertificate</Name> 
                    <Value>{MPNS certificate in Base64}</Value> 
                </Property>
                <Property>
                    <Name>CertificateKey</Name> 
                    <Value>{MPNS certificate key}</Value> 
                </Property>
            </Properties>
        </MpnsCredential>
    </NotificationHubDescription>
</content></entry>

A propriedade de ponto final de ApnsCredential pode ser gateway.push.apple.com (para servidores de produção) ou gateway.sandbox.push.apple.com (para servidores sandbox).

Todos os elementos subordinados de NotificationHubDescription são opcionais.

As credenciais WNS, APNS e GCM têm de conter todas as propriedades mostradas acima. As credenciais do MPNS também não podem conter propriedades, que permitem push não autenticado para MPNS.

Resposta

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

Códigos de resposta

Código	Descrição
201	Tópico de notificação criado com êxito.
400	Corpo do pedido inválido. Não foi possível criar o tópico de notificação porque o pedido tinha um formato incorreto (ou a validação falhou).
401	Falha de autorização. A chave de acesso estava incorreta.
403	Quota excedida; demasiados hubs de notificação neste espaço de nomes. Hub de notificação não criado.
409	O nó já contém outra entidade.

Para obter informações sobre códigos de estado, veja Códigos de Estado e erro.

Cabeçalhos de resposta

Nenhum.

Corpo da resposta

Um elemento NotificationHubDescription com todas as políticas definidas no nó atual.

Partilhar via