Comandi dell'interfaccia della riga di comando di Bicep

Articolo
01/03/2024

Questo articolo descrive i comandi che è possibile usare nell'interfaccia della riga di comando di Bicep. Sono disponibili due opzioni per l'esecuzione di questi comandi: usando l'interfaccia della riga di comando di Azure o richiamando direttamente i comandi dell'interfaccia della riga di comando di Bicep. Ogni metodo richiede un processo di installazione distinto. Per altre informazioni, vedere Installare l'interfaccia della riga di comando di Azure e Installare Azure PowerShell.

Questo articolo illustra come eseguire i comandi nell'interfaccia della riga di comando di Azure. Quando si esegue l'interfaccia della riga di comando di Azure, si avviano i comandi con az. Se non si usa l'interfaccia della riga di comando di Azure, eseguire i comandi senza az all'avvio del comando. Ad esempio, az bicep build diventa bicep builde az bicep version diventa bicep --version.

build

Il build comando converte un file Bicep in un modello di Azure Resource Manager (modello arm). In genere, non è necessario eseguire questo comando perché viene eseguito automaticamente quando si distribuisce un file Bicep. Eseguirlo manualmente quando si vuole visualizzare il codice JSON del modello arm creato dal file Bicep.

L'esempio seguente converte un file Bicep denominato main.bicep in un modello di Resource Manager denominato main.json. Il nuovo file viene creato nella stessa directory del file Bicep.

az bicep build --file main.bicep

L'esempio seguente salva main.json in una directory diversa.

az bicep build --file main.bicep --outdir c:\jsontemplates

Nell'esempio seguente viene specificato il nome e il percorso del file da creare.

az bicep build --file main.bicep --outfile c:\jsontemplates\azuredeploy.json

Per stampare il file in stdout, usare:

az bicep build --file main.bicep --stdout

Se il file Bicep include un modulo che fa riferimento a un registro esterno, il comando di compilazione chiama automaticamente il ripristino. Il comando restore ottiene il file dal Registro di sistema e lo archivia nella cache locale.

Nota

Il comando restore non aggiorna la cache. Per altre informazioni, vedere Ripristino.

Per non chiamare automaticamente il ripristino, usare l'opzione --no-restore :

az bicep build --no-restore <bicep-file>

Il processo di compilazione con l'opzione --no-restore ha esito negativo se uno dei moduli esterni non è già memorizzato nella cache:

The module with reference "br:exampleregistry.azurecr.io/bicep/modules/storage:v1" has not been restored.

Quando viene visualizzato questo errore, eseguire il build comando senza l'opzione --no-restore o eseguire bicep restore prima.

Per usare l'opzione, è necessario avere l'interfaccia della --no-restore riga di comando di Bicep versione 0.4.X o successiva.

parametri di compilazione

Il build-params comando compila un file con estensione bicepparam in un file di parametri JSON.

az bicep build-params --file params.bicepparam

Questo comando converte un file di parametri params.bicepparam in un file di parametri JSON params.json .

Decompilare

Il decompile comando converte il codice JSON del modello di Resource Manager in un file Bicep.

az bicep decompile --file main.json

Il comando crea un file denominato main.bicep nella stessa directory di main.json. Se main.bicep esiste nella stessa directory, usare l'opzione --force per sovrascrivere il file Bicep esistente.

Per altre informazioni sull'uso di questo comando, vedere Decompilazione di JSON del modello arm in Bicep.

decompile-params

Il decompile-params comando decompila un file di parametri JSON in un file di parametri con estensione bicepparam .

az bicep decompile-params --file azuredeploy.parameters.json --bicep-file ./dir/main.bicep

Questo comando decompila un file di parametri azuredeploy.parameters.json in un file azuredeploy.parameters.bicepparam . --bicep-file specifica il percorso del file Bicep (relativo al file con estensione bicepparam) a cui viene fatto riferimento nella using dichiarazione.

format

Il format comando formatta un file Bicep. Ha la stessa funzione del SHIFT+ALT+F collegamento in Visual Studio Code.

az bicep format --file main.bicep

generate-params

Il generate-params comando compila un file di parametri dal file Bicep specificato, aggiorna se è presente un file di parametri esistente.

az bicep generate-params --file main.bicep --output-format bicepparam --include-params all

Il comando crea un file di parametri Bicep denominato main.bicepparam. Il file di parametri contiene tutti i parametri nel file Bicep, se configurati con valori predefiniti o meno.

az bicep generate-params --file main.bicep --outfile main.parameters.json

Il comando crea un file di parametri denominato main.parameters.json. Il file di parametri contiene solo i parametri senza valori predefiniti configurati nel file Bicep.

installazione

Il install comando aggiunge l'interfaccia della riga di comando di Bicep all'ambiente locale. Per altre informazioni, vedere Installare gli strumenti Bicep. Questo comando è disponibile solo tramite l'interfaccia della riga di comando di Azure.

Per installare la versione più recente, usare:

az bicep install

Per installare una versione specifica:

az bicep install --version v0.3.255

Lint

Il lint comando restituisce gli errori e le violazioni della regola linter di un file Bicep.

az bicep lint --file main.bicep

Se il file Bicep include un modulo che fa riferimento a un registro esterno, il comando lint chiama automaticamente il ripristino. Il comando restore ottiene il file dal Registro di sistema e lo archivia nella cache locale.

Nota

Il comando restore non aggiorna la cache. Per altre informazioni, vedere Ripristino.

Per non chiamare automaticamente il ripristino, usare l'opzione --no-restore :

az bicep lint --no-restore <bicep-file>

Il processo lint con l'opzione --no-restore ha esito negativo se uno dei moduli esterni non è già memorizzato nella cache:

The module with reference "br:exampleregistry.azurecr.io/bicep/modules/storage:v1" has not been restored.

Quando viene visualizzato questo errore, eseguire il lint comando senza l'opzione --no-restore o eseguire bicep restore prima.

list-versions

Il list-versions comando restituisce tutte le versioni disponibili dell'interfaccia della riga di comando di Bicep. Usare questo comando per verificare se si vuole aggiornareo installare una nuova versione. Questo comando è disponibile solo tramite l'interfaccia della riga di comando di Azure.

az bicep list-versions

Il comando restituisce una matrice di versioni disponibili.

[
  "v0.20.4",
  "v0.19.5",
  "v0.18.4",
  "v0.17.1",
  "v0.16.2",
  "v0.16.1",
  "v0.15.31",
  "v0.14.85",
  "v0.14.46",
  "v0.14.6",
  "v0.13.1",
  "v0.12.40",
  "v0.12.1",
  "v0.11.1",
  "v0.10.61",
  "v0.10.13",
  "v0.9.1",
  "v0.8.9",
  "v0.8.2",
  "v0.7.4",
  "v0.6.18",
  "v0.6.11",
  "v0.6.1",
  "v0.5.6",
  "v0.4.1318",
  "v0.4.1272",
  "v0.4.1124",
  "v0.4.1008",
  "v0.4.613",
  "v0.4.451"
]

Pubblica...

Il publish comando aggiunge un modulo a un registro. Il Registro Azure Container deve esistere e la pubblicazione dell'account nel Registro di sistema deve disporre delle autorizzazioni corrette. Per altre informazioni sulla configurazione di un registro dei moduli, vedere Usare il Registro di sistema privato per i moduli Bicep. Per pubblicare un modulo, l'account deve disporre del profilo corretto e delle autorizzazioni per accedere al Registro di sistema. È possibile configurare la precedenza del profilo e delle credenziali per l'autenticazione nel Registro di sistema nel file di configurazione Bicep.

Dopo aver pubblicato il file nel Registro di sistema, è possibile farvi riferimento in un modulo.

Per usare il comando publish, è necessario avere l'interfaccia della riga di comando di Bicep versione 0.14.X o successiva. Per usare il --documentationUri/-d parametro , è necessario avere l'interfaccia della riga di comando di Bicep versione 0.14.X o successiva.

Per pubblicare un modulo in un registro, usare:

az bicep publish --file <bicep-file> --target br:<registry-name>.azurecr.io/<module-path>:<tag> --documentationUri <documentation-uri>

Ad esempio:

az bicep publish --file storage.bicep --target br:exampleregistry.azurecr.io/bicep/modules/storage:v1 --documentationUri https://www.contoso.com/exampleregistry.html

Il publish comando non riconosce gli alias specificati in un file bicepconfig.json . Specificare il percorso completo del modulo.

Avviso

La pubblicazione nella stessa destinazione sovrascrive il modulo precedente. È consigliabile incrementare la versione durante l'aggiornamento.

ripristinare

Quando il file Bicep usa moduli pubblicati in un Registro di sistema, il restore comando ottiene copie di tutti i moduli necessari dal Registro di sistema. Archivia tali copie in una cache locale. Un file Bicep può essere compilato solo quando i file esterni sono disponibili nella cache locale. In genere, l'esecuzione del ripristino non è necessaria perché viene attivata automaticamente dal processo di compilazione.

Per ripristinare i moduli esterni nella cache locale, l'account deve disporre del profilo corretto e delle autorizzazioni per accedere al Registro di sistema. È possibile configurare la precedenza del profilo e delle credenziali per l'autenticazione nel Registro di sistema nel file di configurazione Bicep.

Per usare il comando restore, è necessario avere l'interfaccia della riga di comando di Bicep versione 0.4.X o successiva. Questo comando è attualmente disponibile solo quando si chiama direttamente l'interfaccia della riga di comando di Bicep. Non è attualmente disponibile tramite il comando dell'interfaccia della riga di comando di Azure.

Per ripristinare manualmente i moduli esterni per un file, usare:

az bicep restore --file <bicep-file> [--force]

Il file Bicep specificato è il file da distribuire. Deve contenere un modulo che si collega a un registro. Ad esempio, è possibile ripristinare il file seguente:

module stgModule 'br:exampleregistry.azurecr.io/bicep/modules/storage:v1' = {
  name: 'storageDeploy'
  params: {
    storagePrefix: 'examplestg1'
  }
}

La cache locale si trova in:

In Windows

%USERPROFILE%\.bicep\br\<registry-name>.azurecr.io\<module-path\<tag>

In Linux
```
/home/<username>/.bicep
```
In Mac
```
~/.bicep
```

Il restore comando non aggiorna la cache se un modulo è già memorizzato nella cache. Per aggiornare la cache, è possibile eliminare il percorso del modulo dalla cache o usare l'opzione --force con il restore comando .

upgrade

Il upgrade comando aggiorna la versione installata con la versione più recente. Questo comando è disponibile solo tramite l'interfaccia della riga di comando di Azure.

az bicep upgrade

Versione

Il version comando restituisce la versione installata.

az bicep version

Il comando mostra il numero di versione.

Bicep CLI version 0.22.6 (d62b94db31)

Per chiamare questo comando direttamente tramite l'interfaccia della riga di comando di Bicep, usare:

bicep --version

Se l'interfaccia della riga di comando di Bicep non è stata installata, verrà visualizzato un messaggio di errore che informa che l'interfaccia della riga di comando di Bicep non è stata trovata.

Passaggi successivi

Per informazioni sulla distribuzione di un file Bicep, vedere: