Integrar como um parceiro da Grade de Eventos do Azure usando o portal do Azure

Este artigo descreve a maneira como provedores SaaS de terceiros, também conhecidos como parceiros , são integrados à Grade de Eventos para poder publicar eventos de seus serviços e como esses eventos são consumidos pelos usuários finais.

Processo de integração para parceiros

Em poucas palavras, habilitar os eventos do serviço a serem consumidos pelos usuários normalmente envolve o seguinte processo:

1. Comunique seu interesse em se tornar um parceiro para a equipe de serviço da Grade de Eventos.

2. Registre o provedor de recursos da Grade de Eventos com sua assinatura do Azure.

3. Crie um registro de parceiro.

4. Crie um namespace.

5. Crie um canal e um tópico de parceiro em uma única etapa.

   Importante

   Você pode criar um canal de eventos (herdado), que oferece suporte a tópicos de parceiros. Channel é o novo tipo de recurso de roteamento e é a opção preferencial, que suporta o envio de eventos através de tópicos parceiros. Um canal de eventos é um recurso herdado e será preterido em breve.

6. Teste a funcionalidade de Eventos de Parceiro de ponta a ponta.

Para a etapa nº 5, você deve decidir que tipo de experiência de usuário deseja fornecer. Você tem as seguintes opções:

• Fornecer sua própria solução, normalmente uma experiência de GUI (interface gráfica do usuário) da Web, hospedada em seu domínio usando nosso SDK e/ou API REST para criar um canal (mais recente e recomendado)/canal de evento (herdado) e seu tópico de parceiro correspondente. Com essa opção, você pode solicitar ao usuário a assinatura e o grupo de recursos no qual você criará um tópico de parceiro.
• Use o portal do Azure ou a CLI para criar o canal (recomendado)/canal de eventos (herdado) e um tópico de parceiro associado. Com essa opção, você deve obter a assinatura do Azure do usuário, de alguma forma e o grupo de recursos sob o qual você criará um tópico de parceiro.

Este artigo mostra como integrar como um parceiro da Grade de Eventos do Azure usando o portal do Azure.

Comunique seu interesse em se tornar um parceiro

Entre em contato com a equipe da Grade de Eventos no askgrid@microsoft.com comunicando seu interesse em se tornar um parceiro. Teremos uma conversa com você, fornecendo informações detalhadas sobre os casos de uso, personas, processo de integração, funcionalidade, preços e mais referentes aos Eventos de Parceiros.

Pré-requisitos

Para concluir as etapas restantes, verifique se você tem:

• Uma assinatura do Azure. Se você não tiver uma conta gratuita, crie uma antes de começar.
• Um tenant do Azure.

Registrar o provedor de recursos da Grade de Eventos

A menos que você tenha usado a Grade de Eventos antes, precisará registrar o provedor de recursos da Grade de Eventos. Se você tiver usado a Grade de Eventos antes, pule para a próxima seção.

No portal do Azure, siga as etapas abaixo:

1. No menu à esquerda, selecione Assinaturas.

2. Selecione a assinatura que você deseja usar para a Grade de Eventos na lista de assinaturas.

3. Na página Assinatura, selecione Provedores de recursos na seção Configurações no menu à esquerda.

4. Pesquise por Microsoft.EventGrid e confirme que o Status é Não registrado.

5. Selecione Microsoft.EventGrid na lista de provedores.

6. Selecione Registrar na barra de comandos.

   

7. Atualize para verificar se o status do Microsoft.EventGrid foi alterado para Registrado.

   

Criar um registro de parceiro

1. Entre no portal do Azure.

2. Selecione Todos os serviços no painel de navegação esquerdo, digite os Registros de Parceiros da Grade de Eventos na barra de pesquisa e selecione-os.

3. Na página Registros de Parceiros da Grade de Eventos, selecione + Criar na barra de comandos ou o link Criar registros de parceiros da Grade de Eventos na página.

   

4. Na página Criar Registros de Tipo de Tópico do Parceiro – Noções Básicas, insira as seguintes informações:

   1. Na seção Detalhes do Projeto , siga estas etapas:
      1. Selecione sua assinatura do Azure.
      2. Selecione um grupo de recursos existente do Azure ou crie um novo grupo de recursos.
   2. Na seção Detalhes do registro , siga estas etapas:
      1. Para o nome de Registro, insira um nome para o registro.
      2. Para o nome da organização, insira o nome da sua organização.
   3. Na seção Tipo de recurso parceiro , insira detalhes sobre o tipo de recurso que será exibido na página de criação do tópico do parceiro :

      1. Para Partner resource type name, insira o nome para o tipo de recurso.

      2. Em Nome de exibição, insira um nome de exibição amigável para o tipo de tópico de parceiro (recurso).

      3. Insira uma descrição para o tipo de recurso.

      4. Insira uma descrição para o cenário. Deve explicar as maneiras ou os cenários em que os tópicos de parceiros relacionados aos seus recursos podem ser usados.

         

5. Selecione Avançar: Serviço Personalizado na parte inferior da página. Na guia Atendimento ao Cliente da página Criar Registro de Parceiro , insira informações que os usuários assinantes usarão para contatá-lo quando houver um problema com a origem do evento:

   1. Insira o número de telefone.

   2. Insira a extensão do número de telefone.

   3. Insira a URL do site de suporte.

      

6. Selecione Avançar: Marcas na parte inferior da página.

7. Na página Marcas , configure os valores a seguir.

   1. Insira um nome e um valor para a marca que você deseja adicionar. Esta etapa é opcional.
   2. Selecione Revisar + criar na parte inferior da página para criar o registro (tipo de tópico do parceiro).

8. Na página Revisar + criar , examine todas as configurações e selecione Criar para criar o registro do parceiro.

Criar um namespace de parceiro

1. No portal do Azure, selecione Todos os serviços no menu de navegação esquerdo, digite Namespaces do Parceiro da Grade de Eventos na barra de pesquisa e selecione-os na lista.

2. Na página Event Grid Partner Namespaces, selecione + Criar na barra de ferramentas.

   

3. Na página Criar Namespace de Parceiro - Informações Básicas, especifique as seguintes informações.

   1. Na seção detalhes do Projeto , execute as seguintes etapas:

      1. Selecione uma assinatura do Azure.
      2. Selecione um grupo de recursos existente ou crie um grupo de recursos.

   2. Na seção detalhes do Namespace , execute as seguintes etapas:

      1. Insira um nome para o namespace.

      2. Selecione uma localização para o namespace.

      3. Para o Modo de roteamento de tópico do parceiro, selecione o Cabeçalho do nome do canal ou o Atributo de origem no evento.

         • Roteamento de cabeçalho com nome do canal: com esse tipo de roteamento, você publica eventos usando um cabeçalho http chamado aeg-channel-name no qual você fornece o nome do canal para o qual os eventos devem ser roteados. Se você selecionar essa opção, criará canais no namespace.
         • Atributo de origem no roteamento de eventos . Essa abordagem de roteamento baseia-se no valor do source atributo de contexto no evento. Se você selecionar essa opção, criará canais de evento, que são equivalentes herdados aos canais e serão preteridos em breve.

         Importante

         • Não é possível atualizar o modo de roteamento depois que o namespace é criado.
         • Canal é o novo tipo de recurso de roteamento e é a opção preferida. Um canal de eventos é um recurso herdado e será preterido em breve.

   3. Na seção Detalhes do Registro , siga estas etapas para associar o namespace a um registro de parceiro.

      1. Selecione a assinatura na qual o registro do parceiro existe.
      2. Selecione o grupo de recursos que contém o registro do parceiro.
      3. Selecione o registro de parceiro na lista suspensa.

   4. Selecione Avançar: Marcas na parte inferior da página.

      

4. Na página Marcas , adicione marcas (opcional).

   1. Insira um nome e um valor para a marca que você deseja adicionar. Esta etapa é opcional.
   2. Selecione Revisar + criar na parte inferior da página.

5. Na página Revisar + criar , examine os detalhes e selecione Criar.

Criar um canal

Se você selecionou Cabeçalho de nome do canal para o Modo de roteamento de tópicos do parceiro, crie um canal seguindo as etapas nesta seção.

1. Vá para a página Visão geral do namespace de parceiro que você criou e selecione + Canal na barra de comandos.

   

2. Na página Criar Canal – Noções Básicas, siga estas etapas.

   1. Insira um nome para o canal. O nome do canal deve ser exclusivo em toda a região na qual é criado.

   2. No tipo de canal, selecione Tópico do Parceiro.

      Os tópicos do parceiro são recursos que contêm eventos publicados. Selecione o Tópico do Parceiro se você quiser encaminhar eventos para um tópico de parceiro que contém eventos a serem processados por um manipulador posteriormente.

   3. Se você selecionou o Tópico do Parceiro, insira os seguintes detalhes:

      1. ID da assinatura na qual o tópico do parceiro será criado.

      2. Grupo de recursos no qual o tópico do parceiro será criado.

      3. Nome do tópico do parceiro.

      4. Especifique as informações de origem para o tópico do parceiro. Origem é a informação contextual sobre a origem dos eventos fornecida pelo parceiro e que pode ser vista pelo usuário final. Essas informações são úteis quando o usuário final está considerando ativar um tópico de parceiro, por exemplo.

         

      5. Selecione Adicionar definições de tipo de evento para declarar o tipo de eventos que são enviados para o canal e para seu 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.

         

         

         

   4. Selecione Avançar: link Recursos Adicionais na parte inferior da página.

   5. Na página Recursos Adicionais , siga estas etapas:

      1. Para definir sua própria mensagem de ativação que pode ajudar o usuário final a ativar o tópico do parceiro associado, marque a caixa de seleção ao lado de Definir sua própria mensagem de ativação e insira a mensagem.
      2. Para o tempo de expiração, defina a hora após a criação deste canal no qual o tópico do parceiro associado e esse canal serão excluídos automaticamente se não forem ativados pelo usuário final. 1.Selecione Avançar: Examinar + criar.

      

   6. Na página Revisar + criar , examine todas as configurações do canal e selecione Criar na parte inferior da página.

      Opção de tópico do parceiro:

Gerenciar um canal

Se você criou um canal, talvez esteja interessado em atualizar a configuração depois que o recurso tiver sido criado.

1. Acesse a Configuração do canal. Você pode atualizar a mensagem para ativação do tópico do parceiro, hora de expiração se não estiver ativado e definições de tipo de evento.

   

Criar um canal de eventos

Se você selecionou o Atributo de origem no evento para o Modo de roteamento de tópico do parceiro, crie um canal de eventos seguindo as etapas nesta seção.

1. Vá para a página Visão geral do namespace que você criou.

   partner-namespace-overview.png

2. Selecione + Canal de Eventos na barra de ferramentas.

3. Na página Criar Canal de Eventos – Noções básicas, especifique as informações a seguir.

   1. Na seção Detalhes do Canal , execute estas etapas:

      1. Para nome do canal de evento, insira um nome para o canal de evento.
      2. Insira a origem. Consulte as especificações de Eventos de Nuvem 1.0 para ter uma ideia de um valor adequado para a origem. Além disso, consulte este exemplo de esquema de Eventos de Nuvem.

   2. Na seção Detalhes de destino , insira detalhes para o tópico do parceiro de destino que será criado para este canal de eventos.

      1. Insira o ID da assinatura onde o tópico do parceiro será criado.
      2. Insira o nome do grupo de recursos no qual o recurso de tópico do parceiro será criado.
      3. Insira um nome para o tópico do parceiro.

   3. Selecione Avançar: Filtros na parte inferior da página.

      

4. Na página Filtros , adicione filtros. execute as seguintes etapas:

   1. Filtrar os atributos de cada evento. Somente os eventos que correspondem a todos os filtros são entregues. Até 25 filtros podem ser especificados. Comparações não diferenciam maiúsculas de minúsculas. As chaves válidas usadas para filtros variam de acordo com o esquema de evento. No exemplo a seguir, eventid, sourcee eventtypeeventtypeversioin pode ser usado para chaves. Você também pode usar propriedades personalizadas dentro do payload de dados, usando . como operador de aninhamento. Por exemplo: data, data.key, data.key1.key2.

   2. Selecione Avançar: Recursos adicionais na parte inferior da página.

      

5. Na página Recursos adicionais , você pode definir um tempo de expiração e uma descrição para o tópico do parceiro.

   1. O tempo de expiração é o momento em que o tópico e seu canal de eventos associados serão excluídos automaticamente se não forem ativados pelo cliente. Um padrão de sete dias é usado caso uma hora não seja fornecida. Marque a caixa de seleção para especificar seu próprio tempo de expiração.

   2. Como este tópico é um recurso que não é criado pelo usuário, uma descrição pode ajudar o usuário a entender a natureza deste tópico. Uma descrição genérica será fornecida se nenhuma estiver definida. Marque a caixa de seleção para definir sua própria descrição do tópico do parceiro.

   3. Selecione Avançar: Revisar + criar.

      

6. Na revisão + criação, examine as configurações e selecione Criar para criar o canal de eventos.

Ativar tópicos de parceiro

Antes que os usuários possam assinar tópicos de parceiro que você criar em suas assinaturas do Azure, eles terão que ativar os tópicos do parceiro primeiro. Para obter detalhes, consulte Ativar um tópico de parceiro.

Próximas etapas

Consulte os seguintes artigos para obter mais detalhes sobre o recurso Eventos de Parceiros:

• Visão geral de eventos de parceiros para clientes
• Visão geral de eventos de parceiros para parceiros
• Assinar eventos de parceiros
• Assinar eventos do Auth0