Usar o aplicativo Entra existente no TeamsFx

Esta seção explica como conectar o Microsoft Entra ID ao seu projeto TeamsFx, usando um registro de aplicativo do Entra existente ou criando um novo. Siga as etapas para definir as configurações de autenticação necessárias e os valores do TeamsFx antes de executar ou implantar seu agente ou aplicativo.

Criar um aplicativo do Microsoft Entra

Observação

Você pode ignorar esta parte se já tiver um aplicativo Microsoft Entra. Essa etapa pode ser automatizada pela aadApp/create ação.

  1. Acesse o portal do Azure e selecione o Microsoft Entra ID.

  2. Selecione Registros de> AplicativoNovo registro para criar um novo aplicativo Microsoft Entra. Adicione os seguintes detalhes:

    1. Name: o nome do aplicativo de configuração.
    2. Tipos de conta com suporte: Selecione Conta somente neste diretório organizacional.
    3. Deixe o campo URL de redirecionamento em branco por enquanto.
    4. Selecione Registrar.
  3. Depois que o aplicativo for registrado, você será levado para a página de Visão geral . Copie a ID do aplicativo (cliente), a ID do objeto e a ID do diretório (locatário) para uso posterior. Verifique se os tipos de conta com suporte estão definidos apenas para Minha organização.

Criar segredo do cliente para o aplicativo Microsoft Entra (opcional)

Observação

Você poderá ignorar essa parte se o seu agente ou aplicativo não exigir segredo do cliente. Essa etapa pode ser automatizada pela aadApp/create ação.

  1. Acesse a página Certificados & segredos do aplicativo, selecione Segredo do Cliente e selecione Novo segredo do cliente. Selecione os seguintes detalhes:

    1. Description: A descrição do segredo do cliente.
    2. Expira: a hora de expiração do segredo do cliente.
    3. Selecione Adicionar.
  2. Quando o segredo do cliente for adicionado, pressione o botão copiar na coluna Valor para copiar o segredo do cliente.

Criar acesso como escopo de usuário para o aplicativo Microsoft Entra (opcional)

Observação

Você pode ignorar esta parte se sua conta do Microsoft 365 tiver permissão para atualizar o aplicativo Microsoft Entra. O Agents Toolkit cria o escopo do aplicativo. Essa etapa pode ser automatizada pela aadApp/update ação.

  1. Vá para a página Expor uma API do aplicativo, selecione Adicionar um escopo em Escopos definidos por esta API e siga as etapas fornecidas:

    1. Selecione Salvar e continuar.
    2. Nome do escopo: Preencha access_as_user.
    3. Quem pode consentir?: escolha Administradores e usuários.
    4. Administração nome de exibição de consentimento: Preencher O Teams pode acessar as APIs Web do aplicativo.
    5. Administração descrição do consentimento: Preencher Permite que o Teams chame as APIs Web do aplicativo como o usuário atual.
    6. Nome de exibição do consentimento do usuário: preencher O Teams pode acessar as APIs Web do aplicativo e fazer solicitações em seu nome.
    7. Descrição de consentimento do usuário: preencher Permita que o Teams chame as APIs Web deste aplicativo com os mesmos direitos que você.
    8. Estado: escolha Habilitado.
    9. Selecione Adicionar escopo.
  2. Na mesma página, selecione Adicionar um aplicativo cliente em Aplicativos cliente autorizados e adicione os seguintes detalhes:

    1. ID do cliente: Preencha 1fec8e78-bce4-4aaf-ab1b-5451cc387264 que é a ID do cliente para o Microsoft Teams no celular e no cliente.
    2. Escopos autorizados: escolha o escopo de access_as_user existente.
    3. Selecione Adicionar aplicativo.
  3. Selecione Adicionar um aplicativo cliente e adicione os detalhes:

    1. ID do cliente: preencha 5e3ce6c0-2b1f-4285-8d4b-75ee78787346 que é a ID do cliente para o Teams na Web.
    2. Escopos autorizados: escolha o escopo de access_as_user existente.
    3. Selecione Adicionar aplicativo.
  4. Vá para a página Manifesto do aplicativo, copie a ID em oauth2Permissions como ID do Escopo de Acesso Como Usuário.

Obtenha informações existentes do aplicativo Microsoft Entra

Se você tiver um aplicativo do Azure já registrado, poderá reutilizá-lo em seu projeto TeamsFx em vez de criar um novo registro. Antes de começar, capture os valores de configuração necessários do registro do aplicativo existente para que você possa adicioná-los ao seu projeto TeamsFx.

Observação

