Atividade de Consulta do Microsoft Entra ID

Introdução

Uma atividade de Consulta do Microsoft Entra ID, utilizando sua conexão do Microsoft Entra ID, consulta dados de objetos no Microsoft Entra ID e é destinada a ser usada como uma fonte para fornecer dados em uma operação.

Criar uma atividade de Consulta do 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 tela de design ou copie o tipo de atividade e cole-o na tela de design. Para detalhes, veja Criar uma instância de atividade ou ferramenta em Reutilização de componentes.

Uma atividade de Consulta do Microsoft Entra ID existente pode ser editada a partir destes locais:

• A tela de design (veja Menu de ações do componente em Tela de design).
• A aba Componentes do painel do projeto (veja Menu de ações do componente em Aba Componentes do painel do projeto).

Configurar uma atividade de Consulta do 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.

• Passo 2: Selecione objetos filhos
  Selecione objetos filhos para consultar.

• Passo 3: Defina uma string de filtro
  Defina condições para uma consulta nos objetos filhos selecionados.

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

Passo 1: Insira um nome e selecione um objeto

Neste passo, forneça um nome para a atividade e selecione um objeto. Cada elemento da interface do usuário deste passo é 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 normais / ou dois pontos :.

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

  • Objeto Selecionado: Após um objeto ser selecionado, ele é listado aqui.

  • Pesquisar: Insira o valor de qualquer 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 são filtrados em tempo real a cada tecla pressionada. Para recarregar objetos do endpoint ao pesquisar, insira critérios de pesquisa e, em seguida, atualize, conforme descrito abaixo.

  • Atualizar: Clique no ícone de atualização ou na palavra Atualizar para recarregar objetos do endpoint do Microsoft Entra ID. Isso pode ser útil se objetos foram adicionados ao Microsoft Entra ID. Esta ação atualiza todos os metadados usados para construir a tabela de objetos exibidos 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 do Microsoft Entra ID pode não ter sido bem-sucedida. Certifique-se de que você está conectado reabrindo a conexão e testando novamente as credenciais.

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

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

  Para editar ou excluir uma única linha, passe o mouse sobre a coluna mais à direita e use o ícone para editar ou o ícone {{ no such element: dict object['trash'] }} para excluir.

  Para excluir todas as linhas, clique em Limpar Tudo.

  Importante

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

  Os campos na tabela Propriedades HTTP Avançadas não suportam o uso de variáveis para passar JSON bruto. Se seu caso de uso não suportar a definição de JSON bruto nos campos diretamente, escape o conteúdo JSON antes de passá-lo com uma variável. Por exemplo, escapando {"success": "true"}; torna-se {\"success\": \"true\"};.

• Salvar & 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 qualquer etapa. Uma mensagem pede para você confirmar que deseja descartar as alterações.

Etapa 2: Selecionar objetos filhos

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

• Classes de Objetos: Esta seção exibe as classes de objetos filhos disponíveis e selecionadas para interagir com o endpoint do Microsoft Entra ID.

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

    • Pesquisar: Insira o valor de qualquer 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 são filtrados em tempo real a cada tecla pressionada. Para recarregar objetos do endpoint ao pesquisar, insira os critérios de pesquisa e, em seguida, atualize, conforme descrito abaixo.

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

    • Adicionar 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 de adicionar para adicionar as classes selecionadas à coluna Objetos Filhos Selecionados.

  • Objetos Filhos Selecionados: Após uma classe de objeto filho ser adicionada, ela é listada aqui.

    • Remover um Objeto Filho: Na coluna Objeto Filho Selecionado, clique em qualquer lugar em uma linha para selecionar uma ou mais classes de objetos filhos. Em seguida, clique no ícone de remover para retornar as classes selecionadas à 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 qualquer etapa. Uma mensagem pede para você confirmar que deseja descartar as alterações.

Etapa 3: Definir uma string de filtro

Nesta etapa, uma String de Filtro de uma consulta é definida usando os campos de objeto disponíveis e as configurações da consulta. Cada elemento da interface desta etapa é descrito abaixo.

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

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

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

Básico

Se a aba Básico estiver selecionada, esta interface é apresentada:

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

  • Pesquisar: Digite 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 tecla pressionada.

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

• Selecionar Todos 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 vez.

• Selecionar Campos: Selecione as caixas de seleção dos campos que você deseja incluir na consulta para que 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 dos 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.

  Nota

  Se um valor for inserido para este campo, o campo Top deve ser deixado vazio. Caso contrário, um erro ocorrerá.

• Incluir Contagem: Selecione para incluir o número de resultados de uma consulta 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 lida com a forma como a pesquisa é interpretada para uma classe de objeto.

• Pular: Insira um número de resultados a serem pulados na resposta da consulta.

  Importante

  A API do Microsoft Graph não suporta o parâmetro skip com objetos de Diretório, incluindo Usuários e Grupos.

• Top: Insira um número máximo de resultados a serem recebidos na resposta da consulta. Quando nenhum valor é inserido para este campo, a consulta receberá 100 resultados por padrão. O valor máximo permitido é 999. Para receber mais de 999 resultados, use o campo Tamanho da Página em vez disso.

  Nota

  Se um valor for inserido para este campo, o campo Tamanho da Página deve ser deixado vazio. Caso contrário, um erro ocorrerá.

• 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 a condicional.

• Campo: Use o menu suspenso para selecionar o campo da classe de objeto a ser utilizado para a condição.

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

  | Comparação             |
  | ---------------------- |
  | Igual                  |
  | Maior que             |
  | Maior ou Igual        |
  | Menor que             |
  | Menor ou Igual        |
  

• Valor: Insira o valor desejado para comparar com as seleções do menu suspenso anterior.

• Remover: Clique no ícone de excluir para remover a condição da tabela.

• Adicionar: Clique para adicionar uma nova condição à tabela e String de Filtro.

• Remover Todos: Clique para remover todas as condições da tabela e String de Filtro.

• String de Filtro: À medida que você preenche os outros campos na aba Básico, a declaração da string de filtro nesta caixa de texto é automaticamente preenchida com os campos, condições e opções de consulta selecionados.

  Importante

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

• Testar Consulta: Clique para validar a consulta. Este botão deve ser clicado para habilitar o botão Próximo.

• 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 qualquer etapa. Uma mensagem pede que você confirme que deseja descartar as alterações.

Avançado

Se a aba Avançado estiver selecionada, esta interface é apresentada:

• Tamanho da Página: Insira um tamanho de página para habilitar a paginação dos resultados. O número de resultados em uma página totalizará o tamanho especificado. Um link para a próxima página de resultados também será incluído na resposta. Se um valor for inserido para este campo, um filtro top não pode ser fornecido. Caso contrário, ocorre um erro.

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

  Important

  Ao editar a declaração da string de filtro, observe o seguinte:

  • Uma consulta não pode conter um valor para o parâmetro top e o campo Tamanho da Página. Quando uma consulta contém ambos os parâmetros, ocorre um erro.
  • Por padrão, a consulta receberá 100 resultados. Ao usar o parâmetro top, o valor máximo permitido é 999. Para receber mais de 999 resultados, use o campo Tamanho da Página em vez disso.
  • Quando _odata.nextLink é fornecido na transformação da solicitação, todos os parâmetros presentes na declaração da string de filtro são ignorados.

• Testar Consulta: Clique para validar a consulta. Se a consulta for válida, uma amostra de até 10 registros recuperados da consulta é exibida em uma tabela. Se a consulta não for válida, mensagens de erro relevantes são exibidas. Se você editar a string de filtro enquanto estiver no modo Avançado, a consulta deve ser válida e validada através deste botão para habilitar o botão Próximo.

• 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 qualquer etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.

Etapa 4: Revisar os esquemas de dados

Quaisquer esquemas de solicitação ou resposta gerados a partir do endpoint são exibidos. Cada elemento da 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ções.

  Nota

  Os dados fornecidos em uma transformação têm precedência sobre a configuração da atividade.

  O conector Microsoft Entra ID utiliza 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

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

• Editar: Clique no ícone de edição acima do esquema de dados de resposta para entrar no modo de edição desse esquema de dados. O editor permite que você adicione, exclua e reorganize nós e campos e altere seus tipos de dados. Todas as ocorrências de nós e campos são definidas como [0, 1] cardinalidade. As alterações feitas nos esquemas de dados devem ser aceitáveis para o endpoint e devem ser feitas apenas após consultar qualquer documentação disponível para o endpoint. Após fazer edições no esquema, uma data de última edição é exibida na parte superior do esquema aplicável para indicar que o esquema teve edições manuais. Atualizar os esquemas redefinirá os esquemas para suas estruturas padrão.

  Nota

  Quaisquer alterações são feitas diretamente na atividade sem confirmação. Se precisar reverter ou redefinir alguma alteração, refaça-as enquanto estiver no modo de edição ou recrie a atividade usando uma nova instância da atividade.

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

• Voltar: Clique para armazenar temporariamente a configuração para esta 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 qualquer etapa. Uma mensagem pede para confirmar que você deseja descartar as alterações.

Próximas etapas

Após configurar uma atividade de Consulta do Microsoft Entra ID, complete a configuração da operação adicionando e configurando outras atividades ou ferramentas como etapas da operação. Você também pode configurar as configurações da operação, que incluem a capacidade de encadear operações que estão no mesmo ou em diferentes fluxos de trabalho.

As ações do menu para uma atividade são acessíveis a partir do painel do projeto e da tela de design. Para detalhes, veja o menu de ações da atividade em Conceitos básicos do conector.

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

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

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

Quando estiver pronto, implante e execute a operação e valide o comportamento verificando os logs da operação.