Bicep CLI-parancsok

Cikk
01/03/2024

Ez a cikk a Bicep CLI-ben használható parancsokat ismerteti. A parancsok végrehajtására két lehetősége van: az Azure CLI használatával vagy a Bicep CLI-parancsok közvetlen meghívásával. Minden metódushoz külön telepítési folyamat szükséges. További információ: Az Azure CLI telepítése és az Azure PowerShell telepítése.

Ez a cikk bemutatja, hogyan futtathatja a parancsokat az Azure CLI-ben. Az Azure CLI futtatásakor a parancsokat a következővel azindíthatja el: . Ha nem az Azure CLI-t használja, futtassa a parancsokat a parancs elején.az Például lesz bicep build, az bicep build és az bicep version leszbicep --version.

build

A build parancs egy Bicep-fájlt Azure Resource Manager-sablonná (ARM-sablonná) alakít át. Általában nem kell futtatnia ezt a parancsot, mert automatikusan fut a Bicep-fájlok telepítésekor. Futtassa manuálisan, ha meg szeretné tekinteni a Bicep-fájlból létrehozott ARM-sablon JSON-t.

Az alábbi példa egy main.bicep nevű Bicep-fájlt konvertál egy main.json nevű ARM-sablonná. Az új fájl ugyanabban a könyvtárban jön létre, mint a Bicep-fájl.

az bicep build --file main.bicep

A következő példa a main.json fájlt egy másik könyvtárba menti.

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

A következő példa a létrehozandó fájl nevét és helyét adja meg.

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

A fájl nyomtatásához használja a következőt stdout:

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

Ha a Bicep-fájl tartalmaz egy külső beállításjegyzékre hivatkozó modult, a buildelési parancs automatikusan meghívja a visszaállítást. A visszaállítási parancs lekéri a fájlt a beállításjegyzékből, és a helyi gyorsítótárban tárolja.

Megjegyzés:

A visszaállítási parancs nem frissíti a gyorsítótárat. További információ: visszaállítás.

Ha nem szeretné automatikusan meghívni a visszaállítást, használja a kapcsolót --no-restore :

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

A kapcsolóval történő --no-restore létrehozási folyamat meghiúsul, ha az egyik külső modul még nincs gyorsítótárazva:

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

Ha ezt a hibát kapja, futtassa a build parancsot a --no-restore kapcsoló nélkül, vagy futtassa bicep restore először.

A kapcsoló használatához a --no-restore Bicep CLI 0.4.X-es vagy újabb verziójával kell rendelkeznie.

build-params

A build-params parancs létrehoz egy .bicepparam fájlt egy JSON-paraméterfájlba.

az bicep build-params --file params.bicepparam

Ez a parancs params.bicepparam paraméterfájlt konvertál params.json JSON paraméterfájllá.

Visszafordítani

A decompile parancs bicep fájllá alakítja az ARM-sablon JSON-fájlját.

az bicep decompile --file main.json

A parancs létrehoz egy main.bicep nevű fájlt ugyanabban a könyvtárban, mint a main.json. Ha a main.bicep ugyanabban a könyvtárban található, a --force kapcsolóval írja felül a meglévő Bicep-fájlt.

A parancs használatával kapcsolatos további információkért tekintse meg az ARM-sablon JSON-ra való lebontását a Bicep-be.

dekompile-params

A decompile-params parancs egy JSON-paraméterfájlt egy .bicepparam paraméterfájlra bont.

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

Ez a parancs egy azuredeploy.parameters.json paraméterfájlt egy azuredeploy.parameters.bicepparam fájlba bont. --bicep-file megadja a deklarációban using hivatkozott Bicep-fájl elérési útját (a .bicepparam fájlhoz képest).

format

A format parancs Bicep-fájlt formáz. Ugyanazzal a funkcióval rendelkezik, mint a SHIFT+ALT+F Visual Studio Code parancsikonja.

az bicep format --file main.bicep

generate-params

A generate-params parancs létrehoz egy paraméterfájlt az adott Bicep-fájlból, és frissíti, ha van meglévő paraméterfájl.

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

A parancs létrehoz egy Bicep-paraméterfájlt main.bicepparam néven. A paraméterfájl tartalmazza a Bicep-fájl összes paraméterét, akár alapértelmezett értékekkel van konfigurálva, akár nem.

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

A parancs létrehoz egy main.parameters.json nevű paraméterfájlt. A paraméterfájl csak a Bicep-fájlban konfigurált alapértelmezett értékek nélküli paramétereket tartalmazza.

telepítés

A install parancs hozzáadja a Bicep CLI-t a helyi környezethez. További információ: Bicep-eszközök telepítése. Ez a parancs csak az Azure CLI-vel érhető el.

A legújabb verzió telepítéséhez használja a következőt:

az bicep install

Egy adott verzió telepítése:

az bicep install --version v0.3.255

Tépés

A lint parancs visszaadja egy Bicep-fájl hibáit és linterszabály-megsértését .

az bicep lint --file main.bicep

