Visão geral dos Eventos de Parceiros – Grade de Eventos do Azure

Os Eventos de Parceiros da Grade de Eventos permitem que os clientes assinem eventos originados em um sistema registrado usando o mesmo mecanismo que usariam para qualquer outra fonte de evento no Azure, como um serviço do Azure. Esses sistemas registrados que se integram à Grade de Eventos são conhecidos como "parceiros". Esse recurso também permite que os clientes enviem eventos para sistemas de parceiros que dão suporte ao recebimento e ao roteamento de eventos para soluções/pontos de extremidade do cliente em sua plataforma. Normalmente, os parceiros são provedores SaaS (software como serviço) ou de ERP, mas podem ser plataformas corporativas que desejam disponibilizar seus eventos para equipes internas. Eles se integram propositalmente à Grade de Eventos para observar casos de uso de clientes de ponta a ponta que terminam no Azure (os clientes assinam eventos enviados pelo parceiro) ou terminam em um sistema de parceiros (os clientes assinam eventos da Microsoft enviados pela Grade de Eventos do Azure). Os clientes apostam na Grade de Eventos do Azure para enviar eventos publicados por um parceiro para destinos com suporte, como webhooks, Azure Functions, Hubs de Eventos do Azure ou Barramento de Serviço do Azure, para citar alguns. Os clientes também contam com a Grade de Eventos do Azure para rotear eventos originados em serviços da Microsoft, como Outlook, Teams ou Microsoft Entra ID, para que as soluções do cliente possam reagir a eles. Com os Eventos do Parceiro, os clientes podem criar soluções controladas por eventos entre plataformas e limites de rede para receber ou enviar eventos de forma confiável, segura e em escala.

Eventos de Parceiros: como funciona

Como parceiro, você cria recursos da Grade de Eventos que permitem que você publique eventos na Grade de Eventos do Azure, para que os clientes no Azure possam se inscrever neles. Para a maioria dos parceiros, por exemplo, provedores de SaaS, é a única funcionalidade de integração que eles usarão.

Você também pode criar recursos da Grade de Eventos para receber eventos de Grade de Eventos do Azure. Esse caso de uso é para as organizações que possuem ou gerenciam uma plataforma que permite que seus clientes recebam eventos expondo pontos de extremidade. Algumas dessas organizações são sistemas ERP que também têm recursos de roteamento de eventos em sua plataforma, que envia os eventos de entrada do Azure para um aplicativo cliente hospedado em sua plataforma.

Para publicar eventos ou receber eventos, crie o mesmo tipo de recursos da Grade de Eventos seguindo estas etapas gerais.

1. Entre em contato com a equipe da Grade de Eventos em askgrid@microsoft.com para comunicar seu interesse em se tornar um parceiro. Depois de entrar em contato conosco, guiaremos você pelo processo de integração e ajudaremos seu serviço a obter um cartão de entrada em nossa galeria da Grade de Eventos do Azure para que o serviço possa ser encontrado no portal do Azure.

2. Crie um registro de parceiro. Esse é um recurso global, e você geralmente precisa criar uma vez.

3. Crie um namespace de parceiro. Esse recurso expõe um ponto de extremidade no qual você pode publicar eventos no Azure. Ao criar o namespace do parceiro, forneça o registro de parceiro que você criou.

4. O cliente autoriza você a criar um tópico de parceiro na assinatura do Azure do cliente.

5. O cliente acessa sua página da Web ou executa um comando, você define a experiência do usuário para solicitar o fluxo de seus eventos para o Azure ou a capacidade de receber eventos da Microsoft em seu sistema. Em resposta a essa solicitação, você configura seu sistema para fazer isso com a entrada do cliente. Por exemplo, o cliente pode ter a opção de selecionar determinados eventos do sistema que devem ser encaminhados para o Azure.

6. Crie um tópico de parceiro na assinatura e no grupo de recursos do Azure do cliente usando canais. Os canais são recursos contidos por namespaces de parceiros.

7. O cliente ativa o tópico do parceiro que você criou na assinatura e no grupo de recursos do Azure dele.

8. Inicie a publicação de eventos no namespace do parceiro.

   Observação

   Você deve registrar o provedor de recursos da Grade de Eventos do Azure em cada assinatura do Azure em que deseja criar recursos da Grade de Eventos. Caso contrário, as operações para criar recursos falharão.

Por que devo usar os Eventos de Parceiros?

Talvez seja conveniente usar o recurso Eventos de Parceiros se você tiver um ou mais dos requisitos a seguir.

