أوامر 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 إلى قالب JSON Azure Resource Manager (قالب ARM). بشكل عام، لا تحتاج إلى تشغيل هذا الأمر لأنه يعمل تلقائيا عند نشر ملف Bicep. قم بتشغيله يدويا عندما تريد رؤية قالب JSON ARM الذي تم إنشاؤه من ملف Bicep الخاص بك.

يتيح استخدام أي من ميزات Bicep التالية تلقائيا إنشاء التعليمات البرمجية لإصدار اللغة 2.0:

• أنواع معرفة من قبل المستخدم
• الوظائف المعرفة من قبل المستخدم
• عمليات استيراد وقت التحويل البرمجي
• ميزات تجريبية

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

az bicep build --file main.bicep

يحفظ المثال التالي main.json إلى دليل مختلف:

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 يتضمن وحدة نمطية تشير إلى سجل خارجي، يستدعي build الأمر تلقائيا restore. restore يحصل الأمر على الملف من السجل ويخزنه في ذاكرة التخزين المؤقت المحلية.

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

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

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

The module with reference "br:exampleregistry.azurecr.io/bicep/modules/storage:v1" hasn't 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 إلى ملف معلمات JSON params.json .

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

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

az bicep decompile --file main.json

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

لمزيد من المعلومات حول استخدام هذا الأمر، راجع إلغاء تحويل قالب JSON ARM إلى 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 يضيف الأمر Bicep CLI إلى بيئتك المحلية، وهو متاح فقط من خلال Azure CLI. لمزيد من المعلومات، راجع تثبيت أدوات Bicep.

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

az bicep install

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

az bicep install --version v0.3.255

jsonrpc

jsonrpc يتيح الأمر تشغيل Bicep CLI مع واجهة JSON-RPC، ما يسمح بالتفاعل البرمجي مع الإخراج المنظم وتجنب تأخيرات البدء البارد عند تحويل ملفات متعددة برمجيا. يدعم هذا الإعداد أيضا إنشاء مكتبات للتفاعل مع ملفات Bicep برمجيا بلغات non-.NET.

تنسيق السلك لإرسال الإدخال/الإخراج وتلقيه محددا بالرأس، باستخدام البنية التالية، حيث \r يمثل حرفا \n إرجاع السطر وإرجاعه:

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

• <length> هو طول <message> السلسلة، بما في ذلك اللاحقة \r\n\r\n.
• <message> هي رسالة JSON الأولية.

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

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

تعرض الرسالة التالية مثالا لإصدار Bicep.

• الإدخال:

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

• الإخراج:

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

للاطلاع على الأساليب المتاحة وهيئات الطلب/الاستجابة، راجع ICliJsonRpcProtocol.cs. للحصول على مثال لإنشاء اتصال JSONRPC والتفاعل مع ملفات Bicep برمجيا باستخدام Node، راجع jsonrpc.test.ts.

استخدام الأنابيب المسماة

استخدم بناء الجملة التالي للاتصال بمصب مسمى موجود ك عميل JSONRPC:

bicep jsonrpc --pipe <named_pipe>`

<named_pipe> هو أنبوب مسمى موجود لتوصيل عميل JSONRPC به.

للاتصال بمواسير مسماة على OSX/Linux:

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

للاتصال بمواسير مسماة على Windows :

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

لمزيد من الأمثلة، راجع C#‎ و node.js.

استخدام مأخذ توصيل TCP

استخدم بناء الجملة التالي للاتصال بمأخذ توصيل TCP موجود ك عميل JSONRPC:

bicep jsonrpc --socket <tcp_socket>

<tcp_socket> هو رقم المقبس الذي يتصل به عميل JSONRPC.

للاتصال بمأخذ توصيل TCP:

bicep jsonrpc --socket 12345

استخدام stdin وstdout

استخدم بناء الجملة التالي و stdinstdout للرسائل لتشغيل واجهة JSONRPC:

bicep jsonrpc --stdio

lint

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

az bicep lint --file main.bicep

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

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

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

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

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

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.

لاستخدام restore الأمر، يجب أن يكون لديك Bicep CLI الإصدار 0.14.X أو أحدث. في هذا الوقت، يتوفر هذا الأمر فقط عند استدعاء Bicep CLI مباشرة. لا يتوفر حاليا من خلال 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
• Deploy - Azure PowerShell
• Deploy - Cloud Shell