Configurar personalizações de equipe

Use o recurso de personalizações do Microsoft Dev Box para simplificar a configuração de ambientes de desenvolvimento baseados em nuvem. Iniciar um novo projeto ou juntar-se a uma nova equipa pode ser complexo e demorado. As personalizações de equipe usam um arquivo de definição de imagem (imagedefinition.yaml) para pré-instalar ferramentas, clonar repositórios e definir configurações para cada caixa de desenvolvimento em um pool. Com as personalizações de equipe, os administradores podem fornecer estações de trabalho prontas para codificar com aplicativos, ferramentas, repositórios, bibliotecas de código, pacotes e scripts de compilação. Este artigo mostra como criar, testar e editar um arquivo de definição de imagem para sua caixa de desenvolvimento no Visual Studio Code.

Você pode usar personalizações no Dev Box de duas maneiras. As personalizações de equipe criam uma configuração compartilhada para uma equipe. As personalizações do usuário criam uma configuração pessoal para um desenvolvedor individual. A lista a seguir resume as diferenças entre esses tipos de personalização.

• Personalizações de equipe: definidas uma vez, aplicadas a cada caixa de desenvolvimento em um pool via imagedefinition.yaml em um catálogo.
• Personalizações do usuário: YAML pessoal carregado durante a criação da caixa; afeta apenas essa caixa.
• Utilizar a equipa para consistência e conformidade; Use o usuário para preferências pessoais.

Para saber mais, consulte Personalizações do Microsoft Dev Box.

Configure as personalizações da equipe seguindo estas etapas:

Pré-requisitos

Criar um arquivo de definição de imagem

Para definir as ferramentas, pacotes e configurações de que sua equipe precisa, crie um arquivo de definição de imagem no formato YAML que liste as tarefas necessárias para seu ambiente de caixa de desenvolvimento.

Usar tarefas internas ou um catálogo para tarefas personalizadas

As tarefas são ações reutilizáveis que vêm de primitivas internas (WinGet, PowerShell e Git-Clone) ou de um catálogo anexado ao seu projeto do centro de desenvolvimento. Escolha a fonte que melhor se adapta às suas necessidades de personalização e requisitos do projeto.

• Use WinGet, PowerShell e Git-Clone tarefas internas. Os centros de desenvolvimento do Dev Box suportam tarefas do PowerShell e do WinGet prontas para uso. Se suas personalizações exigirem apenas PowerShell, WinGet ou Git-Clone você poderá começar com essas tarefas internas e criar seu arquivo de definição de imagem. Para obter mais informações, consulte Criar um arquivo de definição de imagem.

  Importante

  A tarefa interna do WinGet não é a mesma que o executável do WinGet. A tarefa interna do WinGet é baseada no cmdlet WinGet do PowerShell.

• Use um catálogo para definir tarefas personalizadas. Crie suas próprias tarefas personalizadas. Para disponibilizar tarefas personalizadas para toda a organização, anexe um catálogo com definições de tarefas personalizadas ao seu centro de desenvolvimento. O Dev Box dá suporte aos catálogos Azure Repos e GitHub. Como as tarefas são definidas apenas no centro de desenvolvimento, armazene tarefas e definições de imagem em repositórios separados.

  Para saber mais sobre como definir tarefas personalizadas, consulte Configurar tarefas para personalizações da Caixa de Desenvolvimento.

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

Carregar o arquivo de definição de imagem para um repositório

Você pode usar um repositório GitHub ou Azure Repos como um catálogo para tornar seu arquivo de definição de imagem acessível a partir de um projeto de caixa de desenvolvimento. Cada projeto pode ter um catálogo que armazena vários arquivos de definição de imagem, que você pode configurar em pools para alinhar às necessidades de suas equipes de desenvolvedores.

Depois de ter um arquivo de definição de imagem que deseja usar, carregue-o para um catálogo. As seções a seguir mostram como anexar seu catálogo a um projeto e disponibilizar sua definição de imagem para seleção ao configurar seus pools de caixas de desenvolvimento.

Configurar definições de imagem no nível do projeto

Os projetos ajudam você a gerenciar os recursos da Caixa de Desenvolvimento de forma eficiente. Você pode atribuir a cada equipe de desenvolvedores seu próprio projeto para organizar os recursos de forma eficaz. Crie várias definições de imagem em seu repositório de catálogo, cada uma em sua própria pasta para direcionar diferentes equipes de desenvolvedores em seu projeto.

Habilitar catálogos no nível do projeto

Habilite catálogos no nível do projeto no nível do centro de desenvolvimento antes de adicionar um catálogo a um projeto. Para habilitar catálogos no nível do projeto no nível do centro de desenvolvimento:

1. No portal do Azure, vá para o seu centro de desenvolvimento.

2. No menu à esquerda, em Configurações, selecione Configurações do Centro de desenvolvimento.

3. Em Catálogos de nível de projeto, selecione Habilitar catálogos por projeto e, em seguida, selecione Aplicar.

   

Para obter mais informações sobre como adicionar catálogos a projetos, consulte Adicionar e configurar um catálogo do GitHub ou Azure Repos.

Definir configurações de sincronização de catálogo para o projeto

Configure seu projeto para sincronizar definições de imagem do catálogo. Essa configuração permite que você use as definições de imagem no catálogo para criar pools de caixas de desenvolvimento.

1. Inicie sessão no portal Azure.

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

3. Abra o projeto Dev Box onde você deseja configurar as configurações de sincronização do catálogo.

4. Selecione Catálogos.

5. Selecione Configurações de sincronização.

   

6. No painel Definições de sincronização , selecione Definições de imagem e, em seguida, selecione Guardar.

   

Anexar o catálogo que contém o arquivo de definição de imagem

Para usar um arquivo de definição de imagem, anexe o catálogo que contém o arquivo ao seu projeto. Isso torna a definição de imagem disponível para seleção ao configurar seus pools de caixas de desenvolvimento.

O painel Definições de imagem mostra as definições de imagem que seu projeto pode usar.

Para saber como anexar catálogos, consulte Adicionar e configurar um catálogo do GitHub ou Azure Repos.

Configurar um pool de caixas de desenvolvimento para usar uma definição de imagem

Permita que sua equipe de desenvolvimento use personalizações configurando um pool de caixas de desenvolvimento com um arquivo de definição de imagem. Armazene o arquivo de definição de imagem em um repositório vinculado ao seu projeto como um catálogo. Especifique esse arquivo como a definição de imagem para o pool e as personalizações se aplicam a novas caixas de desenvolvimento.

Siga estas etapas para criar um pool de caixas de desenvolvimento e especificar uma definição de imagem:

1. Inicie sessão no portal Azure.

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

3. Abra o projeto Dev Box ao qual você deseja associar o novo pool de caixas de desenvolvimento.

4. Selecione Pools de caixas de desenvolvimento e, em seguida, selecione Criar.

5. No painel Criar um pool de caixas de desenvolvimento, insira os seguintes valores:

   Configurações	Valor
   Nome	Insira um nome para o pool. O nome do pool é visível para os desenvolvedores quando eles criam caixas de desenvolvimento. Deve ser único dentro de um projeto.
   Definição	Esta caixa lista definições de imagem de catálogos acessíveis e definições de caixa de desenvolvimento. Selecione um arquivo de definição de imagem.
   Ligação de rede	Selecione Implantar em uma rede hospedada pela Microsoft ou usar uma conexão de rede existente.
   Habilitar logon único	Selecione Sim para permitir o logon único para as caixas de desenvolvimento neste pool. O logon único precisa ser configurado para a organização. Para obter mais informações, consulte Habilitar logon único para caixas de desenvolvimento.
   Privilégios de Criador da Box de Desenvolvimento	Selecione Administrador Local ou Usuário Padrão.
   Ativar Auto-stop	Sim é o padrão. Selecione Não para desativar a agenda de parada automática. Você pode configurar uma agenda de parada automática após a criação do pool.
   Tempo de paragem	Selecione um horário para parar todas as caixas de desenvolvimento no pool.
   Fuso horário	Selecione o fuso horário para a hora de parada.
   Licenciamento	Marque essa caixa de seleção para confirmar se sua organização tem licenças do Benefício Híbrido do Azure para aplicar às caixas de desenvolvimento neste pool.

   

6. Selecione Criar.