Você pode ignorar esta parte se tiver seguido as instruções acima para criar um aplicativo do Microsoft Entra.

  1. Acesse o portal do Azure e selecione o Microsoft Entra ID.

  2. Selecione Registros de Aplicativo e localize seu aplicativo Microsoft Entra existente.

  3. Vá para a página Visão geral do aplicativo, copie a ID do aplicativo (cliente), a ID do objeto e a ID do diretório (locatário); é necessário mais tarde.

  4. Verifique se os tipos de conta com suporte estão definidos apenas para Minha organização.

  5. Vá para a página Visão geral do aplicativo, copie a ID do aplicativo (cliente), a ID do objeto e a ID do diretório (locatário) para uso posterior. Verifique se os tipos de conta com suporte estão definidos apenas para Minha organização.

  6. Vá para a página Certificados & segredos do aplicativo e pressione o botão copiar na coluna Valor para copiar o Segredo do Cliente.

    Observação

    Se você não puder copiar o segredo, siga as instruções para criar um novo segredo do cliente.

  7. Vá para a página Expor uma API do aplicativo. Se o escopo access_as_user já estiver definido e as duas IDs de cliente do Teams estiverem pré-autorizadas, abra o Manifesto e copie o valor da ID em oauth2Permissions e insira-o como a ID do Escopo de Acesso como Usuário.

Definir informações do aplicativo Entraa no projeto TeamsFx

Adicione as informações salvas do aplicativo Microsoft Entra ao seu projeto TeamsFX.

Observação

Se você não usar aadApp/create a ação para criar o aplicativo Microsoft Entra, poderá adicionar variáveis de ambiente necessárias com seu nome preferencial sem seguir essas etapas.

  1. Abra m365agents.yml e encontre a aadApp/create ação.

  2. Encontre os nomes de variáveis de ambiente que armazenam informações do writeToEnvironmentFile aplicativo Microsoft Entra na propriedade. A seguir estão as definições padrão writeToenvironmentFile se você criar projetos usando o Microsoft 365 Agents Toolkit (anteriormente conhecido como Teams Toolkit):

     writeToEnvironmentFile:
       clientId: AAD_APP_CLIENT_ID
       clientSecret: SECRET_AAD_APP_CLIENT_SECRET
       objectId: AAD_APP_OBJECT_ID
       tenantId: AAD_APP_TENANT_ID
       authority: AAD_APP_OAUTH_AUTHORITY
       authorityHost: AAD_APP_OAUTH_AUTHORITY_HOST
    
  3. Adicione valores para cada variável de ambiente da etapa 2.

    1. Adicione as variáveis de ambiente a seguir e seus valores ao env\.env.{env} arquivo.

      AAD_APP_CLIENT_ID=<value of Microsoft Entra application's client id (application id)> # example: 00000000-0000-0000-0000-000000000000
      AAD_APP_OBJECT_ID=<value of Microsoft Entra application's object id> # example: 00000000-0000-0000-0000-000000000000
      AAD_APP_TENANT_ID=<value of Microsoft Entra's (tenant) id> # example: 00000000-0000-0000-0000-000000000000
      AAD_APP_OAUTH_AUTHORITY=<value of Microsoft Entra's authority> # example: https://login.microsoftonline.com/<Directory (tenant) ID>
      AAD_APP_OAUTH_AUTHORITY_HOST=<host of Microsoft Entra's authority> # example: https://login.microsoftonline.com
      AAD_APP_ACCESS_AS_USER_PERMISSION_ID=<id of access_as_user permission> # example: 00000000-0000-0000-0000-000000000000
      

      AAD_APP_OAUTH_AUTHORITY_HOSTé o host de autoridade do Microsoft Entra (por exemplo, https://login.microsoftonline.com) que seu agente ou bot usa como o ponto de extremidade de entrada do OAuth 2.0. Para pontos de extremidade específicos do ambiente, consulte Pontos de extremidade de autenticação do Microsoft Entra.

    2. Se o agente ou aplicativo exigir um segredo de cliente do aplicativo do Microsoft Entra, adicione a seguinte variável de ambiente e seu valor ao env\.env.{env}.user arquivo.

      SECRET_AAD_APP_CLIENT_SECRET=<value of Microsoft Entra application's client secret>
      

      Observação

      Lembre-se de atualizar os nomes das variáveis de ambiente fornecidas nos exemplos se você usar nomes diferentes no writeToEnvironmentFile.

  4. Abra a extensão Kit de Ferramentas de Agentes e selecione Provisionar na nuvem. Aguarde até que seu projeto seja provisionado com êxito.

Carregar o manifesto do aplicativo Microsoft Entra no portal do Azure

Se o Agents Toolkit não atualizar o aplicativo Microsoft Entra, uma mensagem de erro será exibida:

Insufficient privileges to complete the operation.

Se você vir essa mensagem, atualize a permissão do aplicativo Microsoft Entra e siga as instruções para atualizar a permissão.

  1. Localize o manifesto do aplicativo Microsoft Entra em build/aad.manifest.{env}.json.

  2. Copie o conteúdo do arquivo de manifesto.

  3. Acesse o portal do Azure e selecione o Microsoft Entra ID.

  4. Selecione Registros de Aplicativo e encontre seu aplicativo Microsoft Entra existente.

  5. Vá para a página Manifesto do aplicativo, cole o conteúdo do manifesto no editor e selecione Salvar para salvar as alterações.

Confira também