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.
Use a propriedade bicep.version em bicepconfig.json para declarar quais versões do compilador têm suporte de arquivos Bicep. Você pode exigir uma versão exata ou permitir um intervalo, ajudando sua equipe a manter o desenvolvimento local e as builds automatizadas consistentes.
A fixação de versão verifica qual compilador já está em execução. A configuração não baixa, instala nem altera, por si só, versões do compilador.
Defina um requisito de versão do compilador
Adicione uma bicep seção ao seu arquivo de configuração do Bicep:
{
"bicep": {
"version": "1.2.3"
}
}
Este exemplo permite apenas a versão 1.2.3. Para permitir um intervalo, use operadores de comparação:
{
"bicep": {
"version": ">=1.2.0, <2.0.0"
}
}
O intervalo permite versões iguais ou superiores a 1.2.0 e inferiores a 2.0.0.
Os números de versão neste artigo ilustram a sintaxe. Não são versões mínimas suportadas nem uma afirmação de que esses lançamentos estão disponíveis. Escolha versões publicadas do compilador que suportem o recurso e seus arquivos Bicep.
Se não houver um requisito de versão efetivo, o Bicep não realiza essa verificação de versão. Adicionar um requisito não altera as versões da API de recursos do seu modelo nem fixa as versões do registro de módulos.
Sintaxe de versões suportadas
Uma versão contém um, dois ou três componentes numéricos: major, minor e patch. Bicep compara os componentes numericamente, nessa ordem. Por exemplo, 1.10.0 é maior que 1.2.0.
| Syntax | Meaning |
|---|---|
1.2.3 ou =1.2.3 |
Exatamente 1.2.3. |
>1.2.3 |
Superior a 1.2.3, excluindo essa versão. |
>=1.2.3 |
Maior ou igual a 1.2.3. |
<2.0.0 |
Inferior a 2.0.0, excluindo essa versão. |
<=2.0.0 |
Menor que ou igual a 2.0.0. |
>=1.2.0, <2.0.0 |
Ambas as condições devem ser satisfeitas. |
Um intervalo de duas condições deve conter um limite inferior (> ou >=) e um limite superior (< ou <=). Separe-os com uma vírgula. Qualquer uma das ordens é aceita: <2.0.0, >=1.2.0 significa a mesma coisa que >=1.2.0, <2.0.0. Espaços ao redor das condições e entre um operador e sua versão são aceitos.
Versões abreviadas são exatas, não são curingas
Componentes ausentes assumem zero por padrão:
| Valor | Valor equivalente |
|---|---|
1 |
1.0.0 |
1.2 |
1.2.0 |
>=1.2, <2 |
>=1.2.0, <2.0.0 |
Em particular, "1.2" não permite cada versão de patch de 1.2. Para permitir esse intervalo, escreva ">=1.2.0, <1.3.0".
Sintaxe incompatível
Bicep usa sua própria sintaxe numérica de restrição de versão. Não presuma que expressões aceitas pelos gestores de pacotes também funcionam aqui.
| Formulário sem suporte | Examples |
|---|---|
| Wildcards |
*, 1.*, 1.2.x |
| Intervalos com caret ou tilde |
^1.2.3, ~1.2.3 |
| Condições alternativas ou de desigualdade |
1.2.3 || 2.0.0, !=1.2.3 |
| Intervalos com hífen ou intervalos |
1.2.0 - 2.0.0, [1.2.0,2.0.0) |
| Um prefixo de versão | v1.2.3 |
| Metadados de pré-lançamento ou de compilação em uma restrição de versão |
1.2.3-preview, 1.2.3+build |
| Limites inferiores ou superiores repetidos | >=1.0.0, >=1.2.0 |
| Uma versão exata combinada com outra condição | =1.2.3, <2.0.0 |
| Mais de duas condições | >=1.0.0, <2.0.0, <=1.9.0 |
| Zeros à esquerda ou mais de três componentes |
01.2.3, 1.2.3.4 |
| Uma cadeia de caracteres vazia | "" |
Uma expressão não suportada bicep.version faz com que o Bicep reporte BCP273, o erro existente para um arquivo de configuração Bicep inválido. Esse diagnóstico não é específico para restrições de versão. Por exemplo, "version": "^1.2.3" produz uma mensagem com contexto em nível de configuração seguida pela causa específica:
BCP273: Failed to parse the contents of the Bicep configuration file "file:///example/bicepconfig.json": The bicep.version property "^1.2.3" is not a valid Bicep version or version range.
Nesse caso, o JSON pode ser válido mesmo que a expressão de versão não seja suportada. Corrija o valor bicep.version.
Um intervalo pode ter sintaxe válida, mas não permitir nenhuma versão. Por exemplo, >=2.0.0, <1.0.0 passa na análise sintática, mas nenhuma versão numérica do compilador a satisfaz. Da mesma forma, nenhuma versão fica estritamente entre 1.2.3 e 1.2.4. Uma sintaxe válida também não garante que exista uma versão correspondente do Bicep.
Entenda o comportamento da CLI e do editor
O compilador verifica sua versão em execução com o requisito efetivo de cada arquivo fonte.
| Condition | Bicep CLI | Servidor de linguagem Bicep no editor |
|---|---|---|
| A versão em execução atende ao requisito | Sem diagnóstico de incompatibilidade de versão. | Sem diagnóstico de incompatibilidade de versão. |
| A versão em execução não atende ao requisito | BCP456, um erro que impede a compilação bem-sucedida. | BCP456, um aviso. |
| A versão em execução não pode ser analisada para comparação | BCP457, um aviso. | BCP457, um aviso. |
| Requisito configurado é inválido | BCP273, um erro de configuração. | BCP273, um erro de configuração. |
Um aviso do editor não significa que os mesmos arquivos são compilados com sucesso com uma CLI incompatível. O aviso permite continuar editando, mas você ainda precisa de um compilador compatível para a compilação.
O BCP457 significa que o requisito não pôde ser verificado, não que tenha sido aprovado. Outros erros do compilador e diagnósticos de linter ainda se aplicam, independentemente do resultado da verificação de versão.
Usar requisitos de versão em pastas e módulos
Cada arquivo .bicep ou .bicepparam encontra seu próprio arquivo bicepconfig.json mais próximo, começando na pasta do arquivo de origem e pesquisando pastas pai. A descoberta não começa na pasta atual do seu shell.
Um módulo local usa sua própria configuração mais próxima, não as configurações do pai já resolvidas. Um compilador cuida da compilação, então esse compilador deve atender a todos os requisitos aplicáveis. O Bicep não seleciona um executável diferente para cada módulo.
Por exemplo:
project\
bicepconfig.json
main.bicep
modules\
bicepconfig.json
storage.bicep
Se a configuração raiz requer >=1.0.0, <2.0.0 e a configuração do módulo requer >=1.5.0, <2.0.0, versões em >=1.5.0, <2.0.0 satisfazem ambos os requisitos. No entanto, o ponto de entrada ainda permite versões antigas que o módulo rejeita.
Duas novas regras de linter ajudam a identificar essas diferenças:
| Regra | Nível padrão | O que ela verifica |
|---|---|---|
| no-conflicting-version-constraints | Erro | Se o ponto de entrada e seus módulos locais têm uma versão permitida comum. |
| no-incompatible-entrypoint-version | Warning | Se todas as versões permitidas pelo ponto de entrada também são permitidas por cada módulo local restrito. |
Essas são verificações diferentes. Intervalos sobrepostos podem passar pela regra de conflito, mas falham na regra de compatibilidade de pontos de entrada, como no exemplo anterior. Restringir o requisito raiz a >=1.5.0, <2.0.0 resolve essa incompatibilidade.
As regras seguem referências locais module diretas e transitivas. Eles não escaneiam cada arquivo do seu repositório nem inspecionam os componentes internos do registro e do módulo de especificação de modelo. Eles não são um percurso geral de referências import ou .bicepparamusing. Cada regra relata sua primeira descoberta no início do documento do ponto de entrada e utiliza as configurações efetivas da regra do ponto de entrada.
Se o ponto de entrada não tiver requisito, mas um módulo local tem, a regra de compatibilidade de ponto de entrada alerta: o ponto de entrada poderia, de outra forma, permitir um compilador que o módulo rejeitasse. Um módulo sem requisito não impõe nenhuma restrição.
Herdar um requisito compartilhado
Arquivos de configuração da pasta pai não se mescam automaticamente. Para compartilhar configurações mantendo uma configuração mais semelhante, use herança de configuração.
Por exemplo, crie shared\bicepconfig.json:
{
"bicep": {
"version": ">=1.2.0, <2.0.0"
}
}
Em app\bicepconfig.json, expanda esse arquivo:
{
"extends": "../shared/bicepconfig.json"
}
O aplicativo herda o requisito compartilhado. Se o app fornecer sua própria cadeia não nulabicep.version, essa cadeia substitui o requisito herdado; Bicep não intersecta as duas cadeias:
{
"extends": "../shared/bicepconfig.json",
"bicep": {
"version": "1.5.0"
}
}
O requisito efetivo é exatamente 1.5.0. Omitir a propriedade preserva o valor herdado. Configurar como null não elimina um requisito herdado de não-nulo. Para remover um requisito herdado, mude a configuração base ou a estrutura de herança.
Tente uma verificação de versão
Os passos a seguir usam a CLI Bicep independente, não o CLI do Azure ou o Azure PowerShell.
Verifique diretamente o compilador que você invoca:
bicep --versionCrie um
bicepconfig.jsonarquivo ao lado do seu arquivo de teste e definabicep.versionpara a versão numérica reportada pelo compilador instalado. O compilador deve suportar essa configuração.Criar
main.bicep:output message string = 'Version requirement example'Compile o arquivo:
bicep build .\main.bicepUma versão compatível não produz diagnóstico BCP456. A saída é
main.json.Mude o requisito configurado para excluir sua versão em execução e então execute a build novamente.
O build é relatado como um erro BCP456. Quando o compilador do servidor de linguagem do editor não atende ao requisito, ele reporta o BCP456 como um aviso.
Verifique o compilador usado pela ferramenta que reporta o diagnóstico. Seu editor e ferramentas de linha de comando podem usar diferentes instalações do Bicep. O bicep --version comando descreve o executável resolvido por esse comando, não todas as ferramentas do seu computador.
Configure as regras de compatibilidade
Use a configuração do linter existente para alterar o nível de cada regra:
{
"analyzers": {
"core": {
"rules": {
"no-conflicting-version-constraints": {
"level": "error"
},
"no-incompatible-entrypoint-version": {
"level": "warning"
}
}
}
}
}
Os níveis suportados são error, warning, info, e off. Essas configurações controlam a severidade das duas regras de compatibilidade.
Solucionar problemas de requisitos de versão
| Diagnóstico ou sintoma | Action |
|---|---|
| BCP273 | Leia o erro detalhado de configuração. Caso ele identifique bicep.version, corrija a restrição usando uma versão numérica ou intervalo compatível. O BCP273 também pode relatar outros problemas de configuração. |
| BCP456 | Use um compilador que satisfaça o requisito ou atualize deliberadamente o requisito após verificar a compatibilidade. Leia a mensagem para localizar a configuração em que ela foi declarada. |
| BCP457 | Use um compilador cuja versão reportada possa ser analisada. Não trate o aviso como uma verificação de compatibilidade bem-sucedida. |
| Restrições de versão conflitantes | Alinhe os requisitos do ponto de entrada e do módulo local para que exista uma versão comum. |
| Requisito de ponto de entrada incompatível | Restrinja o intervalo do ponto de entrada, ou atualize requisitos do módulo após verificar a compatibilidade; assim, toda versão permitida do ponto de entrada funciona para os módulos. |
| Editor e CLI discordam | Verifique as versões do compilador usadas por cada ferramenta e a configuração mais próxima para o arquivo afetado. |
Se as restrições entrarem em conflito, instalar outro compilador sozinho não resolve o problema: nenhuma versão individual atende a todos os requisitos declarados.