Instalar ferramentas do Bicep

  • Artigo

Vamos garantir que seu ambiente seja definido para trabalhar arquivos Bicep. Para criar e implantar arquivos Bicep, recomendamos qualquer uma das seguintes opções:

Tarefas Opções Instalação da CLI do Bicep
Autor VS Code e a extensão Bicep automático
Visual Studio e a Extensão Bicep automático
Implantar CLI do Azure automático
PowerShell do Azure manual
VS Code e a extensão Bicep manual
Nuvens desconectadas download

Aviso

A estabilidade da CLI do Bicep em ambientes emulados não é garantida, pois ferramentas de emulação como Rosetta2 e QEMU normalmente não emulam perfeitamente a arquitetura.

A extensão Bicep e o Visual Studio Code

Para criar arquivos Bicep, você precisará de um bom editor de Bicep. Recomendações:

  • Visual Studio Code - Se você ainda não tiver o Visual Studio Code, instale-o.

  • Extensão do Bicep para o Visual Studio Code. O Visual Studio Code com a extensão do Bicep fornece suporte a idiomas e preenchimento automático de recursos. A extensão ajuda a criar e validar arquivos Bicep.

    Para instalar a extensão, pesquise bicep na guia Extensões ou no Marketplace do Visual Studio.

    Selecione Instalar.

    Screenshot of installing Bicep extension.

Para verificar se você instalou a extensão, abra qualquer arquivo com a extensão de arquivo .bicep. Você deve ver o modo de idioma no canto inferior direito mudar para Bicep.

Screenshot of Bicep language mode.

Se você receber um erro durante a instalação, consulte Troubleshoot Bicep installation.

Você pode implantar seus arquivos Bicep diretamente do editor do VS Code. Para obter mais informações, veja Implantar arquivos Bicep com o Visual Studio Code.

Configurar a extensão Bicep

Para exibir as configurações:

  1. No menu View, selecione Extensions.

  2. Selecione Bicep na lista de extensões.

  3. Selecione a guia FEATURE CONTRIBUTIONS:

    Screenshot of Bicep extension settings.

    A extensão Bicep apresenta estas configurações e valores padrão:

    ID Valor padrão Descrição
    bicep.decompileOnPaste true Converta automaticamente os valores JSON, modelos do ARM JSON ou recursos de um modelo do ARM JSON colados no Bicep (use Desfazer para reverter). Para saber mais, confira Colar como Bicep.
    bicep.enableOutputTimestamps true Acrescente um carimbo de data/hora para cada linha exibida no canal de saída de operações do Bicep.
    bicep.suppressedWarnings Avisos que estão sendo suprimidos porque um botão "Não mostrar novamente" foi pressionado. Remover itens para redefinir.
    bicep.enableSurveys true Habilite pesquisas ocasionais para coletar comentários que nos ajudem a melhorar a extensão Bicep.
    bicep.completions.getAllAccessibleAzureContainerRegistries false Ao concluir referências de módulo "br:", consulte o Azure para todos os registros de contêiner acessíveis ao usuário. Isso pode demorar. Se essa opção estiver desativada, somente os registros configurados em moduleAliases em bicepconfig.json serão listados.
    bicep.trace.server Desligar Configure o rastreamento de mensagens enviadas para o servidor de linguagem Bicep.

Para configurar as definições:

  1. No menu File, selecione Preferences e em seguida Settings.

  2. Expanda Extensions e selecione Bicep:

    Screenshot of configuring Bicep extension settings.

Visual Studio e a Extensão Bicep

Para criar o arquivo Bicep no Visual Studio, você precisa:

  • Visual Studio – Se você ainda não tiver o Visual Studio, instale-o.
  • Extensão de Bicep para o Visual Studio. O Visual Studio com a extensão do Bicep fornece suporte a idiomas e preenchimento automático de recursos. A extensão ajuda a criar e validar arquivos Bicep. Instale a extensão Visual Studio Marketplace.

Para um passo a passo do tutorial, confira Início Rápido: Criar arquivos Bicep com o Visual Studio.

CLI do Azure

Ao usar a CLI do Azure com o Bicep, você tem tudo o que precisa para implantar e descompilar arquivos Bicep. A CLI do Azure instalará automaticamente a CLI do Bicep quando um comando for executado que precise dele.

Você deve ter a CLI do Azure versão 2.20.0 ou mais recente instalada. Para instalar ou atualizar a CLI do Azure, consulte:

Para verificar sua versão atual, execute:

az --version

Para validar a instalação da CLI do Bicep, use:

az bicep version

Para atualizar para a versão mais recente, use:

az bicep upgrade

Para obter mais comandos, consulte CLI do Bicep.

Importante

A CLI do Azure instala uma instância autossuficiente da CLI do Bicep. Essa instância não está em conflito com nenhuma versão que você possa ter instalado manualmente. A CLI do Azure não adiciona a CLI do Bicep ao seu PATH.

Você terminou de configurar seu ambiente Bicep. O restante deste artigo descreve as etapas de instalação que você não precisa ao usar a CLI do Azure.

Azure PowerShell

Você precisa ter o Azure PowerShell versão 5.6.0 ou mais recente instalado. Para atualizar ou instalar, consulte Instalar o Azure PowerShell.

O Azure PowerShell não instala automaticamente a CLI do Bicep. Nesse caso, instale manualmente a CLI do Bicep.

Importante

A instância autossuficiente da CLI do Bicep instalada pela CLI do Azure não está disponível para comandos do PowerShell. As implantações do Azure PowerShell falharão se você não tiver instalado manualmente a CLI do Bicep.

Ao instalar manualmente a CLI do Bicep, execute os comandos do Bicep com a sintaxe bicep, em vez da sintaxe az bicep para a CLI do Azure.

Para verificar sua versão da CLI do Bicep, execute:

bicep --version

Instalar manualmente

Os métodos a seguir instalam a CLI do Bicep e a adicionam ao seu PATH. Faça a instalação manual para qualquer uso diferente da CLI do Azure.

Ao instalar manualmente, selecione um local diferente do gerenciado pela CLI do Azure. Todos os exemplos a seguir usam um local chamado bicep ou .bicep. Esse local não entra em conflito com o local gerenciado pela CLI do Azure, que usa .azure.

Linux

# Fetch the latest Bicep CLI binary
curl -Lo bicep https://github.com/Azure/bicep/releases/latest/download/bicep-linux-x64
# Mark it as executable
chmod +x ./bicep
# Add bicep to your PATH (requires admin)
sudo mv ./bicep /usr/local/bin/bicep
# Verify you can now access the 'bicep' command
bicep --help
# Done!

Observação

Para distribuições leves do Linux, como o Alpine, use bicep-linux-musl-x64 em vez de bicep-linux-x64 no script anterior.

macOS

Via homebrew

# Add the tap for bicep
brew tap azure/bicep

# Install the tool
brew install bicep

Via BASH

# Fetch the latest Bicep CLI binary
curl -Lo bicep https://github.com/Azure/bicep/releases/latest/download/bicep-osx-x64
# Mark it as executable
chmod +x ./bicep
# Add Gatekeeper exception (requires admin)
sudo spctl --add ./bicep
# Add bicep to your PATH (requires admin)
sudo mv ./bicep /usr/local/bin/bicep
# Verify you can now access the 'bicep' command
bicep --help
# Done!

Observação

A instalação da CLI do Bicep versão 0.16.X ou superior não precisa da exceção do Gatekeeper. Porém, os as compilações noturnas da CLI do Bicep ainda exigem a exceção.

Windows

Windows Installer

Baixe e execute o instalador mais recente do Windows. O instalador não requer privilégios administrativos. Após a instalação, a CLI do Bicep é adicionada ao PATH do seu usuário. Feche qualquer janela do shell de comando que esteja aberta e a reabra para que a alteração de PATH entre em vigor.

Chocolatey

choco install bicep

Winget

winget install -e --id Microsoft.Bicep

Manual com o PowerShell

# Create the install folder
$installPath = "$env:USERPROFILE\.bicep"
$installDir = New-Item -ItemType Directory -Path $installPath -Force
$installDir.Attributes += 'Hidden'
# Fetch the latest Bicep CLI binary
(New-Object Net.WebClient).DownloadFile("https://github.com/Azure/bicep/releases/latest/download/bicep-win-x64.exe", "$installPath\bicep.exe")
# Add bicep to your PATH
$currentPath = (Get-Item -path "HKCU:\Environment" ).GetValue('Path', '', 'DoNotExpandEnvironmentNames')
if (-not $currentPath.Contains("%USERPROFILE%\.bicep")) { setx PATH ($currentPath + ";%USERPROFILE%\.bicep") }
if (-not $env:path.Contains($installPath)) { $env:path += ";$installPath" }
# Verify you can now access the 'bicep' command.
bicep --help
# Done!

Instalar em uma nuvem desconectada

Os comandos bicep install e bicep upgrade não funcionam em um ambiente desconectado. Para instalar a CLI do Bicep em um ambiente desconectado, é necessário baixar o executável da CLI do Bicep manualmente e salvá-lo em determinado local para .azure/bin. Esse local é onde a instância gerenciada pelo Azure CLI é instalada.

  • Linux

    1. Baixe o bicep-linux-x64 na página da versão do Bicep em um ambiente desconectado.
    2. Copie o executável para o diretório $HOME/.azure/bin em um computador desconectado. Renomeie o arquivo como bicep.

  • macOS

    1. Baixe o bicep-osx-x64 na página da versão do Bicep em um ambiente desconectado.
    2. Copie o executável para o diretório $HOME/.azure/bin em um computador desconectado. Renomeie o arquivo como bicep.

  • Windows

    1. Baixe o bicep-win-x64.exe na página da versão do Bicep em um ambiente desconectado.
    2. Copie o executável para o diretório %UserProfile%/.azure/bin em um computador desconectado. Renomeie o arquivo como bicep.exe.

Ao usar a tarefa da CLI do Azure em uma nuvem desconectada, você precisa definir a propriedade useGlobalConfig da tarefa como true. O valor padrão é false. Confira CI/CD com o Azure Pipelines e os arquivos Bicep para ver um exemplo.

Instalar as compilações noturnas

Para experimentar os bits de pré-lançamento mais recentes do Bicep antes do lançamento, consulte Instalar compilações noturnas.

Aviso

Essas compilações de pré-lançamento têm muito mais probabilidade de ter bugs conhecidos ou desconhecidos.

Instalar o pacote NuGet

A equipe do Bicep disponibilizou publicamente o pacote NuGet Azure.Bicep.Core em nuget.org. Embora seja público, não é um pacote com suporte. Ao usar este pacote, qualquer dependência que você adote será de sua responsabilidade e nos reservamos o direito de efetuar push de alterações interruptivas para esse pacote a qualquer momento.

Para obter mais informações sobre como instalar e consumir pacotes NuGet, confira Consumir pacotes.

Próximas etapas

Para obter mais informações sobre como usar o Visual Studio Code e a extensão do Bicep, consulte Início rápido: criar arquivos Bicep com o Visual Studio Code.

Se você tiver problemas com a instalação do Bicep, consulte Solucionar problemas de instalação do Bicep.

Para implantar arquivos bicep de um pipeline do Azure, consulte integrar o bicep ao Azure pipelines. Para saber mais sobre como usar o arquivo Bicep com o GitHub Actions, confira Implantar arquivos Bicep usando o GitHub Actions.