Observação
O acesso a essa página exige autorização. Você pode tentar entrar ou alterar diretórios.
O acesso a essa página exige autorização. Você pode tentar alterar os diretórios.
O Bicep dá suporte a um arquivo de configuração chamado bicepconfig.json. Dentro desse arquivo, você pode adicionar valores que personalizam sua experiência de desenvolvimento do Bicep. Esse arquivo é mesclado com o arquivo de configuração padrão. Para obter mais informações, confira Noções básicas sobre o processo de mesclagem. Para personalizar uma configuração, crie um arquivo de configuração no mesmo diretório ou em um diretório pai dos seus arquivos Bicep, ou passe um caminho de arquivo de configuração ao executar comandos da CLI do Bicep com --config. Se houver vários diretórios pai contendo arquivos bicepconfig.json, o Bicep usará a configuração do mais próximo. Para obter mais informações, confira Noções básicas sobre o processo de resolução de arquivos.
Para definir as configurações de extensão do Bicep, consulte a extensão VS Code e Bicep.
Criar o arquivo de configuração no Visual Studio Code
Você pode usar qualquer editor de texto para criar o arquivo de configuração.
Para criar um arquivo bicepconfig.json no Visual Studio Code, abra a Paleta de Comandos ([CTRL/CMD]+[SHIFT]+P) e, depois, selecione Bicep: criar arquivo de configuração do Bicep. Para obter mais informações, confira Criar arquivo de configuração Bicep.
A extensão do Bicep para Visual Studio Code dá suporte ao IntelliSense para arquivos bicepconfig.json. Use o intelliSense para descobrir propriedades e valores disponíveis.
Entender o processo de mesclagem
O arquivo bicepconfig.json passa por um processo de mesclagem de baixo para cima recursivo com o arquivo de configuração padrão. Durante o processo de mesclagem, o Bicep examina cada caminho em ambas as configurações. Se um caminho não estiver presente na configuração padrão, o caminho e seu valor associado serão adicionados ao resultado final. Por outro lado, se houver um caminho na configuração padrão com um valor diferente, o valor de bicepconfig.json terá precedência no resultado mesclado.
Considere um cenário em que a configuração padrão é definida da seguinte maneira:
{
"cloud": {
...
"credentialPrecedence": [
"AzureCLI",
"AzurePowerShell"
]
},
"moduleAliases": {
"ts": {},
"br": {
"public": {
"registry": "mcr.microsoft.com",
"modulePath": "bicep"
}
}
},
...
}
E o bicepconfig.json é definido da seguinte maneira:
{
"cloud": {
"credentialPrecedence": [
"AzurePowerShell",
"AzureCLI"
]
},
"moduleAliases": {
"br": {
"ContosoRegistry": {
"registry": "contosoregistry.azurecr.io"
},
"CoreModules": {
"registry": "contosoregistry.azurecr.io",
"modulePath": "bicep/modules/core"
}
}
}
}
A configuração mesclada resultante seria:
{
"cloud": {
...
"credentialPrecedence": [
"AzurePowerShell",
"AzureCLI"
]
},
"moduleAliases": {
"ts": {},
"br": {
"public": {
"registry": "mcr.microsoft.com",
"modulePath": "bicep"
},
"ContosoRegistry": {
"registry": "contosoregistry.azurecr.io"
},
"CoreModules": {
"registry": "contosoregistry.azurecr.io",
"modulePath": "bicep/modules/core"
}
}
},
...
}
No exemplo anterior, o valor de cloud.credentialPrecedence é substituído, enquanto os valores de cloud.moduleAliases.ContosoRegistry e cloud.moduleAliases.CoreModules são acrescentados na configuração mesclada.
Entender o processo de resolução de arquivos
O arquivo bicepconfig.json pode ser colocado no mesmo diretório ou em um diretório pai dos arquivos Bicep. Se houver vários diretórios pai contendo arquivos bicepconfig.json, o Bicep usará o arquivo de configuração do mais próximo. Por exemplo, na estrutura de pasta fornecida em que cada pasta tem um arquivo bicepconfig.json:
Se você compilar main.bicep na pasta child, o arquivo bicepconfig.json da pasta child será usado. Os arquivos de configuração na pasta parent e na pasta root são ignorados. Se a pasta child não contiver um arquivo de configuração, o Bicep procurará uma configuração na pasta parent e, em seguida, na pasta root. Se nenhum arquivo de configuração for encontrado em nenhuma das pastas, o Bicep usará os valores padrão.
No contexto de um arquivo Bicep invocando vários módulos, cada módulo passa por compilação usando o bicepconfig.json mais próximo. Em seguida, o arquivo Bicep principal é compilado com seu bicepconfig.json correspondente. No cenário a seguir, modA.bicep é compilado usando o bicepconfig.json localizado na pasta A, modB.bicep é compilado com o bicepconfig.json na pasta B e, por fim, main.bicep é compilado usando o bicepconfig.json na pasta root.
Na ausência de um arquivo bicepconfig.json nas pastas A e B, todos os três arquivos Bicep são compilados usando o bicepconfig.json encontrado na pasta root. Se bicepconfig.json não estiver presente em nenhuma das pastas, o processo de compilação usará os valores padrão.
Configurar os requisitos de versão do compilador
Use bicep.version em bicepconfig.json para declarar uma versão exata do compilador ou um intervalo permitido. O Bicep verifica o compilador em execução com esse requisito; a configuração não instala nem alterna versões.
Para sintaxe suportada, exemplos, comportamento da CLI e do editor, e solução de problemas, veja Configurar requisitos de versão do compilador Bicep.
Especifique um arquivo de configuração na CLI do Bicep
A partir do Bicep CLI v0.49, você pode passar --config <path> para comandos da CLI do Bicep para usar um arquivo de configuração específico em vez da descoberta automática de bicepconfig.json. Essa opção é útil quando você precisa de configurações específicas do ambiente (como registros de módulos separados para teste e produção) ou uma configuração central em um pipeline CI/CD.
<path> pode ser um caminho de arquivo local absoluto ou relativo com qualquer nome de arquivo. Quando você especifica --config, o Bicep usa esse arquivo para cada arquivo fonte carregado durante o comando — incluindo o arquivo de entrada, módulos locais referenciados e o using destino de um .bicepparam arquivo. Quaisquer arquivos bicepconfig.json na hierarquia de diretórios são ignorados, a menos que o arquivo de configuração especificado herde deles com extends.
O exemplo a seguir usa bicepconfig.prod.json para estender um arquivo base bicepconfig.json e sobrescrever um alias de registro de módulo para uma build de produção:
{
"extends": "./bicepconfig.json",
"moduleAliases": {
"br": {
"shared": {
"registry": "contosoprodregistry.azurecr.io",
"modulePath": "bicep/modules"
}
}
}
}
Execute bicep build ou bicep lint com --config para aplicar o arquivo de configuração:
bicep build ./main.bicep --config ./bicepconfig.prod.json
bicep lint ./services/api/main.bicep --config ./eng/common/bicepconfig.json
Ao usar --config, tenha em mente estes comportamentos:
-
Comandos suportados:
build,build-params,lint,format,publish,publish-extension,restore,generate-params,snapshot,test,local-deploy,docs generate,deploy,what-if,teardown, econsole. -
Erro de arquivo ausente: Se o arquivo em
<path>não existir, o comando falha imediatamente comCould not find configuration file "<path>".em vez de voltar para descoberta de diretórios. -
Comportamento do editor: A
--configopção se aplica apenas aos comandos Bicep CLI. A extensão Bicep para Visual Studio Code continua a usar a descoberta automática de bicepconfig.json. -
CLI do Azure:
az bicepcomandos comoaz bicep buildainda não têm suporte para--config. Useaz bicep run(CLI do Azure 2.88.0 ou posterior) para passar o comando diretamente para a CLI do Bicep, por exemploaz bicep run --command "build main.bicep --config ./bicepconfig.prod.json". A CLI do Bicep que o CLI do Azure usa deve ser v0.49 ou posterior. Para atualizá-lo, executeaz bicep upgrade.
Configurar módulos do Bicep
Ao trabalhar com módulos, é possível adicionar aliases para caminhos de módulo. Esses aliases simplificam o arquivo Bicep porque você não precisa repetir caminhos complicados. Você também pode configurar a precedência de credencial para autenticação no Azure por meio da CLI do Bicep e do Visual Studio Code. As credenciais são usadas para publicar módulos em registries e restaurar módulos externos para o cache local ao usar a função insert resource. Para obter mais informações, consulte Adicionar configurações de módulo à configuração do Bicep.
Configurar regras do Linter
O linter Bicep verifica arquivos Bicep em busca de erros de sintaxe e violações de melhores práticas. Você pode modificar um arquivo bicepconfig.json para sobrescrever as configurações padrão de como um arquivo Bicep é validado. Para obter mais informações, consulte Adicionar configurações de linter à configuração do Bicep.
Habilitar recursos experimentais
Você pode habilitar recursos experimentais adicionando a seção a seguir ao arquivo bicepconfig.json. O uso de recursos experimentais habilita automaticamente a geração de código da linguagem versão 2.0.
Aviso
O Suporte ao Cliente da Microsoft não fornece assistência para problemas resultantes do uso de recursos experimentais do Bicep; use-os por sua conta e risco.
Aqui está um exemplo de como habilitar os recursos 'assertions' e 'testFramework'.
{
"experimentalFeaturesEnabled": {
"assertions": true,
"testFramework": true
}
}
Consulte Recursos Experimentais para obter mais informações sobre os recursos experimentais do Bicep.
Próximas etapas
- Saiba como adicionar configurações de módulo e configurações de linter no arquivo de configuração Bicep.
- Saiba mais sobre o linter do Bicep.