Visão geral de eventos de parceiros para parceiros - Grade de Eventos do Azure

Artigo
10/18/2023

Os Eventos de Parceiros da Grade de Eventos permitem que os clientes assinem eventos originários de um sistema registrado usando o mesmo mecanismo que usariam para qualquer outra fonte de eventos no Azure, como um serviço do Azure. Os sistemas registados integram-se com a Event Grid são conhecidos como "parceiros". Esse recurso também permite que os clientes enviem eventos para sistemas parceiros que suportam o recebimento e o roteamento de eventos para soluções/endpoints do cliente em sua plataforma. Normalmente, os parceiros são fornecedores de software como serviço (SaaS) ou ERP , mas podem ser plataformas corporativas que desejam disponibilizar seus eventos para equipes internas. Eles se integram propositalmente à Grade de Eventos para realizar casos de uso de clientes de ponta a ponta que terminam no Azure (os clientes se inscrevem em eventos enviados pelo parceiro) ou terminam em um sistema de parceiro (os clientes se inscrevem em eventos da Microsoft enviados pela Grade de Eventos do Azure). Os clientes fazem login 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 confiam na Grade de Eventos do Azure para rotear eventos originários de 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 de Parceiros, os clientes podem criar soluções orientadas para eventos entre plataformas e limites de rede para receber ou enviar eventos de forma confiável, segura e em escala.

Nota

Este é um artigo conceitual que deve ser lido antes de decidir integrar como parceiro da Grade de Eventos do Azure. Para obter instruções passo a passo sobre como integrar como um parceiro de Grade de Eventos usando o portal do Azure, consulte Como integrar como um parceiro de Grade de Eventos (portal do Azure).

Eventos de parceiros: como funciona

Como parceiro, você cria recursos de Grade de Eventos que permitem publicar eventos na Grade de Eventos do Azure para que os clientes no Azure possam assiná-los. Para a maioria dos parceiros, por exemplo, provedores de SaaS, é o único recurso de integração que eles usarão.

Você também pode criar recursos da Grade de Eventos para receber eventos da Grade de Eventos do Azure. Este caso de uso é para as organizações que possuem ou gerenciam uma plataforma que permite que seus clientes recebam eventos expondo endpoints. 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 do cliente hospedado em sua plataforma.

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

Entre em contato com a equipe do Event Grid para askgrid@microsoft.com comunicar seu interesse em se tornar um parceiro. Depois de entrar em contato conosco, vamos guiá-lo pelo processo de integração e ajudar seu serviço a obter um cartão de entrada em nossa galeria de Grade de Eventos do Azure para que seu serviço possa ser encontrado no portal do Azure.
Crie um registo de parceiro. Este é um recurso global e você geralmente precisa criar uma vez.
Crie um namespace de parceiro. Este recurso expõe um ponto de extremidade no qual você pode publicar eventos no Azure. Ao criar o namespace de parceiro, forneça o registro de parceiro que você criou.
O cliente autoriza você a criar um tópico de parceiro na assinatura do Azure do cliente.
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 fazê-lo com a entrada do cliente. Por exemplo, o cliente pode ter a opção de selecionar determinados eventos do seu sistema que devem ser encaminhados para o Azure.
Crie um tópico de parceiro na assinatura do Azure do cliente e no grupo de recursos usando canais. Os canais são recursos contidos por namespaces de parceiros.
O cliente ativa o tópico de parceiro que você criou em sua assinatura do Azure e no grupo de recursos.
Comece a publicar eventos no namespace do parceiro.

Nota

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?

Você pode usar o recurso Eventos de parceiros se tiver um ou mais dos seguintes requisitos.

Para parceiros como editores de eventos

Você deseja um mecanismo para disponibilizar seus eventos para seus clientes no Azure. Seus usuários podem filtrar e rotear esses eventos usando tópicos de parceiros e assinaturas de eventos que possuem 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 clara de propriedade, gerenciamento e faturamento de recursos entre você e seu cliente. O recurso Eventos de parceiros também oferece uma experiência de usuário mais intuitiva que facilita a descoberta do seu serviço.
Você precisa de um modelo multilocatário simples em que publique eventos em um único ponto de extremidade regional, o ponto de extremidade do namespace, para rotear os eventos para clientes diferentes.
Você quer ter visibilidade das métricas relacionadas aos eventos publicados.
Você deseja usar o esquema do Cloud Events 1.0 para seus eventos.

Para parceiros como subscritor

Você deseja que seu serviço reaja a eventos de clientes originários do Microsoft Azure.
Você deseja que seu cliente reaja a eventos de serviço do Microsoft Azure usando seus aplicativos hospedados pela sua plataforma. Você usa os recursos de roteamento de eventos da sua plataforma para fornecer eventos para a solução certa para o cliente.
Você quer um modelo simples em que seus clientes apenas selecionem o nome do serviço como destino sem a necessidade de conhecer detalhes técnicos, como os endpoints da plataforma.
O seu sistema/plataforma suporta o esquema Cloud Events 1.0 .

Recursos geridos por parceiros

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

Registo de parceiros

Um registo contém informações gerais relacionadas com 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.

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

Canal

Um canal é um recurso aninhado para um namespace de parceiro. Um canal tem duas finalidades principais:

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

Um canal tem o mesmo ciclo de vida que o cliente, parceiro, tópico ou destino associado. Quando um canal do 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 do tipo partner topic é usado para rotear eventos para o tópico de parceiro de um cliente. Ele suporta 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 onde você fornece o nome do canal para o qual os eventos devem ser roteados. Como os canais são a representação de tópicos de parceiros por um parceiro, os eventos encaminhados para o canal são exibidos no tópico do participante do cliente. Esse tipo de roteamento é um novo recurso não presente no , que suporta apenas roteamento baseado na event channelsorigem. O roteamento de nome de canal permite mais casos de uso do que o roteamento baseado na origem e é o modo de roteamento recomendado para escolher. Por exemplo, com o roteamento de nome de canal, um cliente pode solicitar eventos que se originam em diferentes fontes de eventos para chegar a um único tópico de parceiro.
- Roteamento baseado em origem. Essa abordagem de roteamento é baseada no valor do source atributo context no evento. As fontes são mapeadas para canais e, quando um evento vem com uma fonte, digamos, de valor "A", esse evento é roteado para o tópico de parceiro associado ao canal que contém "A" em sua propriedade source.
Convém declarar os tipos de evento que são roteados para o canal e para seu tópico de parceiro associado. Os tipos de evento são mostrados aos clientes ao criar assinaturas de eventos no tópico do parceiro e são usados para selecionar os tipos de eventos específicos a serem enviados para um destino de manipulador de eventos. Mais informações.

Importante

Os tipos de evento podem ser gerenciados no canal e, uma vez que os valores são atualizados, as alterações são refletidas imediatamente no tópico de parceiro associado.

Espaço de nomes de parceiro

Um 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 eventos (recurso herdado). Você deve criar namespaces de parceiro em regiões onde 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 parceiros contêm canais ou canais de eventos. Ele é determinado pelo modo de roteamento de tópico do parceiro de propriedade no namespace. Se estiver definido como Cabeçalho do nome do canal, os canais serão o único tipo de recurso que pode ser criado sob o namespace. Se o modo de roteamento de tópico de parceiro estiver definido como atributo Source no evento, o namespace só poderá conter canais de evento. Lembre-se de que a decisão de definir o certo partner topic routing mode não é uma decisão entre escolher o nome do canal ou o roteamento baseado na fonte. Os canais suportam ambos. É antes uma decisão entre usar o novo tipo de recurso de roteamento, os canais, versus usar um recurso legado, os canais de evento.

Canal do 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 parceiros. Os canais de eventos suportam apenas o roteamento baseado na origem e sempre representam um tópico de parceiro do cliente.

Importante

Os canais de eventos estão sendo preteridos. Por isso, é aconselhável que você use Canais.

Parceiros verificados

Um parceiro verificado é uma organização parceira cuja identidade foi validada pela Microsoft. É altamente recomendável que sua organização seja verificada. Os clientes procuram interagir com parceiros que foram verificados, pois essa verificação oferece maiores garantias de que estão lidando com uma organização legítima. Uma vez verificado, você se beneficia de ter uma presença na Galeria de Grade de Eventos, onde os clientes podem descobrir seu serviço facilmente e ter uma experiência de primeira parte ao assinar seus eventos, por exemplo.

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

Os clientes autorizam você a criar tópicos de parceiros em sua assinatura do Azure. A autorização é concedida para um determinado grupo de recursos em uma assinatura do Azure do cliente e tem limite de tempo. Você deve criar o canal antes da data de expiração definida pelo cliente. Você deve ter documentação sugerindo ao cliente uma janela de tempo adequada para configurar seu 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 que ele expirar, a criação do canal falhará e nenhum recurso será criado na assinatura do Azure do cliente.

Nota

A Grade de Eventos começou a aplicar verificações de autorização para criar tópicos de parceiros por volta de 30 de junho de 2022. Sua documentação deve solicitar que seus clientes concedam a autorização como pré-requisito antes de criar um canal.

Importante

Um parceiro verificado não é um parceiro autorizado. Mesmo que um parceiro tenha sido aprovado pela Microsoft, você ainda precisa ser autorizado antes de criar um tópico de parceiro na assinatura do Azure do cliente.

Ativação de tópico de parceiro

O cliente ativa o tópico ou destino do parceiro 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 pode começar a publicar eventos para um determinado tópico de parceiro?

Tem duas opções:

Leia (sondagem) o estado do canal periodicamente para verificar se o status de ativação passou de NeverActivated para Activated. Esta operação pode ser computacionalmente intensiva.
Crie uma assinatura de evento para a assinatura do Azure ou grupo de recursos que contenha o(s) canal(is) 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 Ativado.