Partilhar via


Integre-se como parceiro do Azure Event Grid usando o portal do Azure

Este artigo descreve a maneira como os provedores de 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.

Importante

Os parceiros podem publicar eventos na Grade de Eventos do Azure e também receber eventos dela. Esses recursos são habilitados por meio do recurso Eventos de parceiros . Se você não estiver familiarizado com Eventos de Parceiros, consulte Visão geral de Eventos de Parceiros para obter uma introdução detalhada dos principais conceitos que são essenciais para entender e seguir as etapas neste artigo.

Processo de integração para parceiros

Em resumo, permitir que os eventos do seu serviço sejam consumidos pelos usuários normalmente envolve o seguinte processo:

  1. Comunique o seu interesse em tornar-se um parceiro à equipa de serviço da Grelha de Eventos.

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

  3. Crie um registo 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 evento (legado), que ofereça suporte a tópicos de parceiros. Canal é o novo tipo de recurso de roteamento e é a opção preferida, que suporta o envio de eventos por meio de tópicos de parceiros. Um canal de eventos é um recurso herdado e será preterido em breve.

  6. Teste a funcionalidade de eventos de parceiros de ponta a ponta.

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

  • Forneça a sua própria solução, geralmente uma experiência de interface gráfica do utilizador (GUI) da Web, alojada no seu domínio utilizando o nosso SDK e/ou API REST para criar um canal (mais recente e recomendado) ou um canal de eventos (legado) e o respetivo tópico parceiro. Com essa opção, você pode solicitar ao usuário a assinatura e o grupo de recursos sob o qual você criará um tópico de parceiro.
  • Use o portal do Azure ou a CLI para criar o canal (recomendado)/canal de evento (legado) e um tópico de parceiro associado. Com esta opção, deves ter acesso à assinatura do Azure do utilizador de alguma forma e ao grupo de recursos sob o qual irás criar um tópico de parceiro.

Este artigo mostra como integrar-se enquanto parceiro do Azure Event Grid usando o portal do Azure.

Comunique o seu interesse em tornar-se parceiro

Contacte a equipa do Event Grid em askgrid@microsoft.com comunicando o seu interesse em tornar-se parceiro. Teremos uma conversa com você fornecendo informações detalhadas sobre casos de uso, personas, processo de integração, funcionalidade, preços e muito mais dos Eventos de Parceiros.

Pré-requisitos

Para concluir as etapas restantes, certifique-se de que:

Registrar o provedor de recursos da Grade de Eventos

A menos que você já tenha usado a Grade de Eventos antes, precisará registrar o provedor de recursos da Grade de Eventos. Se já utilizou a Grelha de Eventos antes, avance para a secção seguinte.

No portal do Azure, execute as seguintes etapas:

  1. No menu à esquerda, selecione Assinaturas.

  2. Selecione a subscrição que pretende utilizar para a Grelha de Eventos na lista de subscrições.

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

  4. Procure Microsoft.EventGrid e confirme se o Status não está registrado.

  5. Selecione Microsoft.EventGrid na lista de provedores.

  6. Selecione Registrar na barra de comandos.

    Imagem mostrando o registro do provedor Microsoft.EventGrid com a assinatura do Azure.

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

    Imagem mostrando o registro bem-sucedido do provedor Microsoft.EventGrid com a assinatura do Azure.

Criar um registo de parceiro

  1. Inicie sessão no portal Azure.

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

  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.

    Adicionar link de registro de parceiro

  4. Na página Criar Registros de Tipo de Tópico de 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 do Azure existente ou crie um novo grupo de recursos.
    2. Na secção Detalhes do registo , siga estes passos:
      1. Em Nome do registo, introduza um nome para o registo.
      2. Em Nome da organização, insira o nome da sua organização.
    3. Na seção Tipo de recurso de parceiro , insira os detalhes sobre o tipo de recurso que serão exibidos na página de criação do tópico de parceiro :
      1. Em Nome do tipo de recurso de parceiro, insira o nome do tipo de recurso.

      2. Em Nome para 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 como os tópicos dos parceiros para os seus recursos podem ser utilizados em diferentes cenários.

        Criar registo de parceiro

  5. Selecione Next: Custom Service na parte inferior da página. Na guia Atendimento ao Cliente da página Criar Registro de Parceiro , insira as informações que os usuários assinantes usarão para entrar em contato com você quando houver um problema com a origem do evento:

    1. Digite o número de telefone.

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

    3. Introduza uma URL de um site de suporte.

      Criar registo de parceiro - serviço de apoio ao cliente

  6. Selecione Next: Tags na parte inferior da página.

  7. Na página Marcas , configure os seguintes valores.

    1. Introduza um nome e um valor para a etiqueta que pretende adicionar. Esta etapa é opcional.
    2. Selecione Rever + criar na parte inferior da página para criar o registro (tipo de tópico do parceiro).
  8. Na página Rever + criar, reveja todas as definições e, em seguida, selecione Criar para criar o registo de parceria.

Criar um namespace de parceiro

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

  2. Na página Namespaces de Parceiros da Grade de Eventos, na barra de ferramentas, selecione + Criar.

    Namespaces de parceiro - Adicionar link

  3. Na página Criar namespace de parceiro - Noçõ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 de parceiro, selecione Cabeçalho do nome do canal ou Atributo de origem no evento.

        • Roteamento de cabeçalho 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. Se você selecionar essa opção, criará canais no namespace.
        • Atributo Origem no roteamento de eventos. Essa abordagem de roteamento é baseada no valor do source atributo context no evento. Se selecionar esta opção, irá criar canais de eventos, que são legados equivalentes a 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 de parceiro existe.
      2. Selecione o grupo de recursos que contém o registro de parceiro.
      3. Selecione o registro do parceiro na lista suspensa.
    4. Selecione Next: Tags na parte inferior da página.

      Criar namespace de parceiro - página de informações básicas

  4. Na página Etiquetas , adicione etiquetas (opcional).

    1. Introduza um nome e um valor para a etiqueta que pretende adicionar. Esta etapa é opcional.
    2. Selecione Revisar + criar no fundo da página.
  5. Na página Rever + criar , reveja os detalhes e selecione Criar.

Criar um canal

Se tiver selecionado a opção Cabeçalho do nome do canal para o modo de roteamento de tópico de parceiro, crie um canal seguindo as instruções 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.

    Imagem mostrando a seleção do botão Criar Canal na barra de comandos da página Namespace de Parceiro do Event Grid.

  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. Para o tipo de canal, selecione Tópico de Parceiro.

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

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

      1. ID da subscrição na qual o tópico do parceiro será criado.

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

      3. Nome do tópico do parceiro.

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

        Imagem mostrando a página Criar canal - Noções básicas.

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

        Captura de tela que mostra a seção Definições de Tipos de Evento com a opção Adicionar definições de tipos de evento selecionada.

        Captura de tela que mostra a definição de um tipo de evento de exemplo.

        Captura de ecrã que mostra uma lista com a definição de tipo de evento que foi adicionada.

    4. Selecione Next: Additional Features link 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 de 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 o tempo após a criação deste canal no qual o tópico de parceiro associado e este canal serão excluídos automaticamente se não forem ativados pelo usuário final. 1. Selecione Próximo: Rever + criar.

      Imagem mostrando a página Criar canal - Recursos adicionais.

    6. Na página Rever + criar, revise todas as definições do canal e selecione Criar na parte inferior da página.

      Opção de tópico de parceiro : Imagem mostrando a página Criar canal - Revisão + criação.

Gerenciar um canal

Se você criou um canal, pode estar interessado em atualizar a configuração assim que o recurso for criado.

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

    Captura de tela que mostra a página Configuração de um canal.

Importante

Não se esqueça de salvar as alterações antes de sair da página de configuração.

Criar um canal de evento

Se tiver selecionado Atributo de Fonte no evento para o modo de encaminhamento de tópicos de parceiros, crie um canal de eventos seguindo os passos nesta seção.

Importante

  • Canal é o novo tipo de recurso de roteamento e é a opção preferida.
  1. Vá para a página Visão geral do namespace que você criou.

    Namespace de parceiro - página de visão geral partner-namespace-overview.png

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

  3. Na página Criar Canal de Evento - Noções Básicas , especifique as seguintes informações.

    1. Na seção Detalhes do canal , siga estas etapas:

      1. Em Nome do canal de eventos, insira um nome para o canal de eventos.
      2. Insira a fonte. Consulte as especificações do Cloud Events 1.0 para ter uma ideia de um valor adequado para a fonte. Além disso, consulte este exemplo de esquema de eventos de nuvem.
    2. Na seção Detalhes do destino , insira os detalhes do tópico do parceiro de destino que será criado para este canal de evento.

      1. Insira o ID da assinatura na qual o tópico de parceiro será criado.
      2. Insira o nome do grupo de recursos no qual o recurso de tópico de parceiro será criado.
      3. Insira um nome para o tópico do parceiro.
    3. Selecione Seguinte: Filtros na parte inferior da página.

      Criar canal de evento - página básica

  4. Na página Filtros , adicione filtros. Siga os seguintes passos:

    1. Filtre os atributos de cada evento. Apenas os eventos que correspondem a todos os filtros são entregues. Podem ser especificados até 25 filtros. As comparações são insensíveis a maiúsculas e minúsculas. As chaves válidas usadas para filtros variam de acordo com o esquema de eventos. No exemplo a seguir, eventid, source, eventtype, e eventtypeversioin podem ser usadas para chaves. Você também pode usar propriedades personalizadas dentro da carga útil de dados, usando o operador . como operador de aninhamento. Por exemplo: data, data.key, data.key1.key2.

    2. Selecione Next: Recursos adicionais na parte inferior da página.

      Criar canal de evento - página de filtros

  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 evento associado serão excluídos automaticamente se não forem ativados pelo cliente. É usado um padrão de sete dias caso não seja fornecido um prazo. 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 ajudá-lo a entender a natureza desse tópico. Uma descrição genérica será fornecida se nenhuma estiver definida. Marque a caixa de seleção para definir a sua própria descrição do tópico do parceiro.

    3. Selecione Seguinte: Revisar + criar.

      Criar canal de evento - página de recursos adicionais

  6. Em Rever + criar, reveja as definições e selecione Criar para criar o canal de eventos.

Ativar tópicos de parceiros

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

Próximos passos

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