Команды Bicep CLI

В этой статье описываются команды, которые можно использовать в интерфейсе Bicep CLI. У вас есть два варианта выполнения этих команд: с помощью Azure CLI или непосредственного вызова команд интерфейса командной строки Bicep. Для каждого метода требуется отдельный процесс установки. Дополнительные сведения см. в статье "Установка Azure CLI " и установка Azure PowerShell.

В этой статье показано, как выполнять команды в Azure CLI. При выполнении через Azure CLI вы начинаете команды с az. Если вы не используете Azure CLI, выполняйте команды без az в начале. Например, az bicep build становится bicep buildи az bicep version становится bicep --version.

сборка

Команда build преобразует файл Bicep в шаблон Azure Resource Manager (шаблон ARM). Как правило, выполнять эту команду не нужно, так как она выполняется автоматически при развертывании файла Bicep. Выполните ее вручную, если хотите просмотреть код JSON шаблона ARM, созданный из файла Bicep.

При использовании любой из следующих функций Bicep автоматически включается создание кода версии 2.0:

• определяемые пользователем типы
• определяемые пользователем функции
• Импорт во время компиляции
• экспериментальные функции

В приведенном ниже примере файл Bicep с именем main.bicep преобразуется в шаблон ARM с именем main.json. Новый файл создается в том же каталоге, что и файл Bicep.

az bicep build --file main.bicep

В следующем примере файл main.json сохраняется в другом каталоге.

az bicep build --file main.bicep --outdir c:\jsontemplates

В следующем примере указываются имя и расположение создаваемого файла.

az bicep build --file main.bicep --outfile c:\jsontemplates\azuredeploy.json

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

az bicep build --file main.bicep --stdout

Если файл Bicep содержит модуль, который ссылается на внешний реестр, команда сборки автоматически вызывает restore. Команда restore получает файл из реестра и сохраняет его в локальном кэше.

Примечание.

Команда restore не обновляет кэш. Дополнительные сведения см. здесь.

Чтобы не вызывать restore автоматически, используйте параметр --no-restore:

az bicep build --no-restore <bicep-file>

Процесс сборки с параметром --no-restore завершается сбоем, если один из внешних модулей еще не кэширован:

The module with reference "br:exampleregistry.azurecr.io/bicep/modules/storage:v1" has not been restored.

При возникновении этой ошибки выполните команду build без параметра --no-restore либо сначала выполните bicep restore.

Чтобы использовать переключатель --no-restore , необходимо иметь интерфейс командной строки Bicep версии 0.4.X или более поздней.

сборка-params

Команда build-params создает файл Bicepparam в файл параметров JSON.

az bicep build-params --file params.bicepparam

Эта команда преобразует файл параметров params.bicepparam в файл параметров params.json JSON.

decompile

Команда decompile преобразует код JSON шаблона ARM в файл Bicep.

az bicep decompile --file main.json

Команда создает файл с именем main.bicep в том же каталоге, что и main.json. Если main.bicep существует в том же каталоге, используйте --force , чтобы перезаписать существующий файл Bicep.

Дополнительные сведения об использовании этой команды см. в статье Декомпиляция шаблона ARM в формате JSON в файл Bicep.

decompile-params

Команда decompile-params декомпилируйте файл параметров JSON в файл параметров Bicepparam .

az bicep decompile-params --file azuredeploy.parameters.json --bicep-file ./dir/main.bicep

Эта команда декомпилирует файл параметров azuredeploy.parameters.json в файл azuredeploy.parameters.bicepparam . --bicep-file указывает путь к Bicep-файлу (относительно файла Bicepparam), на который ссылается объявление using .

format

Команда format форматируйте файл Bicep. Она имеет ту же функцию, что SHIFT+ALT+F и ярлык в Visual Studio Code.

az bicep format --file main.bicep

generate-params

Команда generate-params создает файл параметров из заданного файла Bicep, обновляется, если существует существующий файл параметров.

az bicep generate-params --file main.bicep --output-format bicepparam --include-params all

Команда создает файл параметров Bicep с именем main.bicepparam. Файл параметров содержит все параметры в Bicep-файле, независимо от того, настроено ли значение по умолчанию.

az bicep generate-params --file main.bicep --outfile main.parameters.json

Команда создает файл параметров с именем main.parameters.json. Файл параметров содержит только параметры без значений по умолчанию, настроенных в файле Bicep.

Установить

Команда install добавляет Bicep CLI в локальную среду. Дополнительные сведения см. в статье Установка средств Bicep. Эта команда доступна только в Azure CLI.

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

az bicep install

Установка конкретного выпуска:

az bicep install --version v0.3.255

lint

Команда lint возвращает ошибки и нарушения правил linter файла Bicep.

az bicep lint --file main.bicep

Если файл Bicep содержит модуль, ссылающийся на внешний реестр, команда lint автоматически вызывает восстановление. Команда restore получает файл из реестра и сохраняет его в локальном кэше.

Примечание.

Команда restore не обновляет кэш. Дополнительные сведения см. здесь.

Чтобы не вызывать restore автоматически, используйте параметр --no-restore:

az bicep lint --no-restore <bicep-file>

Процесс lint с коммутатором --no-restore завершается ошибкой, если один из внешних модулей еще не кэширован:

The module with reference "br:exampleregistry.azurecr.io/bicep/modules/storage:v1" has not been restored.

При возникновении этой ошибки выполните команду lint без параметра --no-restore либо сначала выполните bicep restore.

list-versions

Команда list-versions возвращает все доступные версии интерфейса Bicep CLI. Используйте эту команду, чтобы узнать, требуется ли обновить или установить новую версию. Эта команда доступна только в Azure CLI.

az bicep list-versions

Команда возвращает массив доступных версий.

[
  "v0.28.1",
  "v0.27.1",
  "v0.26.170",
  "v0.26.54",
  "v0.25.53",
  "v0.25.3",
  "v0.24.24",
  "v0.23.1",
  "v0.22.6",
  "v0.21.1",
  "v0.20.4",
  "v0.19.5",
  "v0.18.4",
  "v0.17.1",
  "v0.16.2",
  "v0.16.1",
  "v0.15.31",
  "v0.14.85",
  "v0.14.46",
  "v0.14.6",
  "v0.13.1",
  "v0.12.40",
  "v0.12.1",
  "v0.11.1",
  "v0.10.61",
  "v0.10.13",
  "v0.9.1",
  "v0.8.9",
  "v0.8.2",
  "v0.7.4"
]

публикация

Команда publish добавляет модуль в реестр. Реестр контейнеров Azure должен существовать, а учетная запись, осуществляющая публикацию в него, должна иметь подходящие разрешения. Дополнительные сведения о настройке реестра модулей см. в разделе Использование частного реестра для модулей Bicep. Чтобы опубликовать модуль, учетная запись должна иметь правильный профиль и разрешения для доступа к реестру. Вы можете настроить приоритет профиля и учетных данных для проверки подлинности в реестре в файле конфигурации Bicep.

После публикации файла в реестре вы можете ссылаться на него в модуле.

Чтобы использовать команду публикации, необходимо иметь Bicep CLI версии 0.14.X или более поздней. Чтобы использовать --documentationUri/-d этот параметр, необходимо иметь Bicep CLI версии 0.14.X или более поздней.

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

az bicep publish --file <bicep-file> --target br:<registry-name>.azurecr.io/<module-path>:<tag> --documentationUri <documentation-uri>

Например:

az bicep publish --file storage.bicep --target br:exampleregistry.azurecr.io/bicep/modules/storage:v1 --documentationUri https://www.contoso.com/exampleregistry.html

Команда publish не распознает псевдонимы, указанные в файле bicepconfig.json . Укажите полный путь модуля.

Предупреждение

Публикация в том же целевом объекте перезапишет старый модуль. Рекомендуется увеличивать версию при внесении изменений.

Восстановление

Если файл Bicep использует модули, опубликованные в реестре, команда restore получает из реестра копии всех необходимых модулей. Эти копии помещаются в локальный кэш. Сборку файла Bicep можно выполнить только при наличии внешних файлов в локальном кэше. Обычно выполнение восстановления не требуется, так как он автоматически активируется процессом сборки.

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

Чтобы использовать команду восстановления, необходимо иметь Bicep CLI версии 0.4.X или более поздней. Сейчас эта команда доступна только при вызове Bicep CLI напрямую. Она недоступна посредством команды Azure CLI.

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

az bicep restore --file <bicep-file> [--force]

Вы предоставляете файл Bicep, который хотите развернуть. Он должен содержать модуль, связанный с реестром. Например, можно восстановить следующий файл:

module stgModule 'br:exampleregistry.azurecr.io/bicep/modules/storage:v1' = {
  name: 'storageDeploy'
  params: {
    storagePrefix: 'examplestg1'
  }
}

Расположение локального кэша:

• В Windows

  %USERPROFILE%\.bicep\br\<registry-name>.azurecr.io\<module-path\<tag>
  

• В Linux

  /home/<username>/.bicep
  

• На Компьютере Mac

  ~/.bicep
  

Команда restore не обновляет кэш, если модуль уже кэширован. Чтобы обновить кэш, можно удалить путь к модулю из кэша или использовать команду restore с параметром --force.

обновление

Команда upgrade обновляет установленную версию до последней версии. Эта команда доступна только в Azure CLI.

az bicep upgrade

версия

Команда version возвращает установленную версию.

az bicep version

Команда отображает номер версии.

Bicep CLI version 0.22.6 (d62b94db31)

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

bicep --version

Если интерфейс командной строки Bicep не установлен, появится сообщение об ошибке, указывающее, что интерфейс командной строки Bicep не найден.

Следующие шаги

Сведения о развертывании файла Bicep см. в следующих статьях:

• Azure CLI
• Cloud Shell
• PowerShell