Personalizar manifesto do aplicativo

O manifesto do aplicativo (anteriormente chamado de manifesto do aplicativo do Teams) descreve como seu aplicativo se integra ao Microsoft Teams. Após o scaffolding, o arquivo de manifesto do aplicativo padrão está disponível em appPackage/manifest.json. O arquivo de manifesto do aplicativo contém algumas variáveis de ambiente com formato de ${{XX_XX}}, e os valores reais são resolvidos usando o Microsoft 365 Agents Toolkit (anteriormente conhecido como Teams Toolkit) com arquivos env como env/.env.dev e env/.env.local.

Para visualizar o manifesto do aplicativo com conteúdo real, o Agents Toolkit gera os arquivos de manifesto do aplicativo de visualização na appPackage/build pasta, conforme mostrado na seguinte estrutura de pastas:

└───appPackage
    └───build
        ├───appPackage.{env}.zip - Zipped app package of remote Teams app
        ├───appPackage.local.zip - Zipped app package of local Teams app
        ├───manifest.{env}.json  - Previewed manifest of remote Teams app
        └───manifest.local.json  - Previewed manifest of local Teams app

Você pode visualizar o arquivo de manifesto do aplicativo em ambientes locais e remotos.

Visualizar o arquivo de manifesto do aplicativo no ambiente local

Para visualizar o arquivo de manifesto do aplicativo no ambiente local, selecione a tecla F5 para executar a depuração local. Depois de gerar as variáveis de ambiente no env/.env.local, o pacote do aplicativo e o manifesto do aplicativo de visualização são criados na appPackage/build pasta.

Você também pode disparar o Pacote de Aplicativos do Teams do modo de exibição de árvore ou do Teams: Compacte o Pacote de Aplicativos do Teams na paleta de comandos para gerar o manifesto do aplicativo de visualização e o pacote do aplicativo.

Visualizar o arquivo de manifesto do aplicativo em ambiente remoto

Para visualizar o arquivo de manifesto do aplicativo no ambiente remoto, você pode disparar Provisionar do modo de exibição de árvore ou do Teams: Provisionar da paleta de comandos. Ele gera variáveis de ambiente para o aplicativo Teams remoto, o pacote do aplicativo de compilação e o manifesto do aplicativo de visualização na appPackage/build pasta.

Você também pode disparar o Pacote de Aplicativos do Teams do modo de exibição de árvore ou do Teams: Compacte o Pacote de Aplicativos do Teams na paleta de comandos para gerar o manifesto do aplicativo de visualização e o pacote do aplicativo.

Personalizar o manifesto do aplicativo no Visual Studio Code

Durante a depuração ou provisionamento local, o Agents Toolkit carrega o manifesto do aplicativo e resolve o manifesto do aplicativo por variáveis de appPackage/manifest.json ambiente definidas no e, em env/.env.xxseguida, cria ou atualiza o aplicativo Teams no Portal do desenvolvedor do Teams.

1. Você pode definir seu próprio arquivo manifest.json no e m365agents.local.yml.m365agents.yml Por exemplo, você pode colocar seu arquivo manifest.json e test/test.jsonatualizar os manifestPath parâmetros em arquivos yaml.

   - uses: teamsApp/zipAppPackage # Build Teams app package with latest env value
     with:
     manifestPath: ./test/test.json # Path to manifest template
     outputZipPath: ./appPackage/build/appPackage.${{TEAMSFX_ENV}}.zip
     outputJsonPath: ./appPackage/build/manifest.${{TEAMSFX_ENV}}.json
   

2. Você pode definir suas próprias variáveis de ambiente. O manifest.json padrão contém alguns espaços reservados com o formato ${{xx_xx}}. Você pode definir suas próprias variáveis de ambiente e adicionar espaços reservados no arquivo manifest.json. Por exemplo, você pode personalizar a descrição do aplicativo definindo uma nova variável de ambiente no arquivo env/.env.xx e atualizar manifest.json com o espaço reservado correspondente.

   .env.dev

   TEAMS_APP_DESCRIPTION=This is an amazing app
   

   manifest.json

    {
        "$schema": "https://developer.microsoft.com/en-us/json-schemas/teams/v1.17/MicrosoftTeams.schema.json",
        "manifestVersion": "1.17",
        "description": {
            "short": "${{TEAMS_APP_DESCRIPTION}}",
            "full": "Full description of tab0418"
        },
    }
   

3. A partir do Agents Toolkit 5.10, usando a file função, você pode armazenar o valor de um campo, como uma descrição de aplicativo longa ou de várias linhas, em um arquivo de texto separado. Por exemplo, crie um description.txt arquivo na pasta pai do manifest.json para armazenar a descrição completa do seu aplicativo. Em seguida, defina o valor de description.full in manifest.json como $[file('description.txt')]. O Agents Toolkit lê o conteúdo do arquivo de texto e o usa como descrição completa ao criar um pacote do aplicativo.

   description.txt

    This is the full description.
   

   manifest.json

    {
        "$schema": "https://developer.microsoft.com/en-us/json-schemas/teams/v1.17/MicrosoftTeams.schema.json",
        "manifestVersion": "1.17",
        "description": {
            "short": "Short description of tab",
            "full": "$[file('./description.txt')]"
        },
    }
   

   Você também pode adicionar o caminho do arquivo em env/.env.xx. Em seguida, modifique o parâmetro de file() para um espaço reservado no ${{xx_xx}} formato.

   .env.dev

    DESCRIPTION_PATH=./description.txt
   

   manifest.json

   {
       "$schema": "https://developer.microsoft.com/en-us/json-schemas/teams/v1.17/MicrosoftTeams.schema.json",
       "manifestVersion": "1.17",
       "description": {
           "short": "Short description of tab",
           "full": "$[file(${{DESCRIPTION_PATH}})]"
       },
   }
   

Valide o seu aplicativo

Após a personalização, talvez você queira validar o manifesto do aplicativo ou o pacote do aplicativo. Você pode disparar Validar Aplicativo no modo de exibição de árvore ou Teams: Validar Aplicativo na paleta de comandos. Há duas opções, Validar usando o esquema de manifesto ou Validar pacote do aplicativo usando regras de validação.

Validar usando o esquema de manifesto do aplicativo

Essa opção é renderizada com variáveis de appPackage/manifest.json ambiente e, em seguida, valida o manifesto do aplicativo com seu esquema.

Como alternativa, use o seguinte comando da interface de linha de comando do Microsoft 365 Agents Toolkit (anteriormente conhecida como CLI do Kit de Ferramentas do Teams):

atk validate --manifest-path <YOUR-PATH-TO-MANIFEST>

Se você encontrar MissingEnvironmentVariablesError, isso significa que o Agents Toolkit não pode encontrar as variáveis de ambiente correspondentes definidas no manifest.json. Talvez seja necessário executar Provisionar ou selecionar F5 para gerar variáveis de ambiente ou atualizar .env.xx manualmente o arquivo para preencher o valor.

Validar o pacote do aplicativo usando regras de validação

Essa opção valida o pacote de aplicativo compactado com regras de validação.

Como alternativa, use o seguinte comando da CLI do Agents Toolkit:

atk validate --app-package-file-path <YOUR-PATH-TO-APP-PACKAGE>

Ele tem outras regras de validação além do esquema de manifesto do aplicativo. Por exemplo, se a seção da guia estática tiver entityId conversations e nome, o seguinte erro será exibido:

Atualizar o aplicativo Teams

Depois de visualizar e validar o arquivo de manifesto do aplicativo, você pode sincronizar suas alterações locais no Portal do Desenvolvedor do Teams disparando o comando Teams: Atualizar aplicativo Teams na paleta de comandos.

Como alternativa, use o seguinte comando da CLI do Agents Toolkit:

atk update teams-app

Se o arquivo de manifesto do aplicativo estiver desatualizado devido a alteração de arquivo de configuração ou modelo, selecione qualquer uma das seguintes ações:

• Somente visualização: o arquivo de manifesto do aplicativo local é substituído de acordo com a configuração atual.
• Visualização e atualização: o arquivo de manifesto do aplicativo local é substituído de acordo com a configuração atual e também atualizado para a plataforma do Teams.
• Cancelar: nenhuma ação é executada.

Para visualizar valores para o ambiente local e de desenvolvimento

No appPackage/manifest.json, você pode acessar o CodeLens para visualizar os valores para local e dev ambientes.

Você pode acessar o .env arquivo selecionando CodeLens, que fornece uma lista suspensa com todos os nomes de ambiente. Depois de selecionar um ambiente, o arquivo correspondente .env é aberto.

Para visualizar valores de todos os ambientes, passe o mouse sobre o espaço reservado. Ele mostra uma lista de nomes de ambiente e valores correspondentes. Se você não provisionou o ambiente ou executou a depuração local, as variáveis de ambiente podem não existir. Provisione ou depure o aplicativo localmente para ver o valor de espaço reservado.

Confira também

• Visão geral do Kit de Ferramentas de Agentes do Microsoft 365
• Esquema de manifesto do aplicativo
• Portal do Desenvolvedor do Teams
• Gerenciar vários ambientes
• Pré-visualização pública do desenvolvedor para o Microsoft Teams
• Provisionar recursos de nuvem usando o Visual Studio Code