Compartilhar via

Criar arquivos Bicep usando o Visual Studio Code

  • Artigo

Este artigo mostra como usar o Visual Studio Code para criar arquivos Bicep.

Instalar o Código do VS

Para configurar seu ambiente para o desenvolvimento do Bicep, confira Instalar ferramentas do Bicep. Depois de concluir essas etapas, você terá o Visual Studio Code e a extensão Bicep. Você também terá a CLI do Azure mais recente ou o módulo do Azure PowerShell mais recente.

Comandos Bicep

O Visual Studio Code vem com vários comandos Bicep.

Abra ou crie um arquivo Bicep no VS Code, selecione o menu Exibir e selecione Paleta de comandos. Também é possível usar F1 ou a combinação de teclas Ctrl+Shift+P para abrir a paleta de comandos. Digite Bicep para listar os comandos Bicep.

Captura de tela dos comandos Bicep do Visual Studio Code na paleta de comandos.

Esses comandos incluem:

Esses comandos também são mostrados no menu de atalho quando você clica com o botão direito do mouse em um arquivo Bicep:

Captura de tela dos comandos Bicep do Visual Studio Code no menu de contexto dos arquivos do Bicep.

Quando você clica com o botão direito do mouse em um arquivo JSON:

Captura de tela dos comandos Bicep do Visual Studio Code no menu de contexto dos modelos JSON do ARM.

Compilar modelo do ARM

O comando build converte um arquivo Bicep em um modelo do ARM (modelo do Azure Resource Manager). O novo modelo JSON é armazenado na mesma pasta com o mesmo nome de arquivo. Se existir um arquivo com o mesmo nome de arquivo, ele substituirá o arquivo antigo. Para obter mais informações, confira Comandos da CLI do Bicep.

Criar arquivo de configuração Bicep

O arquivo de configuração Bicep (bicepconfig.json) pode ser usado para personalizar sua experiência de desenvolvimento do Bicep. É possível adicionar bicepconfig.json em vários diretórios. É usado o arquivo de configuração mais próximo ao arquivo Bicep na hierarquia de diretório. Quando você seleciona esse comando, a extensão abre uma caixa de diálogo para você selecionar uma pasta. A pasta padrão é onde você armazena o arquivo Bicep. Se um arquivo bicepconfig.json já existir na pasta, você terá a opção de substituir o arquivo existente.

Para criar um arquivo de configuração Bicep:

  1. Abra o Visual Studio Code.
  2. No menu Exibir, selecione Paleta de comandos (ou pressione Ctrl/Cmd+Shift+P) e clique em Bicep: criar arquivo de configuração Bicep.
  3. Selecione o diretório de arquivos onde deseja colocar o arquivo.
  4. Quando terminar, salve o arquivo de configuração.

Descompilar no Bicep

Esse comando descompila um modelo JSON do ARM em um arquivo Bicep e o coloca no mesmo diretório que o modelo JSON do ARM. O novo arquivo tem o mesmo nome de arquivo com a extensão .bicep. Se um arquivo Bicep com o mesmo nome já existir na mesma pasta, o Visual Studio Code solicitará que você substitua o arquivo existente ou crie uma cópia.

Implantar o arquivo Bicep

Você pode implantar arquivos Bicep diretamente do Visual Studio Code. Selecione Implantar arquivo Bicep na paleta de comandos ou no menu de atalho. A extensão solicita que você entre no Azure, selecione a assinatura, crie/selecione o grupo de recursos e insira os valores de parâmetro.

Observação

O comando de implantação do Bicep no VS Code usa a extensão de conta do Azure para a autenticação. Ele não usa perfis de nuvem de bicepconfig.json.

Gerar arquivo de parâmetros

Esse comando cria um arquivo de parâmetro na mesma pasta do arquivo Bicep. Você pode optar por criar um arquivo de parâmetros Bicep ou um arquivo de parâmetros JSON. O novo nome do arquivo de parâmetro Bicep é <bicep-file-name>.bicepparam, e o novo nome do arquivo de parâmetro JSON é <bicep-file-name>.parameters.json.

Importar Manifesto do Kubernetes (Versão prévia)

Esse comando importa um arquivo de manifesto do Kubernetes e cria um módulo Bicep. Para obter mais informações, confira Provedor de Kubernetes de extensibilidade do Bicep e Início Rápido: Implantar aplicativos do Azure no cluster do AKS (Serviço de Kubernetes do Azure) usando o provedor de kubernetes do Bicep (Versão prévia).

Inserir recurso

O comando insert resource adiciona uma declaração de recurso no arquivo Bicep fornecendo a ID do recurso de um recurso existente. Depois de selecionar Inserir recurso, insira a ID do recurso na paleta de comandos. São necessários alguns instantes para inserir o recurso.

Você pode encontrar a ID do recurso usando um destes métodos:

Semelhante aos modelos de exportação, o processo tenta criar um recurso utilizável. No entanto, a maioria dos recursos inseridos exige algumas modificações antes de serem usados para implantar recursos do Azure.

Para obter mais informações, consulte Descompilar o JSON do Modelo do ARM para o Bicep.

Abrir o visualizador do Bicep

O visualizador mostra os recursos definidos no arquivo Bicep com as informações de dependência do recurso. O diagrama é a visualização de um arquivo Bicep da máquina virtual Linux.

Visualizador do Bicep do Visual Studio Code

Você também tem a opção de abrir o visualizador lado a lado com o arquivo Bicep.

Restaurar Módulos do Bicep

Quando o arquivo Bicep usa módulos publicados em um registro, o comando restaurar obtém cópias de todos os módulos necessários do registro. Ele armazena essas cópias em um cache local. Para obter mais informações, consulte restaurar.

Exibir documento de tipo

No Visual Studio Code, você pode abrir a referência de modelo para o tipo de recurso no qual está trabalhando. Para fazer isso, passe o cursor sobre o nome simbólico do recurso e selecione Exibir documento de tipo.

Captura de tela da exibição do documento de tipo do Bicep do Visual Studio Code.

Ir para a definição

Ao definir um módulo, independentemente dos tipos do arquivo referenciado, seja ele um arquivo local, arquivo de registro de módulo ou especificação de modelo, você pode abrir o arquivo referenciado selecionando ou destacando o caminho do módulo e, em seguida, pressionando [F12]. Se o arquivo referenciado for um AVM (Módulos Verificados do Azure), você poderá alternar entre o arquivo JSON ou Bicep compilado. Para poder abrir o arquivo Bicep de um módulo de registro privado, verifique se o módulo foi publicado no registro com a opção WithSource habilitada. Para obter mais informações, consulte Publicar arquivos no registro. A extensão Bicep do Visual Studio Code versão 0.27.1 ou mais recente é necessária para abrir o arquivo Bicep do registro de módulo privado.

Colar como Bicep

É possível colar um trecho JSON de um modelo do ARM no arquivo Bicep. O Visual Studio Code descompila automaticamente o JSON para Bicep. Este recurso só está disponível com a extensão de Bicep versão 0.14.0 ou mais recente. Esse recurso está habilitado por padrão. Para desabilitar o recurso, consulte VS Code e Extensão Bicep.

Com esse recurso, é possível colar o seguinte:

  • Modelos JSON completos do ARM.
  • Um único ou diversos recursos.
  • Valores JSON, como objetos, matrizes e cadeia de caracteres. Uma cadeia de caracteres com aspas duplas é convertida em uma com aspas simples.

Por exemplo, é possível começar com o seguinte arquivo Bicep:

@description('Storage Account type')
@allowed([
  'Standard_LRS'
  'Standard_GRS'
  'Standard_ZRS'
  'Premium_LRS'
])
param storageAccountsku string = 'Standard_LRS'

@description('Location for all resources.')
param location string = resourceGroup().location

var storageAccountName = '${uniqueString(resourceGroup().id)}storage'

resource storageAccount 'Microsoft.Storage/storageAccounts@2023-04-01' = {
  name: storageAccountName
  location: location
  sku: {
    name: storageAccountsku
  }
  kind: 'StorageV2'
  tags: {
    ObjectName: storageAccountName
  }
  properties: {}
}

output storageAccountName string = storageAccountName

E colar o seguinte JSON:

{
  "type": "Microsoft.Batch/batchAccounts",
  "apiVersion": "2024-02-01",
  "name": "[parameters('batchAccountName')]",
  "location": "[parameters('location')]",
  "tags": {
    "ObjectName": "[parameters('batchAccountName')]"
  },
  "properties": {
    "autoStorage": {
      "storageAccountId": "[resourceId('Microsoft.Storage/storageAccounts', variables('storageAccountName'))]"
    }
  }
}

O Visual Studio Code converte automaticamente o JSON em Bicep. Observe que também é necessário adicionar o parâmetro batchAccountName.

É possível desfazer a descompilação usando Ctrl+Z. O JSON original aparece no arquivo.

Solucionar problemas

O painel Problems resume os erros e o aviso no arquivo Bicep.

Captura de tela do painel de problemas Bicep do Visual Studio Code.

Para obter a lista de códigos de erro/aviso, consulte códigos de erro/aviso Bicep.

Próximas etapas

Para um passo a passo do início rápido, consulte Início Rápido: Criar arquivos Bicep com o Visual Studio Code.