Příkazy rozhraní příkazového řádku Bicep

Tento článek popisuje příkazy, které můžete použít v rozhraní příkazového řádku Bicep. Tyto příkazy můžete spouštět pomocí Azure CLI nebo přímo vyvoláním příkazů rozhraní příkazového řádku Bicep. Každá metoda vyžaduje odlišný proces instalace. Další informace o instalacích najdete v tématu Azure CLI a Azure PowerShell.

Tyto pokyny ukazují, jak spouštět příkazy v Azure CLI. Při spouštění příkazů v Azure CLI je začněte .az Pokud nepoužíváte Azure CLI, spusťte příkazy bez az začátku každého z nich. Například az bicep build se stane bicep builda az bicep version stane bicep --versionse .

build

Příkaz build převede soubor Bicep na šablonu Azure Resource Manageru JSON (šablonu ARM). Obvykle nemusíte tento příkaz spouštět, protože se spustí automaticky při nasazení souboru Bicep. Pokud chcete zobrazit šablonu JSON ARM vytvořenou ze souboru Bicep, spusťte ji ručně.

Použití některé z následujících funkcí Bicep automaticky povolí generování kódu verze 2.0:

• uživatelem definované typy
• uživatelem definované funkce
• importy v čase kompilace
• experimentální funkce

Následující příklad převede soubor Bicep s názvem main.bicep na šablonu ARM s názvem main.json. Nový soubor se vytvoří ve stejném adresáři jako soubor Bicep:

az bicep build --file main.bicep

Další příklad uloží main.json do jiného adresáře:

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

Další příklad určuje název a umístění souboru, který se má vytvořit:

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

Pokud chcete soubor stdoutvytisknout, použijte:

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

Pokud váš soubor Bicep obsahuje modul, který odkazuje na externí registr, build příkaz automaticky zavolá restore. Příkaz restore získá soubor z registru a uloží ho do místní mezipaměti.

Poznámka:

Příkaz restore neaktualizuje mezipaměť. Další informace najdete v tématu obnovení.

Pokud nechcete volat obnovení automaticky, použijte --no-restore přepínač:

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

Proces sestavení s přepínačem --no-restore selže, pokud některý z externích modulů ještě není uložený v mezipaměti:

The module with reference "br:exampleregistry.azurecr.io/bicep/modules/storage:v1" hasn't been restored.

Když se zobrazí tato chyba, spusťte build příkaz bez --no-restore přepínače nebo nejprve spusťte bicep restore .

Pokud chcete přepínač použít --no-restore , musíte mít rozhraní příkazového řádku Bicep verze 0.4.X nebo novější.

build-params

Příkaz build-params sestaví .bicepparam soubor do souboru parametrů JSON:

az bicep build-params --file params.bicepparam

Tento příkaz převede soubor parametrů params.bicepparam na params.json soubor parametrů JSON.

dekompilovat

Příkaz decompile převede šablonu JSON ARM na soubor Bicep:

az bicep decompile --file main.json

Tento příkaz vytvoří soubor main.bicep ve stejném adresáři jako main.json. Pokud main.bicep existuje ve stejném adresáři, použijte přepínač --force k přepsání existujícího souboru Bicep.

Další informace o použití tohoto příkazu najdete v tématu Decompile JSON ARM template to Bicep.

decompile-params

Příkaz decompile-params dekompiluje soubor parametrů JSON do .bicepparam souboru parametrů.

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

Tento příkaz dekompiuje soubor parametrů azuredeploy.parameters.json do souboru azuredeploy.parameters.bicepparam . --bicep-file určuje cestu k souboru Bicep (vzhledem k .bicepparam souboru), na který odkazuje deklarace using .

format

Příkaz format naformátuje soubor Bicep. Má stejnou funkci jako zástupce v editoru SHIFT+ALT+F Visual Studio Code.

az bicep format --file main.bicep

generate-params

Příkaz generate-params sestaví soubor parametrů z daného souboru Bicep, aktualizuje se, pokud existuje soubor parametrů.

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

Tento příkaz vytvoří soubor parametrů Bicep s názvem main.bicepparam. Soubor parametrů obsahuje všechny parametry v souboru Bicep bez ohledu na to, jestli jsou nakonfigurované s výchozími hodnotami nebo ne.

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

Tento příkaz vytvoří soubor parametrů s názvem main.parameters.json. Soubor parametrů obsahuje pouze parametry bez výchozích hodnot nakonfigurovaných v souboru Bicep.

install

Příkaz install přidá rozhraní příkazového řádku Bicep do místního prostředí a je k dispozici pouze prostřednictvím Azure CLI. Další informace najdete v tématu Instalace nástrojů Bicep.

Pokud chcete nainstalovat nejnovější verzi, použijte:

az bicep install

Instalace konkrétní verze:

az bicep install --version v0.3.255

jsonrpc

Tento jsonrpc příkaz umožňuje spuštění rozhraní příkazového řádku Bicep s rozhraním JSON-RPC, které umožňuje programovou interakci se strukturovaným výstupem a zabránění zpožděním při kompilaci více souborů. Toto nastavení také podporuje vytváření knihoven pro práci se soubory Bicep prostřednictvím kódu programu v non-.NET jazycích.

Formát drátu pro odesílání a příjem vstupu a výstupu je oddělen záhlavím pomocí následující struktury, kde \r a \n představuje znaky návratového řádku a odřádkování:

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

• <length> je délka <message> řetězce, včetně koncového \r\n\r\nřetězce .
• <message> je nezpracovaná zpráva JSON.

Příklad:

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

Následující zpráva ukazuje příklad verze Bicep.

• Vstup:

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

• Výstup:

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

Informace o dostupných metodách a tělech požadavků a odpovědí najdete v tématu ICliJsonRpcProtocol.cs. Příklad navazování připojení JSONRPC a práce se soubory Bicep prostřednictvím kódu programu pomocí Node najdete v tématu jsonrpc.test.ts.

Použití pojmenovaného kanálu

Pomocí následující syntaxe se připojte k existujícímu pojmenovaném kanálu jako klient JSONRPC:

bicep jsonrpc --pipe <named_pipe>`

<named_pipe> je existující pojmenovaný kanál pro připojení klienta JSONRPC k.

Připojení k pojmenovaném kanálu v OSX/Linuxu:

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

Připojení k pojmenované svislé rouce ve Windows:

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

Další příklady najdete v jazyce C# a node.js.

Použití pro soket TCP

Pomocí následující syntaxe se připojte k existujícímu soketu TCP jako klientovi JSONRPC:

bicep jsonrpc --socket <tcp_socket>

<tcp_socket> je číslo soketu, ke kterému se klient JSONRPC připojuje.

Připojení k soketu TCP:

bicep jsonrpc --socket 12345

Využití pro stdin a stdout

Ke spuštění rozhraní JSONRPC použijte následující syntaxi a stdin stdout zprávy:

bicep jsonrpc --stdio

chomáče vláken bavlny

Příkaz lint vrátí chyby a porušení pravidel linter souboru Bicep.

az bicep lint --file main.bicep

Pokud váš soubor Bicep obsahuje modul, který odkazuje na externí registr, lint příkaz automaticky zavolá restore. Příkaz restore získá soubor z registru a uloží ho do místní mezipaměti.

Poznámka:

Příkaz restore neaktualizuje mezipaměť. Další informace najdete v tématu obnovení.

Pokud nechcete volat obnovení automaticky, použijte --no-restore přepínač:

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

Proces lint s přepínačem --no-restore selže, pokud některý z externích modulů ještě není uložený v mezipaměti:

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

Když se zobrazí tato chyba, spusťte lint příkaz bez --no-restore přepínače nebo nejprve spusťte bicep restore .

list-versions

Příkaz list-versions vrátí všechny dostupné verze rozhraní příkazového řádku Bicep. Pomocí tohoto příkazu zjistíte, jestli chcete upgradovat nebo nainstalovat novou verzi. Tento příkaz je k dispozici pouze prostřednictvím Azure CLI.

az bicep list-versions

Příkaz vrátí pole dostupných verzí:

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

publikování

Příkaz publish přidá modul do registru. Registr kontejneru Azure musí existovat a publikování účtu do registru musí mít správná oprávnění. Další informace o nastavení registru modulu naleznete v tématu Použití privátního registru pro moduly Bicep. Pokud chcete publikovat modul, musí mít účet správný profil a oprávnění pro přístup k registru. Můžete nakonfigurovat prioritu profilu a přihlašovacích údajů pro ověřování v registru v konfiguračním souboru Bicep.

Po publikování souboru do registru na něj můžete odkazovat v modulu.

Abyste mohli použít publish příkaz a-d/--documentationUri parametr, musíte mít rozhraní příkazového řádku Bicep verze 0.14.X nebo novější.

Pokud chcete publikovat modul do registru, použijte:

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

Příklad:

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

Příkaz publish nerozpozná aliasy zadané v souboru bicepconfig.json. Zadejte úplnou cestu k modulu.

Upozorňující

Publikování do stejného cíle přepíše starý modul. Při aktualizaci doporučujeme zvýšit verzi.

Obnovení

Pokud váš soubor Bicep používá moduly publikované v registru, restore příkaz získá kopie všech požadovaných modulů z registru. Tyto kopie se ukládají v místní mezipaměti. Soubor Bicep lze sestavit pouze v případech, kdy jsou externí soubory k dispozici v místní mezipaměti. Normálně není spuštění obnovení nutné, protože se automaticky aktivuje procesem sestavení.

Pokud chcete obnovit externí moduly do místní mezipaměti, musí mít účet správný profil a oprávnění pro přístup k registru. Můžete nakonfigurovat prioritu profilu a přihlašovacích údajů pro ověřování v registru v konfiguračním souboru Bicep.

Pokud chcete tento příkaz použít restore , musíte mít rozhraní příkazového řádku Bicep verze 0.14.X nebo novější. V tuto chvíli je tento příkaz k dispozici pouze při přímém volání rozhraní příkazového řádku Bicep. V současné době není k dispozici prostřednictvím Azure CLI.

Pokud chcete externí moduly pro soubor obnovit ručně, použijte:

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

Zadaný soubor Bicep je soubor, který chcete nasadit. Musí obsahovat modul, který odkazuje na registr. Můžete například obnovit následující soubor:

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

Místní mezipaměť se nachází v:

• V systému Windows

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

• V Linuxu

  /home/<username>/.bicep
  

• Na Macu

  ~/.bicep
  

Příkaz restore neaktualizuje mezipaměť, pokud už je modul uložený v mezipaměti. Pokud chcete mezipaměť aktualizovat, můžete buď odstranit cestu modulu z mezipaměti, nebo použít --force přepínač s příkazem restore .

upgrade

Příkaz upgrade aktualizuje nainstalovanou verzi nejnovější verzí. Tento příkaz je k dispozici pouze prostřednictvím Azure CLI.

az bicep upgrade

version

Příkaz version vrátí vaši nainstalovanou verzi:

az bicep version

Příkaz zobrazí číslo verze:

Bicep CLI version 0.22.6 (d62b94db31)

Pokud chcete tento příkaz volat přímo prostřednictvím rozhraní příkazového řádku Bicep, použijte:

bicep --version

Pokud rozhraní příkazového řádku Bicep nebylo nainstalováno, zobrazí se chybová zpráva s informací, že rozhraní příkazového řádku Bicep nebylo nalezeno.

Další kroky

Další informace o nasazení souboru Bicep najdete tady:

• Nasazení – Azure CLI
• Nasazení – Azure PowerShell
• Nasazení – Cloud Shell