Bicep CLI-parancsok

Cikk
01/11/2025

Ez a cikk a Bicep CLI-ben használható parancsokat ismerteti. Ezeket a parancsokat az Azure CLI használatával vagy a Bicep CLI-parancsok közvetlen meghívásával hajthatja végre. Minden metódushoz külön telepítési folyamat szükséges. A telepítésekkel kapcsolatos további információkért tekintse meg az Azure CLI-t és az Azure PowerShellt.

Ez az útmutató bemutatja, hogyan futtathatja a parancsokat az Azure CLI-ben. Amikor parancsokat futtat az Azure CLI-ben, indítsa el őket a következővel az: . Ha nem az Azure CLI-t használja, futtassa a parancsokat az egyes parancsok az elején. Például lesz bicep build, az bicep build és az bicep version leszbicep --version.

build

A build parancs egy Bicep-fájlt JSON 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 JSON ARM-sablont.

Az alábbi Bicep-funkciók bármelyikének használata automatikusan engedélyezi a 2.0-s verziójú kódgenerálást:

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 egy másik könyvtárba menti a main.json :

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 parancs automatikusan meghívja azokat buildrestore. A restore parancs lekéri a fájlt a beállításjegyzékből, és a helyi gyorsítótárban tárolja.

Feljegyzés

A restore 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" hasn't 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 átalakít egy params.bicepparam paraméterfájlt egy params.json JSON-paraméterfájllá.

Visszafordítani

A decompile parancs egy JSON ARM-sablont Bicep-fájllá konvertál:

az bicep decompile --file main.json

Ez a parancs létrehoz egy main.bicep nevű fájlt ugyanabban a könyvtárban, mint 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 lásd : Decompile JSON ARM-sablon a Bicep-be.

dekompile-params

A decompile-params parancs egy JSON-paraméterfájlt egy paraméterfájlra .bicepparam 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-filea deklarációban using hivatkozott Bicep-fájl elérési útját adja meg (a .bicepparam fájlhoz viszonyítva).

format

A format parancs bicep-fájlokat 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

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

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

Ez 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, és csak az Azure CLI-vel érhető el. További információ: Bicep-eszközök telepítése.

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

jsonrpc

A jsonrpc parancs lehetővé teszi a Bicep CLI JSON-RPC felülettel való futtatását, lehetővé téve a strukturált kimenettel való programozott interakciót, és elkerülheti a hidegindítási késleltetést több fájl összeállításakor. Ez a beállítás támogatja a kódtárak készítését is, hogy programozott módon használják a Bicep-fájlokat non-.NET nyelvekben.

A bemenet/kimenet küldéséhez és fogadásához használt drótformátum fejlécre van tagolt, a következő szerkezettel, ahol \r és amelyek a kocsivissza- és \n vonalbetöltési karaktereket jelölik:

Content-Length: <length>\r\n\r\n<message>\r\n\r\n

<length> a sztring <message> hossza, beleértve a záró karaktert \r\n\r\nis.
<message> A nyers JSON-üzenet.

Példa:

Content-Length: 72\r\n\r\n{"jsonrpc": "2.0", "id": 0, "method": "bicep/version", "params": {}}\r\n\r\n

Az alábbi üzenet egy bicep-verzióra vonatkozó példát mutat be.

A bemenet:

{
  "jsonrpc": "2.0",
  "id": 0,
  "method": "bicep/version",
  "params": {}
}

A kimenet:

{
  "jsonrpc": "2.0",
  "id": 0,
  "result": {
    "version": "0.24.211"
  }
}

A rendelkezésre álló metódusok > kérés-/választestekért lásd: ICliJsonRpcProtocol.cs. Egy példa JSONRPC-kapcsolat létrehozására és a Bicep-fájlokkal programozott módon a Node használatával való interakcióra jsonrpc.test.ts: .

Névvel ellátott cső használata

Az alábbi szintaxissal csatlakozhat egy meglévő elnevezett csőhöz JSONRPC-ügyfélként:

bicep jsonrpc --pipe <named_pipe>`

<named_pipe> egy meglévő nevesített cső, amellyel csatlakoztathatja a JSONRPC-ügyfelet.

Csatlakozás egy elnevezett csőhöz OSX/Linux rendszeren:

bicep jsonrpc --pipe /tmp/bicep-81375a8084b474fa2eaedda1702a7aa40e2eaa24b3.sock

Névvel ellátott csőhöz való csatlakozás Windows rendszeren:

bicep jsonrpc --pipe \\.\pipe\\bicep-81375a8084b474fa2eaedda1702a7aa40e2eaa24b3.sock`

További példákért lásd: C# és node.js.

A TCP-szoftvercsatorna használata

Az alábbi szintaxissal csatlakozhat egy meglévő TCP-szoftvercsatornához JSONRPC-ügyfélként:

bicep jsonrpc --socket <tcp_socket>

<tcp_socket> az a szoftvercsatornaszám, amelyhez a JSONRPC-ügyfél csatlakozik.

CSATLAKOZÁS TCP-szoftvercsatornához:

bicep jsonrpc --socket 12345

Stdin és stdout használata

Használja az alábbi szintaxist és stdinstdout az üzeneteket a JSONRPC-felület futtatásához:

bicep jsonrpc --stdio

szösz

A lint parancs egy Bicep-fájl hibáit és szabálysértéseit adja vissza.

az bicep lint --file main.bicep

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

Feljegyzés

A restore 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.28.1",
  "v0.27.1",
  "v0.26.170",
  "v0.26.54",
  "v0.25.53",
  "v0.25.3",
  "v0.24.24",
  "v0.23.1",
  "v0.22.6",
  "v0.21.1",
  "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"
]

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 parancs és a paraméter használatához a Bicep CLI 0.14.X vagy újabb verziójával kell rendelkeznie --documentationUri-d/.publish

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élda:

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.

visszaállítás

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 parancs használatához a restore Bicep CLI 0.14.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-vel.

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.

frissítés

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 a telepített verziót adja vissza:

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ó.

Következő lépések

A Bicep-fájlok üzembe helyezésével kapcsolatos további információkért lásd:

Megosztás a következőn keresztül: