أوامر Bicep CLI

توضح هذه المقالة الأوامر التي يمكنك استخدامها في CLI Bicep. لديك خياران لتنفيذ هذه الأوامر: إما باستخدام Azure CLI أو عن طريق استدعاء أوامر Bicep CLI مباشرة. يتطلب كل أسلوب عملية تثبيت مميزة. لمزيد من المعلومات، راجع تثبيت Azure CLI وتثبيت Azure PowerShell.

توضح هذه المقالة كيفية تشغيل الأمر في Azure CLI. عند تشغيل خلال Azure CLI، يمكنك بدء تشغيل الأوامر مع az. إذا كنت لا تستخدم Azure CLI، فقم بتشغيل الأوامر دون az في بداية الأمر. على سبيل المثال، az bicep build يصبح bicep build، ويصبح az bicep versionbicep --version.

الإنشاء

يحول الأمر build ملف Bicep إلى قالب Azure Resource Manager (قالب ARM). بشكل عام، لا تحتاج إلى تشغيل هذا الأمر لأنه يعمل تلقائيا عند نشر ملف Bicep. شغّله يدوياً عندما تريد رؤية قالب ARM JSON الذي تم إنشاؤه من ملف Bicep الخاص بك.

يحول المثال التالي ملف Bicep المسمى main.bicep إلى قالب ARM باسم main.json. يتم إنشاء الملف الجديد في نفس الدليل مثل ملف Bicep.

az bicep build --file main.bicep

يحفظ المثال التالي main.js إلى دليل آخر.

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

يحدد المثال التالي اسم الملف الذي سيتم إنشاؤه وموقعه.

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

لطباعة الملف إلى stdout، استخدم:

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

إذا تضمن ملف Bicep الخاص بك وحدة تشير إلى سجل خارجي، فإن إنشاء الأمر تلقائياً يُسمى استعادة. يحصل أمر الاستعادة على الملف من التسجيل ويخزنه في ذاكرة التخزين المؤقت المحلية.

إشعار

لا يقوم أمر الاستعادة بتحديث ذاكرة التخزين المؤقت. لمزيد من المعلومات، راجع استعادة.

لعدم استدعاء الاستعادة تلقائياً، استخدم المفتاح --no-restore:

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

تفشل عملية الإنشاء باستخدام المفتاح --no-restore إذا لم تكن إحدى الوحدات الخارجية مخزنة مؤقتاً بالفعل:

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

عندما تحصل على هذا الخطأ، قم بتشغيل الأمر build دون المفتاح --no-restore أو قم بتشغيل bicep restore أولاً.

لاستخدام --no-restore مفتاح التبديل، يجب أن يكون لديك إصدار Bicep CLI 0.4.X أو أعلى.

بناء المعلمات

ينشئ build-paramsالأمر ملف .bicepparam في ملف معلمات JSON.

az bicep build-params --file params.bicepparam

يحول هذا الأمر ملف معلمات params.bicepparam إلى ملف معلمات javams.json JSON.

إلغاء التحويل البرمجي

الأمر decompile بتحويل قالب ARM JSON إلى ملف Bicep.

az bicep decompile --file main.json

يقوم الأمر بإنشاء ملف يسمى main.bicep في نفس الدليل مثل main.json. إذا كان main.bicep موجودا في نفس الدليل، فاستخدم --force switch للكتابة فوق ملف Bicep الموجود.

لمزيد من المعلومات حول استخدام هذا الأمر، راجع إلغاء ترجمة قالب ARM JSON إلى Bicep.

إلغاء التحويل البرمجي للبارامات

يقوم decompile-params الأمر بإلغاء التحويل البرمجي لملف معلمات JSON إلى ملف معلمات .bicepparam .

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

يؤدي هذا الأمر إلى إلغاء تحويل ملف معلمات azuredeploy.parameters.json إلى ملف azuredeploy.parameters.bicepparam . --bicep-file يحدد المسار إلى ملف Bicep (بالنسبة إلى ملف .bicepparam) المشار إليه في using الإعلان.

format

يقوم format الأمر بتنسيق ملف Bicep. له نفس وظيفة الاختصار SHIFT+ALT+F في Visual Studio Code.

az bicep format --file main.bicep

إنشاء معلمات

ينشئ generate-params الأمر ملف معلمات من ملف Bicep المحدد، ويحدث إذا كان هناك ملف معلمات موجود.

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

ينشئ الأمر ملف معلمات Bicep يسمى main.bicepparam. يحتوي ملف المعلمة على كافة المعلمات في ملف Bicep، سواء تم تكوينه بقيم افتراضية أم لا.

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

ينشئ الأمر ملف معلمة يسمى main.parameters.json. يحتوي ملف المعلمة فقط على المعلمات دون قيم افتراضية تم تكوينها في ملف Bicep.

تثبيت

يضيف الأمر install CLI Bicep إلى البيئة المحلية. لمزيد من المعلومات، راجع تثبيت أدوات Bicep. يتوفر هذا الأمر فقط من خلال Azure CLI.

‏‏تثبيت أحدث إصدار، استخدم:

az bicep install

لتثبيت إصدار محدد:

az bicep install --version v0.3.255

lint

يقوم lint الأمر بإرجاع الأخطاء وانتهاكات قاعدة linter لملف Bicep.

az bicep lint --file main.bicep

إذا كان ملف Bicep يتضمن وحدة نمطية تشير إلى سجل خارجي، فإن أمر التحليل يستدعي الاستعادة تلقائيا. يحصل أمر الاستعادة على الملف من التسجيل ويخزنه في ذاكرة التخزين المؤقت المحلية.

إشعار

لا يقوم أمر الاستعادة بتحديث ذاكرة التخزين المؤقت. لمزيد من المعلومات، راجع استعادة.

لعدم استدعاء الاستعادة تلقائياً، استخدم المفتاح --no-restore:

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

تفشل عملية التحليل مع --no-restore مفتاح التبديل إذا لم يتم تخزين إحدى الوحدات النمطية الخارجية مؤقتا بالفعل:

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

عندما تحصل على هذا الخطأ، قم بتشغيل الأمر lint دون المفتاح --no-restore أو قم بتشغيل bicep restore أولاً.

قائمة الإصدارات

يرجع الأمر list-versions جميع الإصدارات المتوفرة من CLI Bicep. استخدم هذا الأمر لمعرفة ما إذا كنت تريد ترقية أو تثبيت إصدار جديد. يتوفر هذا الأمر فقط من خلال Azure CLI.

az bicep list-versions

يقوم الأمر بإرجاع مصفوفة من الإصدارات المتاحة.

[
  "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 وحدة نمطية إلى السجل. يجب أن يكون سجل حاوية Azure موجوداً ويجب أن يكون لدى حساب النشر إلى السجل الأذونات الصحيحة. لمزيد من المعلومات حول إعداد سجل وحدة، راجع استخدام التسجيل الخاص لوحدات Bicep النمطية . لنشر وحدة نمطية، يجب أن يكون للحساب ملف التعريف الصحيح والأذونات للوصول إلى السجل. يمكنك تكوين ملف التعريف وأسبقية بيانات الاعتماد للمصادقة على السجل في ملف تكوين Bicep.

بعد نشر الملف على السجل، يمكنك الرجوع إليه في وحدة نمطية .

لاستخدام أمر النشر، يجب أن يكون لديك إصدار Bicep CLI 0.14.X أو أعلى. لاستخدام المعلمة --documentationUri/-d ، يجب أن يكون لديك Bicep CLI الإصدار 0.14.X أو أعلى.

لنشر وحدة نمطية إلى سجل، استخدم:

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

على سبيل المثال:

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

publish لا يتعرف الأمر على الأسماء المستعارة المحددة في ملف bicepconfig.json. توفير مسار الوحدة النمطية الكامل.

تحذير

يؤدي النشر إلى نفس الهدف إلى الكتابة فوق الوحدة النمطية القديمة. نوصي بزيادة الإصدار عند التحديث.

الاستعادة

عندما يستخدم ملف Bicep الوحدات النمطية التي تم نشرها في السجل، يحصل الأمر restore على نسخ من جميع الوحدات النمطية المطلوبة من السجل. تقوم بتخزين هذه النسخ في ذاكرة التخزين المؤقت المحلية. يمكن إنشاء ملف Bicep فقط عندما تتوفر الملفات الخارجية في ذاكرة التخزين المؤقت المحلية. عادة، تشغيل الاستعادة ليس ضروريا لأنه يتم تشغيله تلقائيا بواسطة عملية الإنشاء.

لاستعادة الوحدات النمطية الخارجية إلى ذاكرة التخزين المؤقت المحلية، يجب أن يكون للحساب ملف التعريف الصحيح والأذونات للوصول إلى السجل. يمكنك تكوين ملف التعريف وأسبقية بيانات الاعتماد للمصادقة على السجل في ملف تكوين Bicep.

لاستخدام أمر الاستعادة، يجب أن يكون لديك إصدار Bicep CLI 0.4.X أو أعلى. يتوفر هذا الأمر حاليًا فقط عند استدعاء CLI Bicep مباشرة. لا يتوفر حاليًا من خلال الأمر Azure CLI.

لاستعادة الوحدات الخارجية يدوياً لملف، استخدم:

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

ملف Bicep الذي تقدمه هو الملف الذي ترغب في نشره. يجب أن يحتوي على الوحدة النمطية التي ترتبط إلى تسجيل. على سبيل المثال، يمكنك استعادة الملف التالي:

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

تم العثور على ذاكرة التخزين المؤقت المحلية في:

• على Windows

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

• On Linux

  /home/<username>/.bicep
  

• على Mac

  ~/.bicep
  

لا يقوم restore الأمر بتحديث ذاكرة التخزين المؤقت إذا تم تخزين وحدة نمطية مؤقتا بالفعل. لتحديث ذاكرة التخزين المؤقت، يمكنك إما حذف مسار الوحدة النمطية من ذاكرة التخزين المؤقت أو استخدام --force مفتاح التبديل مع restore الأمر .

الترقية

يقوم الأمر upgrade بتحديث الإصدار المثبت باستخدام أحدث إصدار. يتوفر هذا الأمر فقط من خلال Azure CLI.

az bicep upgrade

الإصدار

يقوم الأمر version بإرجاع الإصدار المثبت لديك.

az bicep version

يظهر الأمر رقم الإصدار.

Bicep CLI version 0.22.6 (d62b94db31)

لاستدعاء هذا الأمر مباشرة من خلال Bicep CLI، استخدم:

bicep --version

إذا لم يتم تثبيت Bicep CLI، فستواجه رسالة خطأ تفيد بأنه لم يتم العثور على Bicep CLI.

الخطوات التالية

لمعرفة المزيد حول نشر ملف Bicep، راجع:

• Azure CLI
• Cloud Shell
• بوويرشيل