Atividade de consulta de Microsoft Entra ID

Introdução

Uma atividade de Consulta do Microsoft Entra ID, usando sua conexão do Microsoft Entra ID, consulta dados de objetos no Microsoft Entra ID e se destina a ser usado como uma fonte para fornecer dados em uma operação.

Criar uma atividade de consulta de Microsoft Entra ID

Uma instância de uma atividade de Consulta do Microsoft Entra ID é criada a partir de uma conexão do Microsoft Entra ID usando seu tipo de atividade Consulta.

Para criar uma instância de uma atividade, arraste o tipo de atividade para a quadro de design ou copie o tipo de atividade e cole-o na quadro de design. Para obter detalhes, consulte Criando uma instância de atividade em Reutilização de componentes.

Uma atividade existente de Consulta de Microsoft Entra ID pode ser editada nestes locais:

• A quadro de design (veja menu de ações do componente em Tela de design).
• A aba Componentes do painel do projeto (consulte menu de ações do componente na aba Componentes do painel Projeto).

Configurar uma atividade de consulta de Microsoft Entra ID

Siga estas etapas para configurar uma atividade de Consulta do Microsoft Entra ID:

• Etapa 1: Insira um nome e selecione um objeto
  Forneça um nome para a atividade e selecione um objeto.

• Etapa 2: Selecione objetos filhos
  Selecione objetos filho para consultar.

• Etapa 3: Definir uma sequência de filtros
  Defina condições para uma consultar nos objetos filho selecionados.

• Etapa 4: Revise os esquemas de dados
  Todos os esquemas de solicitação ou resposta gerados a partir do endpoint são exibidos.

Etapa 1: insira um nome e selecione um objeto

Nesta etapa, forneça um nome para a atividade e selecione um objeto. Cada elemento da interface do usuário desta etapa é descrito abaixo.

• Nome: Insira um nome para identificar a atividade. O nome deve ser exclusivo para cada atividade de Consulta do Microsoft Entra ID e não deve conter barras / ou dois pontos :.

• Selecionar objeto: Esta seção exibe objetos disponíveis no endpoint do Microsoft Entra ID.

  • Objeto selecionado: Depois que um objeto é selecionado, ele é listado aqui.

  • Pesquisar: Insira qualquer valor de coluna na caixa de pesquisa para filtrar a lista de objetos. A pesquisa não diferencia maiúsculas de minúsculas. Se os objetos já estiverem exibidos na tabela, os resultados da tabela serão filtrados em tempo real a cada pressionamento de tecla. Para recarregar objetos do endpoint ao pesquisar, insira os critérios de pesquisa e atualize, conforme descrito abaixo.

  • Atualizar: Clique no ícone de atualização ou a palavra Refresh para recarregar objetos do endpoint do Microsoft Entra ID. Isso pode ser útil se objetos tiverem sido adicionados ao Microsoft Entra ID. Esta ação atualiza todos os metadados usados para construir a tabela de objetos exibida na configuração.

  • Selecionando um objeto: Dentro da tabela, clique em qualquer lugar em uma linha para selecionar um objeto. Apenas um objeto pode ser selecionado. As informações disponíveis para cada objeto são obtidas do endpoint do Microsoft Entra ID:

    • Nome: O nome do objeto do Microsoft Entra ID.

    • Descrição: A descrição do objeto do Microsoft Entra ID.

  Dica

  Se a tabela não for preenchida com objetos disponíveis, a conexão Microsoft Entra ID pode não ser bem-sucedido. Certifique-se de que você está conectado reabrindo a conexão e testando novamente as credenciais.

• Propriedades HTTP avançadas: Clique no ícone adicionar para adicionar uma linha à tabela abaixo e inserir um par chave-valor para cada parâmetro de solicitação.

  Para salvar a linha, clique no ícone de envio na coluna mais à direita.

  Para editar ou excluir uma única linha, passe o mouse sobre a coluna mais à direita e use o ícone de edição ou excluir ícone .

  Para excluir todas as linhas, clique em Limpar tudo.

  Importante

  Os campos na tabela Propriedades HTTP avançadas exibem o ícone de variável somente no modo de edição. Para que os valores variáveis desses campos sejam preenchidos em tempo de execução, a versão do agente deve ser pelo menos 10.75 / 11.13.

• Salvar e sair: Se habilitado, clique para salvar a configuração para esta etapa e fechar a configuração da atividade.

• Próximo: Clique para armazenar temporariamente a configuração para esta etapa e continuar para a próxima etapa. A configuração não será salva até que você clique no botão Concluído na última etapa.

• Descartar alterações: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem pede para você confirmar que deseja descartar as alterações.

Etapa 2: Selecione objetos filho

Nesta etapa, selecione o objeto filho para consultar. Cada elemento da interface do usuário desta etapa é descrito abaixo.

• Classes de objeto: Esta seção exibe as classes de objeto filho disponíveis e selecionadas para interagir no endpoint do Microsoft Entra ID.

  • Objetos filho disponíveis: Esta seção exibe uma lista de classes de objetos filho disponíveis no Microsoft Entra ID.

    • Pesquisar: Insira qualquer valor de coluna na caixa de pesquisa para filtrar a lista de objetos. A pesquisa não diferencia maiúsculas de minúsculas. Se os objetos já estiverem exibidos na tabela, os resultados da tabela serão filtrados em tempo real a cada pressionamento de tecla. Para recarregar objetos do endpoint ao pesquisar, insira os critérios de pesquisa e atualize, conforme descrito abaixo.

    • Atualizar: Clique no ícone de atualização ou a palavra Refresh para recarregar objetos do endpoint do Microsoft Entra ID. Isso pode ser útil se objetos tiverem sido adicionados ao Microsoft Entra ID. Esta ação atualiza todos os metadados usados para construir a tabela de objetos exibida na configuração.

    • Adicionando um Objeto Filho: Na coluna Objetos Filhos Disponíveis, clique em qualquer lugar em uma linha para selecionar uma ou mais classes de objetos filhos. Em seguida, clique no ícone adicionar para adicionar classes selecionadas à coluna Objetos Filhos Selecionados:

      

  • Objetos Filhos Selecionados: Depois que uma classe de objeto filho é adicionada, ela é listada aqui.

    • Removendo um Objeto Filho: Na coluna Objeto Filho Selecionado, clique em qualquer lugar em uma linha para selecionar uma ou mais classes de objeto filho. Em seguida, clique no ícone remover para retornar as classes selecionadas para a coluna Objetos Filhos Disponíveis:

      

• Voltar: Clique para armazenar temporariamente a configuração para esta etapa e retornar à etapa anterior.

• Próximo: Clique para armazenar temporariamente a configuração para esta etapa e continuar para a próxima etapa. A configuração não será salva até que você clique no botão Concluído na última etapa.

• Descartar alterações: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem pede para você confirmar que deseja descartar as alterações.

Etapa 3: Defina uma sequência de filtros

Nesta etapa, a Filter String de uma consulta é definida para uma consultar usando campos de objeto disponíveis e configurações de consultar. Cada elemento de interface de usuário desta etapa é descrito abaixo.

A interface usada nesta etapa da configuração de uma atividade de Consulta do Microsoft Entra ID depende da aba selecionada:

• Básico: Esta opção permite que você crie a Filter String com campos guiados.

• Avançado: Esta opção oculta os campos guiados e permite que você modifique a Filter String diretamente.

Básico

Se a aba Básico for selecionada, esta interface será apresentada:

• Campos de objeto: Selecione os campos a serem usados na consultar com base na classe de objeto selecionada.

  • Pesquisar: Insira qualquer parte do nome de um campo na caixa de pesquisa para filtrar a lista de campos para o objeto selecionado. A pesquisa não diferencia maiúsculas de minúsculas. Os resultados listados são filtrados em tempo real a cada pressionamento de tecla.

  • Atualizar: Clique no ícone de atualização ou a palavra Atualizar para recarregar campos do objeto do endpoint do Microsoft Entra ID.

  • Selecionar tudo na classe de objeto: Ao usar a caixa de pesquisa para filtrar, você pode usar esta caixa de seleção para selecionar todos os campos visíveis de uma só vez.

  • Selecionar campos: Selecione as caixas de seleção dos campos que você deseja incluir na consultar para que eles sejam adicionados automaticamente à String de filtro. Você também pode selecionar todos os campos de uma vez usando a caixa de seleção pai.

• Tamanho da página: Insira um tamanho de página para habilitar a paginação de resultados. O número de resultados em uma página totalizará até o tamanho especificado. Um link para a próxima página de resultados também será incluído na resposta.

• Incluir contagem: Selecione para incluir o número de resultados de uma consultar como parte da resposta.

• Pesquisa de texto completo: Insira termos de pesquisa para consultar objetos na classe de objeto selecionada. O endpoint do Microsoft Entra ID manipula como a pesquisa é interpretada para uma classe de objeto.

• Ignorar: Insira um número de resultados para ignorar na resposta da consultar.

  Importante

  A API do Microsoft Graph não oferece suporte a skip parâmetro com objetos de diretório, incluindo usuários e grupos.

• Topo: Insira um número máximo de resultados a receber na resposta da consultar. A top parâmetro fornecido na transformação da solicitação substitui qualquer top parâmetro definido nesta etapa.

• Cláusulas condicionais: Para adicionar condicionais, use estes campos como entrada para ajudar a construir as cláusulas, que então aparecem na String de filtro.

  • Objeto: Use o menu suspenso para selecionar a classe de objeto a ser usada para o condicional.

  • Campo: Use o menu suspenso para selecionar o campo da classe de objeto a ser usada para o condicional.

  • Operador: Use o menu suspenso para selecionar um operador apropriado:

    Comparação
    É igual a
    Maior que
    Maior que ou igual a
    Menor que
    Menor ou igual a

  • Valor: Insira o valor desejado para comparar com as seleções suspensas anteriores.

  • Remover: Clique no ícone de exclusão para remover o condicional da tabela.

  • Adicionar: Clique para adicionar uma nova condicional à tabela e Filtrar String.

  • Remover tudo: Clique para remover todos os condicionais da tabela e Filtrar sequência de caracteres.

• Sequência de caracteres de filtro: Conforme você preenche os outros campos na aba Básico, a instrução da sequência de caracteres de filtro nesta caixa de texto é preenchida automaticamente com os campos, condições e opções de consultar selecionados.

  Importante

  A top parâmetro fornecido na transformação da solicitação substitui qualquer top parâmetro definido nesta etapa.

  Se _odata.nextLink é fornecido na transformação de solicitação, todos os parâmetros presentes na instrução de string de filtro são ignorados. Se presente, um top o parâmetro fornecido na transformação da solicitação também é ignorado.

• Test Query: Clique para validar a consultar. Este botão deve ser clicado para habilitar o botão Next.

• Voltar: Clique para armazenar temporariamente a configuração desta etapa e retornar à etapa anterior.

• Próximo: Clique para armazenar temporariamente a configuração para esta etapa e continuar para a próxima etapa. A configuração não será salva até que você clique no botão Concluído na última etapa.

• Descartar alterações: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem pede para você confirmar que deseja descartar as alterações.

Avançado

Se a aba Avançado for selecionada, esta interface será apresentada:

• Tamanho da página: Insira um tamanho de página para habilitar a paginação de resultados. O número de resultados em uma página totalizará até o tamanho especificado. Um link para a próxima página de resultados também será incluído na resposta.

• String de filtro: Edite a declaração de string de filtro diretamente.

  Importante

  A top parâmetro fornecido na transformação da solicitação substitui qualquer top parâmetro definido nesta etapa.

  Se _odata.nextLink é fornecido na transformação de solicitação, todos os parâmetros presentes na instrução de string de filtro são ignorados. Se presente, um top o parâmetro fornecido na transformação da solicitação também é ignorado.

• Test Query: Clique para validar a consultar. Se a consultar for válida, uma amostra de até 10 registros recuperados da consultar será exibida em uma tabela. Se a consultar não for válida, mensagens de erro relevantes serão exibidas. Se você editar a sequência de caracteres do filtro no modo Avançado, a consultar deverá ser válida e validada por meio deste botão para habilitar o botão Avançar.

• Voltar: Clique para armazenar temporariamente a configuração desta etapa e retornar à etapa anterior.

• Próximo: Clique para armazenar temporariamente a configuração para esta etapa e continuar para a próxima etapa. A configuração não será salva até que você clique no botão Concluído na última etapa.

• Descartar alterações: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem pede para você confirmar que deseja descartar as alterações.

Etapa 4: Revise os esquemas de dados

Quaisquer esquemas de solicitação ou resposta gerados do endpoint são exibidos. Cada elemento de interface do usuário desta etapa é descrito abaixo.

• Esquemas de dados: Esses esquemas de dados são herdados por transformações adjacentes e são exibidos novamente durante o mapeamento de transformação.

  O conector Microsoft Entra ID usa a Microsoft Graph API v1.0. Consulte a documentação da API para obter informações sobre os nós e campos do esquema.

  Importante

  A top parâmetro fornecido na transformação da solicitação substitui qualquer top parâmetro definido na etapa 3.

  Se _odata.nextLink é fornecido na transformação de solicitação, todos os parâmetros presentes na instrução de sequência de caracteres do filtro na etapa 3 são ignorados. Se presente, um top o parâmetro fornecido na transformação da solicitação também é ignorado.

• Atualizar: Clique no ícone de atualização ou a palavra Refresh para regenerar esquemas do endpoint do Microsoft Entra ID. Esta ação também regenera um esquema em outros locais em todo o projeto onde o mesmo esquema é referenciado, como em uma transformação adjacente.

• Voltar: Clique para armazenar temporariamente a configuração desta etapa e retornar à etapa anterior.

• Concluído: Clique para salvar a configuração de todas as etapas e fechar a configuração da atividade.

• Descartar alterações: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem pede para você confirmar que deseja descartar as alterações.

Próximos passos

Após configurar uma atividade Query do Microsoft Entra ID, conclua a configuração da operação adicionando e configurando outras atividades, transformações ou scripts como etapas da operação. Você também pode configurar as definições da operação, que incluem a capacidade de encadear operações que estejam no mesmo fluxo de trabalho ou em workflows diferentes.

As ações de menu para uma atividade são acessíveis a partir do painel do projeto e da quadro de design. Para obter detalhes, consulte menu de ações de atividade em Noções básicas do conector.

As atividades de Consulta do Microsoft Entra ID podem ser usadas como uma fonte com esses padrões de operação:

• Padrão de Transformação
• Padrão de arquivo de dois alvos (apenas como primeira fonte)
• Padrão de arquivo HTTP de dois alvos (apenas como primeira fonte)
• Padrão de duas transformações (apenas como primeira fonte)

Para usar a atividade com funções de script, grave os dados em um local temporário e use esse local temporário na função de script.

Quando estiver pronto, implantar e executar a operação e validar o comportamento verificando os logs de operação.