Para parceiros como editores de eventos

• Você deseja que um mecanismo torne seus eventos disponíveis aos clientes no Azure. Os usuários podem filtrar e rotear esses eventos usando tópicos de parceiro e assinaturas de eventos que eles têm e gerenciam. Você pode usar outras abordagens de integração, como tópicos e domínios. No entanto, essas abordagens não permitiriam uma separação limpa de propriedade, gerenciamento e cobrança de recursos entre você e seu cliente. O recurso Eventos de Parceiros também fornece uma experiência de usuário mais intuitiva que facilita a descoberta do serviço.
• Você precisa de um modelo multilocatário simples no qual você publica eventos em um único ponto de extremidade regional, o ponto de extremidade do namespace, para rotear os eventos para clientes diferentes.
• Você deseja ter visibilidade das métricas relacionadas aos eventos publicados.
• Você deseja usar o esquema de Eventos de Nuvem 1.0 para seus eventos.

Para parceiros como assinante

• Você deseja que seu serviço reaja aos eventos do cliente originados no Microsoft Azure.
• Você deseja que seu cliente reaja aos eventos de serviço do Microsoft Azure usando os aplicativos hospedados pela sua plataforma. Você usa os recursos de roteamento de evento da plataforma para entregar eventos à solução de cliente correta.
• Você deseja um modelo simples em que seus clientes selecionem apenas o nome de serviço como um destino sem a necessidade de conhecer detalhes técnicos como os pontos de extremidade da plataforma.
• Seu sistema/plataforma dá suporte ao esquema Cloud Events 1.0.

Recursos gerenciados por parceiros

Como parceiro, você gerencia os seguintes tipos de recursos.

Registro de parceiro

Um registro contém informações gerais relacionadas a um parceiro. Um registro é necessário ao criar um namespace de parceiro. Ou seja, você deve ter um registro de parceiro para criar os recursos necessários do Azure para integração com a Grade de Eventos do Azure.

Os registros são globais. Ou seja, eles não estão associados a uma região específica do Azure. Você pode criar um único registro de parceiro e usá-lo ao criar namespaces de parceiro.

Canal

O Canal é um recurso aninhado para um Namespace de Parceiro. Um canal tem duas finalidades principais:

• É o tipo de recurso que permite criar recursos de parceiro na assinatura do Azure de um cliente. Quando você cria um canal de tipo partner topic, um tópico de parceiro é criado na assinatura do Azure de um cliente. Um tópico de parceiro é um recurso do cliente para o qual os eventos são roteados quando um sistema de parceiros publica eventos.

  Um canal tem o mesmo ciclo de vida que seu tópico ou destino de parceiro de cliente associado. Quando um canal de tipo partner topic é excluído, por exemplo, o tópico de parceiro do cliente associado é excluído. Da mesma forma, se o tópico do parceiro for excluído pelo cliente, o canal associado em sua assinatura do Azure será excluído.

• É um recurso usado para rotear eventos. Um canal de tipo partner topic é usado para rotear eventos para o tópico de parceiro de um cliente. Ele dá suporte a dois tipos de modos de roteamento.

  • Roteamento de nome de canal. Com esse tipo de roteamento, você publica eventos usando um cabeçalho http chamado aeg-channel-name, em que você fornece o nome do canal para o qual os eventos devem ser roteado. Como os canais são a representação de tópicos de parceiro de um parceiro, os eventos roteado para o canal são exibidos no tópico de parceiro do cliente. Esse tipo de roteamento é uma nova funcionalidade não presente no event channels, que dá suporte apenas ao roteamento baseado em origem. O roteamento de nome de canal permite mais casos de uso do que o roteamento baseado na origem e é o modo de roteamento recomendado a ser escolhido. Por exemplo, com o roteamento de nome de canal, um cliente pode solicitar eventos que se originam em diferentes fontes de eventos para aplicação em um único tópico de parceiro.
  • Roteamento baseado em origem. Essa abordagem de roteamento baseia-se no valor do atributo de contexto source no evento. As fontes são mapeadas para canais, e quando um evento vem com uma origem, digamos, de valor "A", esse evento é roteado para o tópico do parceiro associado ao canal que contém "A" em sua propriedade de origem.

  Talvez você queira declarar os tipos de evento roteados para o canal e para o tópico de parceiro associado. Os tipos de evento são mostrados aos clientes ao criar assinaturas de evento no tópico do parceiro e são usados para selecionar os tipos de evento específicos a serem enviados para um destino de manipulador de eventos. Saiba mais.

  Importante

  Os tipos de eventos podem ser gerenciados no canal e, depois que os valores forem atualizados, as alterações serão refletidas imediatamente no tópico do parceiro associado.

