Partilhar via


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

Você pode personalizar seu 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 de sua unidade local ou repositório usando o Visual Studio (VS) Code. Você também aprenderá como validar seu arquivo e gerenciar configurações de personalização para projetos.

Use personalizações no Microsoft Dev Box de duas maneiras: personalizações de equipe criam uma configuração compartilhada para uma equipe e 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 da equipa Personalizações do usuário
Configurar em Pool de caixas de desenvolvimento Caixa de desenvolvimento
As personalizações aplicam-se a Todas as caixas de desenvolvimento na piscina Caixa individual de desenvolvimento
Facilmente partilhável Sim Não
Nome do arquivo de personalizações Imagedefinition.yaml myfilename.yaml ou workload.yaml
Fonte Catálogo Upload ou repositório pessoal
Suporta segredos do cofre de chaves Sim Sim

As personalizações do usuário ajudam a garantir que os desenvolvedores cumpram as proteções 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 da 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 do usuário podem ser habilitadas ou desabilitadas no nível do projeto. Quando você cria um projeto, as personalizações do usuário são ativadas por padrão.

Pré-requisitos

Para concluir 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.
Use o portal do desenvolvedor para carregar e aplicar um arquivo YAML durante a criação da caixa de desenvolvimento Usuário do Dev Box

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

Crie e gerencie arquivos de personalização no VS Code. Use a extensão 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, em seguida, instale a extensão Dev Box.

  3. Faça o download de um arquivo de personalização YAML de exemplo do repositório de amostras e abra-o no VS Code.

  4. Descubra as tarefas disponíveis no catálogo usando a paleta de comandos. Selecione View>Command Palette>Dev Box: Liste tarefas disponíveis para esta caixa de desenvolvimento.

    Captura de ecrã 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. Selecione View>Command Palette>Dev Box: Apply Customizations Tasks.

    Captura de ecrã 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 à sua caixa de desenvolvimento de teste. Inspecione as alterações e verifique se há erros ou avisos no terminal VS Code durante a execução da tarefa.

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

Opcional: Personalize 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 os conjuntos exclusivos de software e definições de configuração necessários para preparar seu ambiente Windows para codificar. 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 da caixa de desenvolvimento que usa um arquivo WinGet Desired State Configuration (DSC) existente.

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

Para saber mais, consulte 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.

Carregar um ficheiro

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

  2. No painel Adicionar uma caixa de desenvolvimento , adicione detalhes para 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 para aplicar personalizações.

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

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

  5. Para verificar se as tarefas em seu 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 para validar o arquivo de personalização antes de continuar.

  6. Revise 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.

  2. No painel Adicionar uma caixa de desenvolvimento , adicione detalhes para a 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 para aplicar personalizações.

  4. Selecione Carregar arquivo(s) de personalização, selecione Escolher um arquivo de personalização de um repositório e insira a URL do repositório que armazena o arquivo workload.yaml .

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

  5. Para verificar se as tarefas em seu 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 para validar o arquivo de personalização antes de continuar.

  6. Revise 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.

Desativar personalizações do usuário

As personalizações do usuário são controladas no nível do projeto e habilitadas por padrão. Você pode desativá-los durante ou após a criação do projeto. Quando desativado, os desenvolvedores não podem aplicar seus próprios arquivos de personalização a novas caixas de desenvolvimento. Habilitar personalizações de usuário não ignora os guardrails de projeto existentes; Os desenvolvedores só podem usar 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 personalizações de usuário por meio do portal do Azure

  1. Inicie sessão no portal Azure.

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

  3. Na página Projetos , selecione o projeto onde deseja desabilitar as personalizações do usuário.

  4. Vá para Configurações>Configurações da caixa 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 desativar as personalizações do usuário, desmarque a caixa de seleção Habilitar e selecione Aplicar.

Experiência do desenvolvedor no portal do desenvolvedor

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

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

  1. Uma mensagem no novo bloco da caixa 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 que deve entrar em contacto com o seu 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. A caixa de desenvolvimento não inclui personalizações do usuário.