Gatilho do Azure AD

O gatilho do Azure AD é um gatilho de evento de conector que permite invocar uma integração com base nos eventos do Azure AD a que você se inscreveu na conexão do Azure AD.

Antes de começar

Se você planeja criar ou configurar uma nova conexão para o gatilho do Azure AD, verifique se você tem o seguinte papel do IAM no projeto:

Administrador de conectores (roles/connectors.admin)

Para mais informações sobre como conceder papéis, consulte Gerenciar o acesso.

Conceda os seguintes papéis do IAM à conta de serviço que você quer usar para o acionador do Azure AD:

Invocador do Application Integration (roles/integrations.integrationInvoker)

Para informações sobre como conceder papéis a uma conta de serviço, consulte Gerenciar o acesso a contas de serviço.

Adicionar o gatilho do Azure AD

Para adicionar um gatilho do Azure AD à sua integração, siga estas etapas:

No Google Cloud console do, acesse a página Application Integration.
Acessar o Application Integration
No menu de navegação, clique em Integrações.
A página Lista de integrações aparece listando todas as integrações disponíveis no projeto na nuvem do Google Cloud.
Selecione uma integração ou clique em Criar integração para criar uma.
Caso você esteja criando uma nova integração, siga estas etapas:
1. Insira um nome e uma descrição no painel Criar integração.
2. Selecione uma região para a integração.
  Observação: o menu suspenso Regiões lista apenas as regiões provisionadas no projeto do Google Cloud. Para provisionar uma nova região, clique em Ativar região. Consulte Ativar nova região para obter mais informações.
3. Selecione uma conta de serviço para a integração. É possível mudar ou atualizar os detalhes da conta de serviço de uma integração a qualquer momento no painel de informações Resumo da integração na barra de ferramentas de integração.
  Observação:a opção para selecionar uma conta de serviço só será exibida se você tiver ativado a governança de integração para a região selecionada.
4. Clique em Criar.
A integração recém-criada será aberta no editor de integração.
Na barra de navegação do editor de integração, clique em Gatilhos para conferir a lista de gatilhos disponíveis.
Clique e coloque o elemento gatilho do Azure AD no editor de integração.

Para configurar o gatilho do Azure AD, use uma conexão do Azure AD disponível no Integration Connectors ou crie uma nova conexão do Azure AD usando a opção de criação de conexão inline.

Configurar o gatilho do Azure AD usando uma conexão atual

É possível configurar o gatilho do Azure AD usando uma conexão do Azure AD nos Integration Connectors. Observe que o gatilho do Azure AD é um gatilho de evento de conector. Portanto, só é possível usar uma conexão do Azure AD com a assinatura de evento ativada para configurar o gatilho.

Para informações sobre como configurar um gatilho do Azure AD usando uma nova conexão do Azure AD, consulte Configurar o gatilho do Azure AD usando uma nova conexão

Para configurar um gatilho do Azure AD usando uma conexão do Azure AD, siga estas etapas:

Clique no elemento gatilho do Azure AD no editor de integração para abrir o painel de configuração do gatilho.
Clique em Configurar gatilho.
Forneça os seguintes detalhes de configuração na página Editor de gatilho de evento de conector :
1. Região:selecione a região da conexão do Azure AD.
2. Conexão:selecione a conexão do Azure AD que você quer usar.
  O Application Integration mostra apenas as conexões do Azure AD que estão ativas e têm uma assinatura de evento ativada.
3. Tipo de assinatura de evento:selecione o tipo de assinatura de evento que aciona a integração. Para informações sobre os tipos de assinatura de evento compatíveis com esse gatilho, consulte Tipos de assinatura de evento compatíveis.
4. Conta de serviço: selecione uma conta de serviço com os papéis do IAM necessários para o gatilho do Azure AD.
Clique em Concluído para concluir a configuração do gatilho e fechar a página.

Configurar o gatilho do Azure AD usando uma nova conexão

Para configurar o gatilho do Azure AD usando uma nova conexão do Azure AD, siga estas etapas:

Clique no elemento gatilho do Azure AD no editor de integração para abrir o painel de configuração do gatilho.
Clique em Configurar gatilho.
Ignore o campo Região.
Clique em Conexão e selecione a opção Criar conexão no menu suspenso.
Conclua as etapas a seguir no painel Criar conexão :
1. Na etapa Local, escolha o local da nova conexão do Azure AD:
  1. Região:selecione uma região na lista suspensa.
  2. Clique em Próxima.
2. Na etapa Detalhes da conexão, forneça detalhes sobre a nova conexão do Azure AD:
  1. Versão do conector:escolha uma versão disponível do conector do Azure AD na lista suspensa.
  2. Nome da conexão:insira um nome para a conexão do Azure AD.
    Observação:os nomes de conexão precisam atender aos seguintes critérios:
    - Os nomes de conexões podem usar letras, números ou hifens.
    - As letras precisam ser minúsculas.
    - Os nomes das conexões precisam começar com uma letra e terminar com uma letra ou um número.
    - Os nomes das conexões não podem exceder 49 caracteres.
  3. (Opcional) Descrição: insira uma descrição para a conexão.
  4. (Opcional) Ativar o Cloud Logging:marque essa caixa de seleção para armazenar todos os dados de registro da conexão.
  5. Conta de serviço: selecione uma conta de serviço com os papéis do IAM necessários para a conexão do Azure AD.
  6. Ativar assinatura de evento:selecione para criar e ativar uma nova assinatura de evento para a conexão do Azure AD. É possível ativar apenas as assinaturas de eventos ou também incluir entidades, operações e ações de conexão.
    Observação: as seguintes etapas de configuração de conexão adicional são necessárias se você escolher ativar entidades, operações e ações para a conexão:
    - Locatário do Azure: o locatário do Microsoft Online usado para acessar dados. Se você não especificar um locatário, o padrão será usado.
    - Destinos
    - Authentication
  7. (Opcional) Expanda Configurações avançadas para definir as configurações do nó da conexão.
    Para mais informações sobre as configurações do nó de conexão do Azure AD, consulte a documentação de conexão do Azure AD.
  8. (Opcional) Clique em + Adicionar rótulo para adicionar um rótulo à conexão na forma de um par de chave-valor.
  9. Clique em Próxima.
3. Na etapa Destinos, forneça os detalhes da instância do Azure AD:
  1. Tipo de destino: Selecione Endereço do host.
  2. Host:insira o nome do host ou o endereço IP da instância do Azure AD.
  3. Clique em Próxima.
4. Na etapa Autenticação, forneça os detalhes de autenticação da instância do Azure AD:
  1. Selecione o tipo de autenticação desejado e insira os detalhes relevantes.
    Para entender como configurar esses tipos de autenticação, consulte Configurar autenticação.
  2. Clique em Próxima.
5. Na etapa Detalhes da assinatura de evento, forneça detalhes da instância do Azure AD em que as assinaturas de evento serão criadas.
  1. ID do cliente: o ID do cliente usado para solicitar tokens de acesso.
  2. Chave secreta do cliente: a chave secreta do cliente usada para solicitar tokens de acesso.
  3. Versão do secret:selecione uma versão do secret.
  4. Estado do cliente: o secret do Secret Manager que contém o estado do cliente. Isso é usado para autenticação de notificações de mudança.
  5. Locatário do Azure: o locatário do Microsoft Online usado para acessar dados. Se você não especificar um locatário, o padrão será usado.
  6. Se quiser que mais informações serem anexadas à resposta do sistema de back-end, selecione Ativar o aprimoramento de dados.
    As informações adicionais são específicas da entidade para a qual você configurou o evento. Para mais informações, consulte Aprimoramento de dados em notificações de eventos.
    
    Observação: se você tiver configurado essa conexão apenas para a assinatura de evento, não será possível ativar essa opção. Para ativar o aprimoramento de dados, configure a conexão para a assinatura de evento e as operações do conector (entidades e ações).
6. Selecione Ativar conectividade particular para conectividade segura entre o aplicativo de back-end e a conexão. Se você selecionar essa opção, será necessário executar mais etapas de configuração depois de criar a conexão. Para mais informações, consulte Conectividade particular para assinatura de evento.
7. Insira a configuração de mensagens não entregues. Se você configurar mensagens não entregues, a conexão vai gravar os eventos não processados no tópico do Pub/Sub especificado. Insira os seguintes detalhes:
  1. ID do projeto de mensagens não entregues: o ID do projeto na nuvem do Google Cloud em que você configurou o tópico do Pub/Sub de mensagens não entregues.
  2. Tópico de mensagens inativas: o tópico do Pub/Sub em que você quer gravar os detalhes do evento não processado.
8. Se você quiser usar um proxy para se conectar ao back-end (para assinatura de evento), insira os seguintes detalhes:
9. Clique em Próxima.
Analisar: analise os detalhes da conexão do Azure AD fornecidos.
Clique em Criar para concluir a criação de uma nova conexão do Azure AD.
ID do tipo de evento:selecione o tipo de assinatura de evento que aciona a integração. Para informações sobre os tipos de assinatura de evento compatíveis com esse gatilho, consulte Tipos de assinatura de evento compatíveis.
Clique em Concluído e feche a página.

Saída do gatilho

O gatilho do Azure AD leva alguns minutos para concluir a configuração da assinatura de evento. É possível conferir o status da assinatura de evento no painel de configuração do gatilho em Detalhes da assinatura de evento.

O gatilho do Azure AD indica o status de uma assinatura de evento usando os seguintes estados:

Creating: indica que o gatilho está se inscrevendo na assinatura de evento.
Active: indica que o gatilho foi inscrito em uma assinatura de evento.
Error: indica que há um problema com a assinatura de evento configurada.

Além do status da assinatura de evento, a seção Detalhes da assinatura de evento também mostra outros detalhes, como região de conexão, nome da conexão, nome da assinatura de evento e muito mais.

Variável de saída do gatilho

Para cada evento, o gatilho do Azure AD gera uma variável de saída ConnectorEventPayload que pode ser usada nas tarefas downstream. A variável de saída está no formato JSON, contendo o esquema de payload de saída do Azure AD.

Exemplo 1: payload de saída para o evento do Azure AD: Usuário atualizado

  {
    "type": "object",
    "properties": {
      "changeType": {
        "type": "string"
      },
      "clientState": {
        "type": "string"
      },
      "resource": {
        "type": "string"
      },
      "resourceData": {
        "type": "object",
        "properties": {}
      },
      "subscriptionExpirationDateTime": {
        "type": "string"
      },
      "subscriptionId": {
        "type": "string"
      },
      "tenantId": {
        "type": "string"
      }
    }
  }

Exemplo 2: payload de saída de dados enriquecidos para o evento do Azure AD: Usuário atualizado

    {
      "type": "object",
      "properties": {
        "changeType": {
          "type": "string"
        },
        "clientState": {
          "type": "string"
        },
        "context-data": {
          "type": "object",
          "properties": {}
        },
        "resource": {
          "type": "string"
        },
        "resourceData": {
          "type": "object",
          "properties": {}
        },
        "subscriptionExpirationDateTime": {
          "type": "string"
        },
        "subscriptionId": {
          "type": "string"
        },
        "tenantId": {
          "type": "string"
        }
      }
    }

O campo context-data contém dados enriquecidos sobre a entidade.

Conferir assinaturas de eventos

Para conferir e gerenciar todas as assinaturas de eventos associadas a uma conexão no Integration Connectors, faça o seguinte:

Acesse a página Integration Connectors > Conexões.
Acessar a página Conexões
Clique na conexão para a qual você quer conferir as assinaturas.
Clique na guia Assinaturas de eventos.
Isso mostra todas as assinaturas de eventos da conexão.

Editar o gatilho do Azure AD

É possível editar um gatilho do Azure AD para mudar ou atualizar a configuração da conexão e os detalhes da assinatura de evento.

Para editar um gatilho do Azure AD, siga estas etapas:

Clique no elemento gatilho do Azure AD no editor de integração para abrir o painel de configuração do gatilho.
Clique em Configurar gatilho do Azure AD.
Faça o seguinte na página Editor de gatilho de evento de conector :
1. Para manter a assinatura de evento configurada anteriormente, clique em Manter ou em Excluir.
  Aviso:a exclusão de uma assinatura de evento afeta todas as integrações publicadas que usam a assinatura de evento. Esta tarefa não pode ser desfeita.
2. Atualize a configuração da conexão e os detalhes da assinatura de evento conforme desejado.
3. Clique em Concluído.

É possível conferir os detalhes atualizados da conexão e da assinatura de evento no painel de configuração do gatilho em Detalhes da assinatura de evento.

Tipos de assinatura de evento compatíveis

É possível usar o gatilho do Azure AD para invocar uma integração para os seguintes tipos de assinatura de evento:

Tipos de assinatura de evento	Descrição
`Userprofiles`	Um usuário é adicionado, excluído, atualizado ou excluído permanentemente.
`Users.updated`	Um usuário é criado, atualizado ou excluído temporariamente. A criação e a exclusão de usuários acionam um tipo de evento `updated`.
`Users.deleted`	Um usuário é excluído permanentemente.

Cotas e limites

Para informações sobre o assunto, consulte Cotas e limites.

A seguir

Saiba mais sobre todas as tarefas e acionadores.
Saiba como testar e publicar uma integração .

Saiba mais sobre o tratamento de erros.
Saiba mais sobre os registros de execução de integração.