Compartilhar via


Configurar personalizações de usuário para caixas de desenvolvimento

Você pode personalizar o Microsoft Dev Box carregando um arquivo de personalização do usuário. Os arquivos de personalização do usuário permitem que você configure sua caixa de desenvolvimento com suas configurações pessoais e aplicativos preferidos, para que você possa começar a codificar mais rapidamente. Este artigo explica como criar, testar e carregar um arquivo de personalização do usuário da unidade local ou do repositório usando o Visual Studio (VS) Code. Você também aprenderá a validar o arquivo e gerenciar as configurações de personalização para projetos.

Use personalizações no Microsoft Dev Box de duas maneiras: as personalizações de equipe criam uma configuração compartilhada para uma equipe e as personalizações de usuário criam uma configuração pessoal para um desenvolvedor individual. A tabela a seguir mostra as diferenças entre os dois tipos de personalizações.

Característica Personalizações de equipe Personalizações de usuário
Configurar em Pool de computadores de desenvolvimento Computador de desenvolvimento
As personalizações se aplicam a Todos os computadores de desenvolvimento no pool Computador de desenvolvimento individual
Compartilhável facilmente Yes Não
Nome do arquivo de personalizações Imagedefinition.yaml myfilename.yaml ou workload.yaml
Fonte Catálogo Carregar ou repositório pessoal
Dá suporte a segredos do cofre de chaves Yes Yes

As personalizações de usuário ajudam a garantir que os desenvolvedores estejam em conformidade com as políticas de segurança da empresa; somente tarefas personalizadas pré-aprovadas por meio de um catálogo estão disponíveis para os desenvolvedores usarem em seus arquivos de personalização. Os usuários de caixa de desenvolvimento padrão não podem executar tarefas internas do PowerShell e do WinGet em um contexto do sistema, o que impede o escalonamento de privilégios.

As personalizações de usuário podem ser habilitadas ou desabilitadas no nível do projeto. Quando você cria um projeto, as personalizações de usuário estão ativadas por padrão.

Pré-requisitos

Para completar as etapas neste artigo:

Permissões necessárias para configurar personalizações

Para criar e aplicar personalizações a uma caixa de desenvolvimento, você precisa das seguintes permissões:

Ação Permissão ou função
Habilitar ou desabilitar personalizações de usuário em um projeto Permissão de gravação no projeto.
Criar um arquivo de personalização Nenhum especificado. Qualquer pessoa pode criar um arquivo de personalização.
Usar o portal do desenvolvedor para carregar e aplicar um arquivo YAML durante a criação da caixa de desenvolvimento Usuário do Computador de Desenvolvimento

Criar um arquivo de personalização do usuário

Crie e gerencie arquivos de personalização no VS Code. Use a extensão do Microsoft Dev Box no VS Code para descobrir tarefas no catálogo anexado e testar o arquivo de personalização.

  1. Crie uma caixa de desenvolvimento para teste ou use uma caixa de desenvolvimento existente.

  2. Na caixa de desenvolvimento de teste, instale o VS Code e instale a extensão Dev Box.

  3. Baixe um arquivo de personalização YAML de exemplo do repositório de exemplos e abra-o no VS Code.

  4. Descubra as tarefas disponíveis no catálogo usando a paleta de comandos. Caixa de desenvolvimento Selecionar Exibição>Paleta de Comandos>: Listar Tarefas Disponíveis para Esse Computador de Desenvolvimento.

    Captura de tela da paleta de comandos Dev Box no Visual Studio Code, mostrando o comando para listar as tarefas disponíveis.

  5. Teste a personalização no VS Code usando a paleta de comandos. Selecionar Exibição>Paleta de Comandos>: Caixa de desenvolvimento: aplicar tarefas de personalizações.

    Captura de tela da paleta de comandos Dev Box no Visual Studio Code, mostrando o comando para aplicar tarefas de personalização.

  6. O arquivo de personalização é executado e aplica as tarefas especificadas ao ambiente de desenvolvimento de teste. Inspecione as alterações e verifique se há erros ou avisos no terminal do VS Code durante a execução da tarefa.

  7. Depois que o arquivo de personalização for executado com êxito, carregue-o no catálogo.

Opcional: personalizar sua caixa de desenvolvimento usando arquivos de configuração existentes do WinGet

A configuração do WinGet usa uma abordagem de 'configuração como código' para definir conjuntos únicos de software e configurações necessários para preparar seu ambiente Windows para o desenvolvimento de software. Você também pode usar esses arquivos de configuração para configurar uma caixa de desenvolvimento usando uma tarefa WinGet incluída no catálogo de início rápido fornecido pela Microsoft.

Este exemplo mostra um arquivo de personalização de caixa de desenvolvimento que usa um arquivo DSC (Configuração de Estado Desejado) do WinGet existente.

tasks:
    - name: winget
      parameters:
          configure: "projectConfiguration.dsc.yaml"

Para saber mais, confira a configuração do WinGet.

Criar uma caixa de desenvolvimento usando um arquivo de personalização do usuário

Use um arquivo de personalização individual carregando-o de uma unidade local ao criar sua caixa de desenvolvimento ou baixando-o de um repositório. Os arquivos de personalização armazenados em um repositório devem ser nomeados workload.yaml. Os arquivos de personalização armazenados localmente para upload devem ser nomeados myfilename.yaml.

Fazer upload de um arquivo

  1. No portal do desenvolvedor, selecione Nova>caixa de desenvolvimento Novo.

  2. No painel Adicionar uma caixa de desenvolvimento, adicione detalhes da caixa de desenvolvimento.

  3. Selecione Aplicar personalizações e, em seguida, selecione Continuar.

    Captura de tela do painel Adicionar uma caixa de desenvolvimento no portal do desenvolvedor, mostrando a opção de aplicar personalizações.

  4. Selecione Carregar um arquivo de personalização, selecione Adicionar personalizações do arquivo e, em seguida, navegue até o arquivo myfilename.yaml .

    Captura de tela da seção Carregar um arquivo de personalização no portal do desenvolvedor, mostrando a opção de adicionar personalizações de um arquivo.

  5. Para verificar se as tarefas no arquivo de personalizações são aplicadas corretamente, valide-as antes de prosseguir. Selecione Validar.

    Captura de tela do botão Validar no portal do desenvolvedor, mostrando a opção de validar o arquivo de personalização antes de continuar.

  6. Examine o resumo de criação da caixa de desenvolvimento e selecione Criar.

    Captura de tela da página de resumo de criação da caixa de desenvolvimento no portal do desenvolvedor, mostrando a opção de criar uma caixa de desenvolvimento personalizada.

Obter um arquivo de um repositório

  1. No portal do desenvolvedor, selecione Nova>caixa de desenvolvimento Novo.

  2. No painel Adicionar uma caixa de desenvolvimento, adicione detalhes para a sua caixa de desenvolvimento.

  3. Selecione Aplicar personalizações e, em seguida, selecione Continuar.

    Captura de tela do painel Adicionar uma caixa de desenvolvimento no portal do desenvolvedor, mostrando a opção de aplicar personalizações.

  4. Selecione Carregar um arquivo de personalização, escolha um arquivo de personalização em um repositório e, em seguida, insira a URL do repositório que armazena o arquivo workload.yaml .

    Captura de tela da seção Escolher um arquivo de personalização em uma seção do repositório no portal do desenvolvedor, mostrando a opção de inserir uma URL do repositório.

  5. Para verificar se as tarefas no arquivo de personalizações serão aplicadas corretamente, valide-as antes de prosseguir. Selecione Validar.

    Captura de tela do botão Validar no portal do desenvolvedor, mostrando a opção de validar o arquivo de personalização antes de continuar.

  6. Examine o resumo de criação da caixa de desenvolvimento e selecione Criar.

    Captura de tela da página de resumo de criação da caixa de desenvolvimento no portal do desenvolvedor, mostrando a opção de criar uma caixa de desenvolvimento personalizada.

Desabilitar personalizações de usuário

As personalizações de usuário são controladas no nível do projeto e são habilitadas por padrão. Você pode desabilitá-los durante ou após a criação do projeto. Quando desabilitados, os desenvolvedores não podem aplicar seus próprios arquivos de personalização a novas caixas de desenvolvimento. Habilitar as personalizações de usuário não ignora os verificadores de integridade projeto existentes. Os desenvolvedores só podem usar as tarefas fornecidas no catálogo anexado e não podem executar tarefas com privilégios elevados, a menos que um administrador tenha incluído explicitamente uma tarefa administrativa no catálogo.

Desabilitar as personalizações de usuário por meio do portal do Azure

  1. Entre no portal do Azure.

  2. Na caixa de pesquisa, insira projetos. Na lista de resultados, selecione Projetos.

  3. Na página Projetos, selecione o projeto no qual você deseja desabilitar as personalizações de usuário.

  4. Acesse Configurações>Configurações do computador de desenvolvimento.

    Captura de tela de um projeto de caixa de desenvolvimento mostrando o recurso de personalizações do usuário habilitado nas configurações da caixa de desenvolvimento.

  5. Para desabilitar as personalizações de usuário, desmarque a caixa de seleção Habilitar e selecione Aplicar.

Experiência de desenvolvedor no portal do desenvolvedor

Quando você desabilita personalizações de usuário para um projeto, os desenvolvedores ainda podem carregar um arquivo de personalização do usuário durante a criação do computador de desenvolvimento, mas o processo de validação falha e as personalizações não são aplicadas ao computador de desenvolvimento.

Se você criar uma caixa de desenvolvimento com personalizações de usuário em um projeto em que as personalizações de usuário estão desabilitadas, você verá o seguinte no portal do desenvolvedor:

  1. Uma mensagem no novo bloco do computador de desenvolvimento mostra erros ao aplicar personalizações.

    Captura de tela de um bloco de caixa de desenvolvimento mostrando a mensagem Encontramos erros ao aplicar personalizações. Um botão Ver detalhes está realçado.

  2. Os detalhes indicam para entrar em contato com o administrador.

    Captura de tela do painel de detalhes do erro no portal do desenvolvedor, exibindo uma mensagem informando que as personalizações falharam e aconselhando o usuário a entrar em contato com o administrador.

  3. O computador de desenvolvimento não inclui personalizações de usuário.