Namespace de parceiro

O namespace de parceiro é um recurso regional que tem um ponto de extremidade para publicar eventos na Grade de Eventos do Azure. Os namespaces de parceiro contêm canais ou canais de evento (recurso herdado). Você deve criar namespaces de parceiro em regiões em que os clientes solicitam tópicos ou destinos de parceiros porque os canais e seus recursos de parceiro correspondentes devem residir na mesma região. Você não pode ter um canal em uma determinada região com seu tópico de parceiro relacionado, por exemplo, localizado em uma região diferente.

Os namespaces de parceiro contêm canais ou canais de evento. Isso é determinado pelo modo de roteamento do tópico do parceiro de propriedade no namespace. Se estiver definido como Cabeçalho de nome do canal, os canais serão o único tipo de recurso que pode ser criado no namespace. Se o modo de roteamento de tópico do parceiro estiver definido como Atributo de origem no evento, o namespace só poderá conter canais de evento. Lembre-se de que a decisão de definir o partner topic routing mode correto não é uma decisão entre escolher o nome do canal ou o roteamento baseado na origem. Os canais dão suporte a ambos. É uma decisão entre usar o novo tipo de recurso de roteamento, os canais, e usar um recurso herdado, os canais de eventos.

Canal de evento

Um canal de eventos é o recurso que foi lançado pela primeira vez com Eventos de Parceiros para rotear eventos de entrada para tópicos de parceiro. Os canais de eventos dão suporte apenas ao roteamento baseado em origem e sempre representam um tópico de parceiro do cliente.

Parceiros verificados

Um parceiro verificado é uma organização parceira cuja identidade foi validada pela Microsoft. É altamente incentivado que sua organização seja verificada. Os clientes buscam se envolver com parceiros que foram verificados, visto que tal verificação fornece maiores garantias de que estão lidando com uma organização legítima. Após a verificação, você se beneficia de ter uma presença na Galeria de Grade de Eventos, na qual os clientes podem descobrir seu serviço facilmente e ter uma experiência interna ao assinar seus eventos, por exemplo.

Autorização do cliente para criar tópicos de parceiro

Os clientes autorizam você a criar tópicos de parceiro na sua assinatura do Azure. A autorização é concedida para um determinado grupo de recursos em uma assinatura do Azure do cliente e está associada ao tempo. Você deve criar o canal antes da data de validade definida pelo cliente. Você deve ter uma documentação sugerindo ao cliente uma janela de tempo adequada para configurar o sistema para enviar ou receber eventos e criar o canal antes que a autorização expire. Se você tentar criar um canal sem autorização ou depois de ele expirar, a criação do canal falhará e nenhum recurso será criado na assinatura do Azure do cliente.

Ativação do tópico de parceiro

O cliente ativa o tópico do parceiro ou o destino que você criou para ele. Nesse ponto, o status de ativação do canal muda para Ativado. Depois que um canal é ativado, você pode começar a publicar eventos no ponto de extremidade do namespace do parceiro que contém o canal.

Como automatizar o processo para saber quando você pode iniciar a publicação de eventos para um determinado tópico de parceiro?

Você tem duas opções:

• Leia (sonde) o estado do canal periodicamente para verificar se o status de ativação fez a transição de Nunca ativado para Ativado. Essa operação pode utilizar muito recurso de computação.
• Crie uma assinatura de evento para a assinatura do Azure ou o grupo de recursos que contém os canais que você deseja monitorar. Você receberá Microsoft.Resources.ResourceWriteSuccess eventos sempre que um canal for atualizado. Em seguida, você precisará ler o estado do canal com a ID do Azure Resource Manager fornecida no evento para verificar se a atualização está relacionada a uma alteração no status de ativação para Ativada.

Referências

• Swagger
• Modelo de ARM
• Esquema de modelo do ARM
• APIs REST
• Extensão da CLI

SDKs

• .NET
• Python
• Java
• Ruby
• JS
• Go

Próximas etapas

• Como se integrar como um parceiro da Grade de Eventos (portal do Azure)
• Formulário de integração de tópicos de parceiros
• Visão geral dos tópicos de parceiros
• Tópico de parceiro do Auth0
• Como usar o tópico de parceiro do Auth0