Bicep CLI komutları

Makale
01/03/2024

Bu makalede, Bicep CLI'da kullanabileceğiniz komutlar açıklanmaktadır. Bu komutları yürütmek için iki seçeneğiniz vardır: Azure CLI'yi kullanarak veya Doğrudan Bicep CLI komutlarını çağırarak. Her yöntem ayrı bir yükleme işlemi gerektirir. Daha fazla bilgi için bkz . Azure CLI'yı yükleme ve Azure PowerShell'i yükleme.

Bu makalede Azure CLI'da komutların nasıl çalıştırılacakları gösterilmektedir. Azure CLI'da çalışırken komutlarını ile azbaşlatırsınız. Azure CLI kullanmıyorsanız komutun başında olmadan az komutları çalıştırın. Örneğin, az bicep build olur bicep buildve az bicep version olur bicep --version.

derleme

Komutu, build bicep dosyasını Azure Resource Manager şablonuna (ARM şablonu) dönüştürür. Genellikle, bir Bicep dosyası dağıttığınızda otomatik olarak çalıştığından bu komutu çalıştırmanız gerekmez. Bicep dosyanızdan oluşturulan ARM şablonu JSON'u görmek istediğinizde el ile çalıştırın.

Aşağıdaki örnek main.bicep adlı bicep dosyasını main.json adlı arm şablonuna dönüştürür. Yeni dosya, Bicep dosyasıyla aynı dizinde oluşturulur.

az bicep build --file main.bicep

Sonraki örnek main.json dosyasını farklı bir dizine kaydeder.

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

Sonraki örnek, oluşturulacak dosyanın adını ve konumunu belirtir.

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

dosyasını 'a yazdırmak için stdoutşunu kullanın:

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

Bicep dosyanız dış kayıt defterine başvuran bir modül içeriyorsa derleme komutu otomatik olarak geri yüklemeyi çağırır. Geri yükleme komutu dosyayı kayıt defterinden alır ve yerel önbellekte depolar.

Dekont

Geri yükleme komutu önbelleği yenilemez. Daha fazla bilgi için bkz . geri yükleme.

Geri yüklemeyi otomatik olarak çağırmamak için şu anahtarı kullanın --no-restore :

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

Dış modüllerden biri henüz önbelleğe alınmadıysa anahtarla --no-restore derleme işlemi başarısız olur:

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

Bu hatayı aldığınızda, komutunu anahtar olmadan --no-restore çalıştırın build veya önce çalıştırınbicep restore.

Anahtarı kullanmak --no-restore için Bicep CLI 0.4.X veya üzeri bir sürüme sahip olmanız gerekir.

build-params

build-params komutu bir JSON parametre dosyasına bir .bicepparam dosyası oluşturur.

az bicep build-params --file params.bicepparam

Bu komut params.bicepparam parametre dosyasını params.json JSON parametre dosyasına dönüştürür.

Decompile

komutu ARM decompile şablonu JSON'unu Bicep dosyasına dönüştürür.

az bicep decompile --file main.json

komutu main.json ile aynı dizinde main.bicep adlı bir dosya oluşturur. Main.bicep aynı dizinde varsa var olan Bicep dosyasının üzerine yazmak için --force anahtarını kullanın.

Bu komutu kullanma hakkında daha fazla bilgi için bkz . ARM şablonu JSON'yi Bicep'e derleme.

decompile-params

decompile-params Komutu bir JSON parametre dosyasını bir .bicepparam parametre dosyası olarak koda ayırır.

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

Bu komut, bir azuredeploy.parameters.json parametre dosyasını azuredeploy.parameters.bicepparam dosyasına ayırır. --bicep-file bildirimde başvuruda using bulunılan Bicep dosyasının (.bicepparam dosyasına göre) yolunu belirtir.

format

format Komut bir Bicep dosyasını biçimlendirin. Visual Studio Code'daki kısayolla SHIFT+ALT+F aynı işleve sahiptir.

az bicep format --file main.bicep

generate-params

generate-params komutu verilen Bicep dosyasından bir parametre dosyası oluşturur, mevcut bir parametre dosyası varsa güncelleştirilir.

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

komutu main.bicepparam adlı bir Bicep parametre dosyası oluşturur. Parametre dosyası, varsayılan değerlerle yapılandırılsa da yapılandırılmasa da Bicep dosyasındaki tüm parametreleri içerir.

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

komutu main.parameters.json adlı bir parametre dosyası oluşturur. Parametre dosyası yalnızca Bicep dosyasında yapılandırılmış varsayılan değerler içermeyen parametreleri içerir.

yükle

Komutu, install Bicep CLI'yi yerel ortamınıza ekler. Daha fazla bilgi için bkz . Bicep araçlarını yükleme. Bu komut yalnızca Azure CLI aracılığıyla kullanılabilir.

En son sürümü yüklemek için şunu kullanın:

az bicep install

Belirli bir sürümü yüklemek için:

az bicep install --version v0.3.255

Lint

Komutu, lint bicep dosyasının hatalarını ve linter kuralı ihlallerini döndürür.

az bicep lint --file main.bicep

Bicep dosyanız dış kayıt defterine başvuran bir modül içeriyorsa, lint komutu otomatik olarak geri yüklemeyi çağırır. Geri yükleme komutu dosyayı kayıt defterinden alır ve yerel önbellekte depolar.

Dekont

Geri yükleme komutu önbelleği yenilemez. Daha fazla bilgi için bkz . geri yükleme.

Geri yüklemeyi otomatik olarak çağırmamak için şu anahtarı kullanın --no-restore :

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

Dış modüllerden biri henüz önbelleğe alınmadıysa anahtarla --no-restore lint işlemi başarısız olur:

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

Bu hatayı aldığınızda, komutunu anahtar olmadan --no-restore çalıştırın lint veya önce çalıştırınbicep restore.

liste sürümleri

Komut, list-versions Bicep CLI'nın tüm kullanılabilir sürümlerini döndürür. Yeni bir sürümü yükseltmek mi yoksa yüklemek mi istediğinizi görmek için bu komutu kullanın. Bu komut yalnızca Azure CLI aracılığıyla kullanılabilir.

az bicep list-versions

komutu, kullanılabilir sürümlerin bir dizisini döndürür.

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

publish komutu kayıt defterine bir modül ekler. Azure kapsayıcı kayıt defteri mevcut olmalı ve kayıt defterinde yayımlama hesabı doğru izinlere sahip olmalıdır. Modül kayıt defteri ayarlama hakkında daha fazla bilgi için bkz . Bicep modülleri için özel kayıt defteri kullanma. Modülü yayımlamak için hesabın kayıt defterine erişmek için doğru profile ve izinlere sahip olması gerekir. Bicep yapılandırma dosyasında kayıt defterinde kimlik doğrulaması yapmak için profil ve kimlik bilgisi önceliğini yapılandırabilirsiniz.

Dosyayı kayıt defterinde yayımladıktan sonra bir modülde başvurabilirsiniz.

Yayımla komutunu kullanmak için Bicep CLI sürüm 0.14.X veya üzeri olmalıdır. parametresini --documentationUri/-d kullanmak için Bicep CLI sürüm 0.14.X veya üzeri olmalıdır.

Bir modülü kayıt defterinde yayımlamak için şunu kullanın:

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

Örneğin:

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

publish Komut, bicepconfig.json dosyasında belirtilen diğer adları tanımıyor. Tam modül yolunu belirtin.

Uyarı

Aynı hedefe yayımlamak eski modülün üzerine yazar. Güncelleştirme sırasında sürümü artırmanızı öneririz.

geri yükleme

Bicep dosyanız bir kayıt defterinde yayımlanan modülleri kullandığında restore , komut kayıt defterinden tüm gerekli modüllerin kopyalarını alır. Bu kopyaları yerel önbellekte depolar. Bicep dosyası yalnızca dış dosyalar yerel önbellekte kullanılabilir olduğunda oluşturulabilir. Normalde, derleme işlemi tarafından otomatik olarak tetiklendiğinden geri yüklemeyi çalıştırmak gerekli değildir.

Dış modülleri yerel önbelleğe geri yüklemek için hesabın kayıt defterine erişmek için doğru profile ve izinlere sahip olması gerekir. Bicep yapılandırma dosyasında kayıt defterinde kimlik doğrulaması yapmak için profil ve kimlik bilgisi önceliğini yapılandırabilirsiniz.

Geri yükleme komutunu kullanmak için Bicep CLI sürüm 0.4.X veya üzeri olmalıdır. Bu komut şu anda yalnızca Bicep CLI'yi doğrudan çağırırken kullanılabilir. Şu anda Azure CLI komutuyla kullanılamaz.

Bir dosyanın dış modüllerini el ile geri yüklemek için şunu kullanın:

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

Sağladığınız Bicep dosyası, dağıtmak istediğiniz dosyadır. Kayıt defterine bağlanan bir modül içermelidir. Örneğin, aşağıdaki dosyayı geri yükleyebilirsiniz:

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

Yerel önbellek şu şekilde bulunur:

Windows üzerinde

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

Linux'ta
```
/home/<username>/.bicep
```
Mac'te
```
~/.bicep
```

Bir restore modül zaten önbelleğe alınmışsa komut önbelleği yenilemez. Önbelleği yenilemek için modül yolunu önbellekten silebilir veya komutuyla restore anahtarı kullanabilirsiniz--force.

yükseltme

Komut, upgrade yüklü sürümünüzü en son sürümle güncelleştirir. Bu komut yalnızca Azure CLI aracılığıyla kullanılabilir.

az bicep upgrade

sürüm

Komut version , yüklü sürümünüzü döndürür.

az bicep version

komutu sürüm numarasını gösterir.

Bicep CLI version 0.22.6 (d62b94db31)

Bu komutu doğrudan Bicep CLI aracılığıyla çağırmak için şunu kullanın:

bicep --version

Bicep CLI yüklenmediyse Bicep CLI'nın bulunamadığını belirten bir hata iletisiyle karşılaşırsınız.

Sonraki adımlar

Bicep dosyası dağıtma hakkında bilgi edinmek için bkz: