Acionador do Azure AD

O acionador do Azure AD é um acionador de eventos do conetor que lhe permite invocar uma integração com base nos eventos do Azure AD aos quais subscreveu na sua ligação do Azure AD.

Antes de começar

Se planeia criar ou configurar uma nova associação para o acionador do Azure AD, certifique-se de que tem a seguinte função de IAM no projeto:

Administrador do conetor (roles/connectors.admin)

Para informações sobre a concessão de funções, consulte o artigo Faça a gestão do acesso.

Conceda as seguintes funções de IAM à conta de serviço que quer usar para o acionador do Azure AD:

Application Integration Invoker (roles/integrations.integrationInvoker)

Para obter informações sobre a atribuição de funções a uma conta de serviço, consulte o artigo Faça a gestão do acesso às contas de serviço.

Adicione o acionador do Azure AD

Para adicionar um acionador do Azure AD à sua integração, siga estes passos:

Na Google Cloud consola, aceda à página Application Integration.
Aceda à solução Application Integration
No menu de navegação, clique em Integrações
A página Lista de integrações é apresentada com todas as integrações disponíveis no projeto do Google Cloud.
Selecione uma integração existente ou clique em Criar integração para criar uma nova.
Se estiver a criar uma nova integração:
1. Introduza um nome e uma descrição no painel Criar integração.
2. Selecione uma região para a integração.
  Nota: o menu pendente Regiões apenas apresenta as regiões aprovisionadas no seu projeto do Google Cloud. Para aprovisionar uma nova região, clique em Ativar região. Consulte o artigo Ative uma nova região para mais informações.
3. Selecione uma conta de serviço para a integração. Pode alterar ou atualizar os detalhes da conta de serviço de uma integração em qualquer altura no painel Resumo da integração na barra de ferramentas de integração.
  Nota: a opção para selecionar uma conta de serviço é apresentada apenas se tiver ativado a gestão da integração para a região selecionada.
4. Clique em Criar.
A integração recém-criada é aberta no editor de integração.
Na barra de navegação do editor de integração, clique em Acionadores para ver a lista de acionadores disponíveis.
Clique e coloque o elemento Acionador do Azure AD no editor de integração.

Para configurar o acionador do Azure AD, pode usar uma ligação do Azure AD existente disponível nos Integration Connectors ou criar uma nova ligação do Azure AD através da opção de criação de ligações inline.

Configure o acionador do Azure AD através de uma associação existente

Pode configurar o acionador do Azure AD através de uma ligação existente do Azure AD nos Integration Connectors. Tenha em atenção que o acionador do Azure AD é um acionador de eventos do conetor. Por conseguinte, só pode usar uma ligação do Azure AD com a subscrição de eventos ativada para configurar o acionador.

Para obter informações sobre como configurar um acionador do Azure AD através de uma nova ligação do Azure AD, consulte o artigo Configure o acionador do Azure AD através de uma nova ligação

Para configurar um acionador do Azure AD através de uma ligação existente ao Azure AD, siga estes passos:

Clique no elemento Acionador do Azure AD no editor de integração para abrir o painel de configuração do acionador.
Clique em Configurar acionador.
Forneça os seguintes detalhes de configuração na página Editor do acionador de eventos do conetor:
1. Região: selecione a região da sua ligação ao Azure AD.
2. Associação: selecione a associação do Azure AD que quer usar.
  A integração de aplicações só apresenta as ligações do Azure AD que estão ativas e têm uma subscrição de eventos ativada.
3. Tipo de subscrição de eventos: selecione o tipo de subscrição de eventos que aciona a integração. Para informações sobre os tipos de subscrições de eventos suportados para este acionador, consulte Tipos de subscrições de eventos suportados.
4. Conta de serviço: selecione uma conta de serviço com as funções do IAM necessárias para o acionador do Azure AD.
Clique em Concluído para concluir a configuração do acionador e fechar a página.

Configure o acionador do Azure AD com uma nova ligação

Para configurar o acionador do Azure AD através de uma nova ligação do Azure AD, siga estes passos:

Clique no elemento Acionador do Azure AD no editor de integração para abrir o painel de configuração do acionador.
Clique em Configurar acionador.
Ignore o campo Região.
Clique em Associação e selecione a opção Criar associação no menu pendente.
Conclua os seguintes passos no painel Criar associação:
1. No passo Localização, escolha a localização para a nova ligação do Azure AD:
  1. Região: selecione uma região na lista pendente.
  2. Clicar em Seguinte.
2. No passo Detalhes da ligação, indique os detalhes sobre a nova ligação do Azure AD:
  1. Versão do conector: escolha uma versão disponível do conector do Azure AD na lista pendente.
  2. Nome da associação: introduza um nome para a associação do Azure AD.
    Nota: os nomes das associações têm de cumprir os seguintes critérios:
    - Os nomes das associações podem usar letras, números ou hífenes.
    - As letras têm de ser minúsculas.
    - Os nomes das associações têm de começar com uma letra e terminar com uma letra ou um número.
    - Os nomes das associações não podem exceder 49 carateres.
  3. (Opcional) Descrição: introduza uma descrição para a associação.
  4. (Opcional) Ativar registo na nuvem: selecione esta caixa de verificação para armazenar todos os dados de registo da ligação.
  5. Conta de serviço: selecione uma conta de serviço com as funções do IAM necessárias para a ligação do Azure AD.
  6. Ativar subscrição de eventos: selecione esta opção para criar e ativar uma nova subscrição de eventos para a ligação do Azure AD. Pode ativar apenas subscrições de eventos ou também incluir entidades, operações e ações de ligação.
    Nota: os seguintes passos de configuração da associação adicionais são necessários se optar por ativar entidades, operações e ações para a associação:
    - Inquilino do Azure: o inquilino online da Microsoft que está a ser usado para aceder aos dados. Se não especificar um inquilino, é usado o seu inquilino predefinido.
    - Destinos
    - Autenticação
  7. (Opcional) Expanda Definições avançadas para configurar as definições do nó de ligação.
    Para mais informações sobre as definições do nó de ligação para o Azure AD, consulte a documentação sobre a ligação do Azure AD.
  8. (Opcional) Clique em + Adicionar etiqueta para adicionar uma etiqueta à associação sob a forma de um par de chave-valor.
  9. Clicar em Seguinte.
3. No passo Destinos, indique os detalhes da instância do Azure AD:
  1. Tipo de destino: selecione Endereço do anfitrião.
  2. Anfitrião: introduza o nome de anfitrião ou o endereço IP da sua instância do Azure AD.
  3. Clicar em Seguinte.
4. No passo Autenticação, indique os detalhes de autenticação da instância do Azure AD:
  1. Selecione o tipo de autenticação pretendido e introduza os detalhes relevantes.
    Para saber como configurar estes tipos de autenticação, consulte o artigo Configurar autenticação.
  2. Clicar em Seguinte.
5. No passo Detalhes da subscrição de eventos, indique os detalhes da instância do Azure AD onde as subscrições de eventos vão ser criadas.
  1. ID de cliente: o ID de cliente usado para pedir tokens de acesso.
  2. Segredo do cliente: o segredo do cliente usado para pedir tokens de acesso.
  3. Versão do Secret: selecione uma versão do Secret.
  4. Estado do cliente: o segredo do Secret Manager que contém o estado do cliente. Isto é usado para a autenticação de notificações de alterações.
  5. Inquilino do Azure: o inquilino online da Microsoft que está a ser usado para aceder aos dados. Se não especificar um inquilino, é usado o seu inquilino predefinido.
  6. Opcionalmente, selecione Ativar enriquecimento de dados se quiser que sejam anexadas informações adicionais à resposta do sistema de back-end.
    As informações adicionais são específicas da entidade para a qual configurou o evento. Para mais informações, consulte o artigo Enriquecimento de dados em notificações de eventos.
    
    Nota: se tiver configurado esta associação apenas para a subscrição de eventos, não pode ativar esta opção. Para ativar o enriquecimento de dados, tem de configurar a associação para a subscrição de eventos e as operações do conetor (entidades e ações).
6. Selecione Ativar conetividade privada para uma conetividade segura entre a sua aplicação de back-end e a sua ligação. Se selecionar esta opção, tem de realizar passos de configuração adicionais depois de criar a associação. Para mais informações, consulte o artigo Conetividade privada para subscrição de eventos.
7. Introduza a configuração de mensagens não entregues. Se configurar a fila de mensagens rejeitadas, a ligação escreve os eventos não processados no tópico Pub/Sub especificado. Introduza os seguintes detalhes:
  1. ID do projeto de mensagens não entregues: o ID do projeto do Google Cloud onde configurou o tópico Pub/Sub de mensagens não entregues.
  2. Tópico de mensagens não entregues: o tópico do Pub/Sub onde quer escrever os detalhes do evento não processado.
8. Se quiser usar um proxy para estabelecer ligação ao seu back-end (para a subscrição de eventos), introduza os seguintes detalhes:
9. Clicar em Seguinte.
Rever: reveja os detalhes da ligação do Azure AD fornecidos.
Clique em Criar para concluir a criação de uma nova ligação do Azure AD.
ID do tipo de evento: selecione o tipo de subscrição de eventos que aciona a integração. Para informações sobre os tipos de subscrições de eventos suportados para este acionador, consulte Tipos de subscrições de eventos suportados.
Clique em Concluído e feche a página.

Saída do acionador

O acionador do Azure AD demora alguns minutos a concluir a configuração da subscrição de eventos. Pode ver o estado da subscrição de eventos no painel de configuração do acionador em Detalhes da subscrição de eventos.

O acionador do Azure AD indica o estado de uma subscrição de eventos através dos seguintes estados:

Creating: indica que o acionador está a subscrever a subscrição de eventos.
Active: indica que o acionador subscreveu com êxito uma subscrição de eventos.
Error: indica que existe um problema com a subscrição de eventos configurada.

Além do estado da subscrição de eventos, a secção Detalhes da subscrição de eventos também apresenta outros detalhes, como a região da associação, o nome da associação, o nome da subscrição de eventos e muito mais.

Variável de saída do acionador

Para cada evento, o acionador do Azure AD gera uma variável de saída ConnectorEventPayload que pode usar nas tarefas posteriores. A variável de saída está no formato JSON e contém o esquema do payload do Azure AD de saída.

Exemplo 1: payload de saída para o evento do Azure AD: Utilizador 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 enriquecido com dados para o evento do Azure AD: Utilizador 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.

Veja as subscrições de eventos

Para ver e gerir todas as subscrições de eventos associadas a uma ligação nos Integration Connectors, faça o seguinte:

Aceda à página Integration Connectors > Ligações.
Aceda à página Ligações
Clique na associação para a qual quer ver as subscrições.
Clique no separador Subscrições de eventos.
Esta apresenta todas as subscrições de eventos da associação.

Edite o acionador do Azure AD

Pode editar um acionador do Azure AD para alterar ou atualizar a configuração da associação e os detalhes da subscrição de eventos.

Para editar um acionador do Azure AD, siga estes passos:

Clique no elemento Acionador do Azure AD no editor de integração para abrir o painel de configuração do acionador.
Clique em Configurar acionador do Azure AD.
Faça o seguinte na página Editor de acionadores de eventos do conetor:
1. Para manter a subscrição de eventos configurada anteriormente, clique em Manter. Caso contrário, clique em Eliminar.
  Aviso: a eliminação de uma subscrição de eventos afeta todas as integrações publicadas que usam a subscrição de eventos. Não é possível anular esta tarefa.
2. Atualize a configuração da associação e os detalhes da subscrição de eventos conforme pretendido.
3. Clique em Concluído.

Pode ver os detalhes atualizados da associação e da subscrição de eventos no painel de configuração do acionador em Detalhes da subscrição de eventos.

Tipos de subscrições de eventos suportados

Pode usar o acionador do Azure AD para invocar uma integração para os seguintes tipos de subscrição de eventos:

Tipos de subscrições de eventos	Descrição
`Userprofiles`	Um utilizador é adicionado, eliminado, atualizado ou eliminado permanentemente.
`Users.updated`	Um utilizador é criado, atualizado ou eliminado temporariamente. A criação e a eliminação de utilizadores acionam um tipo de evento `updated`.
`Users.deleted`	Um utilizador é eliminado permanentemente.

Quotas e limites

Para informações sobre quotas e limites, consulte o artigo Quotas e limites.

O que se segue?

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

Saiba mais acerca do processamento de erros.
Saiba mais sobre os registos de execução da integração.