7. Verifique se o novo pool de caixas de desenvolvimento aparece na lista. Talvez seja necessário atualizar a tela.

Criar uma caixa de desenvolvimento usando o portal do desenvolvedor

Para verificar se as personalizações do arquivo de definição de imagem são aplicadas, crie uma caixa de desenvolvimento no portal do desenvolvedor da Caixa de Desenvolvimento. Siga as etapas em Início rápido: criar e conectar-se a uma Dev Box usando o portal do desenvolvedor da Dev Box. Em seguida, conecte-se à nova caixa de desenvolvimento e verifique se as personalizações funcionam como você espera.

Faça alterações no arquivo de definição de imagem e crie uma nova caixa de desenvolvimento para testá-las. Quando tiver certeza de que as personalizações estão corretas, crie uma imagem reutilizável.

Usar scripts e arquivos modulares em personalizações do Dev Box

Scripts modulares e arquivos como scripts do PowerShell, arquivos de Configuração de Estado Desejado (DSC), arquivos de configuração, arquivos de texto ou imagens podem ser armazenados em um catálogo compartilhado para que você possa reutilizar e padronizar as personalizações da Caixa de Desenvolvimento em várias imagens.

Eles são projetados para:

• Promova a reutilização em múltiplas configurações de Dev Box
• Reduza a duplicação e as despesas gerais de manutenção
• Habilite práticas de configuração consistentes

Estrutura do catálogo

Os ficheiros na mesma pasta que o imagedefinition.yaml, ou nas suas subpastas, são copiados para a dev box na criação. Você pode usar esses arquivos ao executar tarefas de personalização.

O diagrama a seguir mostra uma estrutura de catálogo para scripts modulares e arquivos nas personalizações do Dev Box.

No nível superior, há uma pasta de definições de imagem . Dentro, você encontra subpastas de definição de imagem como frontend-imagedef e backend-imagedef. A pasta frontend-imagedef tem um arquivo de script do PowerShell. A pasta backend-imagedef inclui uma subpasta que contém arquivos DSC. Você pode usar qualquer estrutura para armazenar scripts e outros arquivos.

Referenciar scripts ou arquivos modulares

O arquivo de definição de imagem define uma lista de tarefas que são executadas no contexto do sistema e userTasks que são executadas após o primeiro login na nova caixa de desenvolvimento, no contexto do usuário. Use nomes de exibição para tarefas para esclarecer a finalidade de cada tarefa. No arquivo de definição de imagem, faça referência aos scripts modulares que deseja executar ou aos arquivos que deseja incluir.

$schema: "1.0"
name: "modular-script"
image: microsoftvisualstudio_visualstudioplustools_vs-2022-ent-general-win11-m365-gen2
description: "This definition shows examples of referencing PowerShell scripts and DSC configuration files."

tasks:
  - name: ~/powershell
    displayName: "Modular Script"
    parameters:
      script: C:\ProgramData\Microsoft\DevBoxAgent\ImageDefinitions\catalog-name\modular-script\contoso.ps1
  - name: ~/winget
    displayName: "Install VS Code"
    parameters:
      configurationFile: C:\ProgramData\Microsoft\DevBoxAgent\ImageDefinitions\catalog-name\modular-script\contoso.dsc.yaml

userTasks:
  - name: ~/winget
    displayName: "Install Insomnia"
    parameters:
      configurationFile: C:\ProgramData\Microsoft\DevBoxAgent\ImageDefinitions\catalog-name\modular-script\contoso-user.dsc.yaml

Dev Box valida que todas as tarefas referenciam componentes intrínsecos (como o PowerShell ou WinGet) ou qualquer um disponível a nível do DevCenter. Ele baixa todos os arquivos de Definição de Imagem para um diretório definido na nova caixa de desenvolvimento, juntamente com os arquivos de tarefas relevantes. Em seguida, ele executa cada tarefa em seu diretório de tarefas baixado e carrega o status da tarefa após a conclusão.

Próximo passo

Agora que você tem um arquivo de definição de imagem que configura e cria caixas de desenvolvimento para sua equipe de desenvolvimento, saiba como otimizar o tempo de criação da caixa de desenvolvimento com a criação de imagens do centro de desenvolvimento.