Настройка пользовательских настроек для полей разработки

Вы можете персонализировать Microsoft Dev Box, отправив файл настройки пользователя. Файлы настройки пользователей позволяют настроить поле разработки с помощью предпочитаемых личных параметров и приложений, чтобы можно было быстрее приступить к написанию кода. В этой статье объясняется, как создать, проверить и отправить файл настройки пользователя с локального диска или репозитория с помощью Visual Studio (VS) Code. Вы также узнаете, как проверить файл и управлять параметрами настройки для проектов.

Используйте настройки в Microsoft Dev Box двумя способами: настройки группы создают общую конфигурацию для команды, а пользовательские настройки создают личную конфигурацию для отдельного разработчика. В следующей таблице показаны различия между двумя типами настроек.

Функция	Настройки команды	Настройки пользователей
Настроить на	Пул виртуальных машин для разработки	Поле разработки
Настройки применяются к	Все поля разработки в пуле	Отдельное поле разработки
Простой общий доступ	Да	нет
Имя файла настроек	Imagedefinition.yaml	myfilename.yaml или workload.yaml
Исходный материал	Каталог	Загрузка или личный репозиторий
Поддерживает секреты хранилища ключей	Да	Да

Настройки пользователей помогают обеспечить соответствие разработчиков корпоративным ограничениям; только пользовательские задачи, предварительно утверждённые через каталог, доступны разработчикам для использования в файлах настройки. Пользователи стандартного поля разработки не могут выполнять встроенные задачи PowerShell и WinGet в системном контексте, что предотвращает эскалацию привилегий.

Настройки пользователей можно включить или отключить на уровне проекта. При создании проекта пользовательские настройки включены по умолчанию.

Предпосылки

Чтобы выполнить действия, описанные в этой статье, сделайте следующее:

• Настройте центр разработки с помощью определения поля разработки, пула средств разработки и проекта для разработки, чтобы создать поле разработки.
• Присоединитесь к группе безопасности Dev Box Users по крайней мере для одного проекта.
• Подключите каталог к центру разработки с задачами, используемыми в файле настройки. Если у вас нет каталога, см. статью "Добавление и настройка каталога" из GitHub или Azure Repos.

Разрешения, необходимые для настройки настроек

Чтобы создать и применить настройки в поле разработки, вам потребуются следующие разрешения:

Действие	Разрешение или роль
Включение или отключение настроек пользователей в проекте	Разрешение на запись в проекте.
Создание файла настройки	Не указано. Любой пользователь может создать файл настройки.
Использование портала разработчика для отправки и применения YAML-файла во время создания поля разработки	Пользователь Dev Box

Создание файла настройки пользователя

Создание файлов настройки и управление ими в VS Code. Используйте расширение Microsoft Dev Box в VS Code для обнаружения задач в подключенном каталоге и тестирования файла настройки.

1. Создайте поле разработки для тестирования или используйте существующее поле разработки.

2. В тестовом поле разработки установите VS Code, а затем установите расширение Dev Box.

3. Скачайте пример файла настройки YAML из репозитория примеров, а затем откройте его в VS Code.

4. Обнаружение доступных задач в каталоге с помощью палитры команд. Выберите Вид>Палитра команд>Dev Box: Список доступных задач для этой Dev Box.

   

5. Проверьте настройку в VS Code с помощью палитры команд. Выберите Просмотр>Палитра команд>Ящик разработчика: применить задачи настройки.

   

6. Файл настройки запускается и применяет указанные задачи к тестовой среде разработки. Проверьте изменения и проверьте терминал VS Code для любых ошибок или предупреждений во время выполнения задачи.

7. После успешного запуска файла настройки отправьте его в каталог.

Необязательно. Настройка поля разработки с помощью существующих файлов конфигурации WinGet

Конфигурация WinGet использует подход config-as-code для определения уникальных наборов параметров программного обеспечения и конфигурации, необходимых для подготовки среды Windows к коду. Эти файлы конфигурации также можно использовать для настройки поля разработки с помощью задачи WinGet, включенной в каталог быстрого запуска Майкрософт.

В этом примере показан файл настройки поля разработки, использующий существующий файл конфигурации требуемого состояния WinGet (DSC).

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

Дополнительные сведения см. в статье о конфигурации WinGet.

Создание поля разработки с помощью файла настройки пользователя

Используйте отдельный файл настройки, отправив его с локального диска при создании поля разработки или скачав его из репозитория. Файлы настройки, хранящиеся в репозитории, должны называться workload.yaml. Файлы настройки, хранящиеся локально для отправки, должны называться myfilename.yaml.

Отправка файла

1. На портале разработчика выберите новое>поле разработки.

2. В области "Добавление поля разработки " добавьте сведения для поля разработки.

3. Выберите "Применить настройки" и нажмите кнопку "Продолжить".

   

4. Выберите Загрузить файл(ы) кастомизации, выберите Добавить кастомизации из файла, затем выберите ваш файл myfilename.yaml.

   

5. Чтобы проверить правильность применения задач в файле настроек, проверьте их перед продолжением. Выберите Проверить.

   

6. Просмотрите сводку по созданию поля разработки и нажмите кнопку "Создать".

   

Получение файла из репозитория

1. На портале разработчика выберите новое>поле разработки.

2. В области "Добавление поля разработки " добавьте сведения для разработки.

3. Выберите "Применить настройки" и нажмите кнопку "Продолжить".

   

4. Выберите " Отправить файл настройки", выберите " Выбрать файл настройки" из репозитория, а затем введите URL-адрес репозитория, в который хранится файл workload.yaml .

   

5. Чтобы убедиться, что задачи в файле настроек будут применены правильно, проверьте их перед продолжением. Выберите Проверить.

   

6. Просмотрите сводку по созданию поля разработки и нажмите кнопку "Создать".

   

Отключение пользовательских настроек

Пользовательские настройки управляются на уровне проекта и включены по умолчанию. Их можно отключить во время или после создания проекта. При отключении разработчики не могут применять собственные файлы настройки к новым полям разработки. Включение настроек пользователей не обходит существующие средства защиты проекта; разработчики могут использовать только задачи, предоставляемые в присоединенном каталоге, и не могут выполнять задачи с повышенными привилегиями, если администратор явно не включил административную задачу в каталог.

Отключение настроек пользователей на портале Azure

1. Войдите на портал Azure.

2. В поле поиска введите проекты. В списке результатов выберите "Проекты".

3. На странице "Проекты" выберите проект, в котором требуется отключить настройки пользователей.

4. Перейдите в Настройки>Настройки рабочего пространства разработчика.

   

5. Чтобы отключить настройки пользователей, снимите флажок "Включить " и нажмите кнопку "Применить".

Опыт разработчика на портале разработчика

При отключении пользовательских настроек для проекта разработчики по-прежнему могут отправить файл настройки пользователя во время создания поля разработки, но процесс проверки завершается сбоем, и настройки не применяются к поле разработки.

Если вы создаете поле разработки с настройками пользователей в проекте, где настройки пользователей отключены, вы увидите следующее на портале разработчика:

1. Сообщение на новой плитке поля разработки отображает ошибки при применении настроек.

   

2. Сведения о том, как связаться с администратором.

   

3. Поле разработки не включает пользовательские настройки.

Связанный контент

• Настройки Microsoft Dev Box
• Настройка образов центра разработки
• Добавление и настройка каталога из GitHub или Azure Repos