Введение
Одно из преимуществ развертывания инфраструктуры как кода — это возможность совместного использования шаблонов, что позволяет работать над кодом Bicep вместе с другими членами команды. Очень важно, чтобы код Bicep был удобен для чтения и работы.
В этом модуле вы узнаете о некоторых способах структурирования и форматирования кода Bicep, чтобы другие пользователи могли легко его понимать, изменять и развертывать.
Пример сценария
Представьте, что вы администратор инфраструктуры Azure в компании игрушек. Вы и ваша команда стандартизировали использование кода Bicep для развертываний Azure и собрали библиотеку многоразовых шаблонов.
Двум членам команды контроля качества поручили провести опрос клиентов. Для этого им нужно развернуть новый веб-сайт и базу данных. Они должны выполнить эту работу в жесткие сроки и не хотят создавать весь шаблон заново, если этого можно избежать. Рассказав им о своих требованиях, вы вспомнили, что у вас уже есть шаблон, близкий к необходимому.
Этот шаблон является одним из первых файлов Bicep, который вы написали, и вы боитесь, что он может быть не готов к работе. Вопрос в том, как изменить шаблон так, чтобы он был правильным, понятным, легко читался и легко редактировался?
Что мы будем делать?
В этом модуле вы узнаете, как дорабатывать файлы Bicep и выполнять их рефакторинг, чтобы упростить работу с кодом для других пользователей. Вы узнаете, что параметры и имена составляют важную часть работы над кодом Bicep и развертываниями Azure, полезную для других пользователей. Вы также узнаете, как определять структуру шаблона, следовать единообразному стилю и добавлять комментарии, которые помогут вашим коллегам понять, как работает ваш шаблон.
Какова основная цель?
По завершении этого модуля вы сможете создавать понятные многоразовые и хорошо документированные шаблоны Bicep.
Необходимые компоненты
Вы должны быть знакомы со структурой и синтаксисом Bicep, включая параметры, циклы, условия и модули.
Чтобы выполнять упражнения модуля, вам потребуется следующее.
- Версия Visual Studio Code, установленная локально.
- Расширение Bicep для Visual Studio Code, установленное локально