Ha a Bicep-fájl tartalmaz egy külső beállításjegyzékre hivatkozó modult, a lint parancs automatikusan meghívja a visszaállítást. A visszaállítási parancs lekéri a fájlt a beállításjegyzékből, és a helyi gyorsítótárban tárolja.

Megjegyzés:

A visszaállítási parancs nem frissíti a gyorsítótárat. További információ: visszaállítás.

Ha nem szeretné automatikusan meghívni a visszaállítást, használja a kapcsolót --no-restore :

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

A kapcsolóval történő --no-restore lint folyamat meghiúsul, ha az egyik külső modul még nincs gyorsítótárazva:

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

Ha ezt a hibát kapja, futtassa a lint parancsot a --no-restore kapcsoló nélkül, vagy futtassa bicep restore először.

listaverziók

A list-versions parancs a Bicep CLI összes elérhető verzióját visszaadja. Ezzel a paranccsal ellenőrizheti, hogy frissíteni vagy telepíteni szeretné-e az új verziót. Ez a parancs csak az Azure CLI-vel érhető el.

az bicep list-versions

A parancs az elérhető verziók tömbét adja vissza.

[
  "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"
]

publish

A publish parancs hozzáad egy modult egy beállításjegyzékhez. Az Azure-tárolóregisztrációs adatbázisnak léteznie kell, és a beállításjegyzékben közzétevő fióknak megfelelő engedélyekkel kell rendelkeznie. A modulregisztrációs adatbázis beállításáról további információt a Privát beállításjegyzék használata Bicep-modulokhoz című témakörben talál. Modul közzétételéhez a fióknak a megfelelő profillal és engedélyekkel kell rendelkeznie a beállításjegyzék eléréséhez. A bicep konfigurációs fájlban konfigurálhatja a profilt és a hitelesítő adatokat a beállításjegyzékbe való hitelesítéshez.

Miután közzétette a fájlt a beállításjegyzékben, egy modulban hivatkozhat rá.

A közzétételi parancs használatához a Bicep CLI 0.14.X-es vagy újabb verziójával kell rendelkeznie. A paraméter használatához a --documentationUri/-d Bicep CLI 0.14.X-es vagy újabb verziójával kell rendelkeznie.

Modul beállításjegyzékben való közzétételéhez használja a következőt:

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

Például:

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

A publish parancs nem ismeri fel a bicepconfig.json fájlban megadott aliasokat. Adja meg a teljes modul elérési útját.

Figyelmeztetés

Az ugyanahhoz a célhoz való közzététel felülírja a régi modult. Javasoljuk, hogy frissítéskor növelje a verziót.

restore

Amikor a Bicep-fájl egy beállításjegyzékben közzétett modulokat használ, a restore parancs lekéri az összes szükséges modul másolatát a beállításjegyzékből. Ezeket a másolatokat egy helyi gyorsítótárban tárolja. Bicep-fájl csak akkor hozható létre, ha a külső fájlok elérhetők a helyi gyorsítótárban. A visszaállítás futtatása általában nem szükséges, mivel azt a buildelési folyamat automatikusan aktiválja.

A külső modulok helyi gyorsítótárba való visszaállításához a fióknak a megfelelő profillal és engedélyekkel kell rendelkeznie a beállításjegyzék eléréséhez. A bicep konfigurációs fájlban konfigurálhatja a profilt és a hitelesítő adatokat a beállításjegyzékbe való hitelesítéshez.

A visszaállítási parancs használatához a Bicep CLI 0.4.X-es vagy újabb verziójával kell rendelkeznie. Ez a parancs jelenleg csak akkor érhető el, ha közvetlenül meghívja a Bicep CLI-t. Jelenleg nem érhető el az Azure CLI-paranccsal.

A fájl külső moduljainak manuális visszaállításához használja a következőt:

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

A megadott Bicep-fájl az üzembe helyezni kívánt fájl. Tartalmaznia kell egy olyan modult, amely egy beállításjegyzékre hivatkozik. Visszaállíthatja például a következő fájlt:

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

A helyi gyorsítótár a következő helyen található:

Windows rendszeren

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

Linuxon
```
/home/<username>/.bicep
```
Mac gépen
```
~/.bicep
```

A restore parancs nem frissíti a gyorsítótárat, ha egy modul már gyorsítótárazott. A gyorsítótár frissítéséhez törölheti a modul elérési útját a gyorsítótárból, vagy használhatja a --force kapcsolót a restore paranccsal.

upgrade

A upgrade parancs frissíti a telepített verziót a legújabb verzióval. Ez a parancs csak az Azure CLI-vel érhető el.

az bicep upgrade

Verzió

A version parancs visszaadja a telepített verziót.

az bicep version

A parancs a verziószámot jeleníti meg.

Bicep CLI version 0.22.6 (d62b94db31)

Ha közvetlenül a Bicep parancssori felületén keresztül szeretné meghívni ezt a parancsot, használja a következőt:

bicep --version

Ha a Bicep CLI nincs telepítve, hibaüzenet jelenik meg, amely szerint a Bicep CLI nem található.

További lépések

A Bicep-fájlok üzembe helyezéséről az alábbiakban olvashat: