Criar arquivos Bicep usando o Visual Studio Code

  • Artigo

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

Instalar o VS Code

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

Comandos do bíceps

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

Abra ou crie um arquivo Bicep no VS Code, selecione o menu Exibir e, em seguida, selecione Paleta de comandos. Você também pode usar F1 ou a combinação de teclas Ctrl+Shift+P para exibir a paleta de comandos. Digite Bicep para listar os comandos Bicep.

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

Esses comandos incluem:

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

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

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

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

Criar modelo ARM

O build comando converte um arquivo Bicep em um modelo do Azure Resource Manager (modelo ARM). 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, consulte Comandos da CLI do Bicep.

Criar arquivo de configuração do Bicep

O arquivo de configuração do Bicep (bicepconfig.json) pode ser usado para personalizar sua experiência de desenvolvimento do Bicep. Você pode adicionar bicepconfig.json vários diretórios. O arquivo de configuração mais próximo do arquivo bicep na hierarquia de diretórios é usado. 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 já existir um bicepconfig.json ficheiro na pasta, pode substituir o ficheiro existente.

Para criar um arquivo de configuração do Bicep:

  1. Abra o Visual Studio Code.
  2. No menu Exibir, selecione Paleta de comandos (ou pressione Ctrl/Cmd+Shift+P) e, em seguida, selecione Bicep: Criar arquivo de configuração do bíceps.
  3. Selecione o diretório de arquivo onde você deseja colocar o arquivo.
  4. Salve o arquivo de configuração quando terminar.

Descompilar no Bíceps

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

Implantar arquivo Bicep

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

Nota

O comando Bicep deploy de dentro do vscode usa a extensão da Conta do Azure para autenticação. Ele não usa perfis de nuvem do bicepconfig.json.

Gerar arquivo de parâmetros

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

Importar manifesto do Kubernetes (Visualização)

Este comando importa um arquivo de manifesto do Kubernetes e cria um módulo Bicep. Para obter mais informações, consulte Provedor Kubernetes de extensibilidade Bicep e Guia de início rápido: implantar aplicativos do Azure no cluster do Serviço Kubernetes do Azure (AKS) usando o provedor Kubernetes Bicep (Visualização).

Inserir recurso

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

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

Semelhante à exportação de modelos, o processo tenta criar um recurso utilizável. No entanto, a maioria dos recursos inseridos requer alguma modificação antes de poderem ser usados para implantar recursos do Azure.

Para obter mais informações, consulte Descompilando o modelo ARM JSON para Bicep.

Visualizador Bicep aberto

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

Visual Studio Code Bicep visualizer

Você também pode abrir o visualizador lado a lado com o arquivo Bicep.

Restaurar módulos Bicep

Quando o arquivo Bicep usa módulos que são publicados em um registro, o comando restore 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.

Ver tipo de documento

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

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

Ir para a definição

Ao definir um módulo, independentemente dos tipos de arquivo referenciado - seja um arquivo local, arquivo de registro do módulo, especificação do modelo, você pode abrir o arquivo referenciado selecionando ou destacando o caminho do módulo e 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 ficheiro Bicep de um módulo de registo privado, certifique-se de que o módulo é publicado no registo com o comutador WithSource ativado. Para obter mais informações, consulte Publicar arquivos no registro. A extensão do Visual Studio Code Bicep versão 0.27.1 ou mais recente é necessária para abrir o arquivo Bicep do registro do módulo privado.

Colar como bíceps

Você pode colar um trecho JSON de um modelo ARM no arquivo Bicep. O Visual Studio Code descompila automaticamente o JSON para Bicep. Este recurso só está disponível com a extensão Bicep versão 0.14.0 ou mais recente. Esta caraterística está ativada por predefinição. Para desativar o recurso, consulte VS Code e extensão Bicep.

Usando esse recurso, você pode colar:

  • Modelos JSON ARM completos.
  • Um único recurso ou vários recursos.
  • Valores JSON, como objetos, matrizes e cadeias de caracteres. Uma cadeia de caracteres com aspas duplas é convertida em aspas simples.

Por exemplo, você pode 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 cole 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 você também precisa adicionar o parâmetro chamado batchAccountName.

Você pode desfazer a descompilação usando Ctrl+Z. O JSON original aparece no arquivo.

Resolver problemas

O Problems painel resume os erros e avisos no arquivo Bicep.

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

Para obter a lista de códigos de erro/aviso, consulte Códigos de erro/aviso do bíceps.

Próximos passos

Para percorrer um guia de início rápido, consulte Guia de início rápido: criar arquivos Bicep com o Visual Studio Code.