إنشاء ملفات Bicep باستخدام Visual Studio Code

مقالة
05/11/2024

توضح لك هذه المقالة كيفية استخدام Visual Studio Code لإنشاء ملفات Bicep.

تثبيت VS Code

لإعداد بيئتك لتطوير Bicep، راجع تثبيت أدوات Bicep. بعد إكمال هذه الخطوات، سيكون لديك Visual Studio Code وملحق Bicep. لديك أيضا أحدث Azure CLI أو أحدث وحدة Azure PowerShell.

أوامر Bicep

يأتي Visual Studio Code مع العديد من أوامر Bicep.

افتح ملف Bicep أو قم بإنشائه في VS Code، وحدد القائمة عرض، ثم حدد لوحة الأوامر. يمكنك أيضا استخدام F1 أو تركيبة المفاتيح Ctrl+Shift+P لإظهار لوحة الأوامر. اكتب Bicep لسرد أوامر Bicep.

لقطة شاشة لأوامر Visual Studio Code Bicep في لوحة الأوامر.

تتضمن هذه الأوامر:

إنشاء قالب ARM
إنشاء ملف تكوين Bicep
إلغاء التحويل البرمجي إلى Bicep
توزيع ملف Bicep
إنشاء ملف المعلمات
استيراد بيان Kubernetes (معاينة)
إدراج مورد
فتح مصور Bicep المرئي
افتح Bicep Visualizer على الجانب
استعادة وحدات Bicep (Force)

تظهر هذه الأوامر أيضاً في قائمة السياق عند النقر بزر الماوس الأيمن فوق ملف Bicep:

عند النقر بزر الماوس الأيمن فوق ملف JSON:

إنشاء قالب ARM

يحول الأمر build ملف Bicep إلى قالب Azure Resource Manager (قالب ARM). يتم تخزين قالب JSON الجديد في نفس المجلد بنفس اسم الملف. في حالة وجود ملف بنفس اسم الملف، فإنه يحل محل الملف القديم. لمزيد من المعلومات، راجع أوامر Bicep CLI.

إنشاء ملف تكوين Bicep

يمكن استخدام ملف تكوين Bicep (bicepconfig.json) لتخصيص تجربة تطوير Bicep التي تعمل عليها. يمكنك إضافة bicepconfig.json في دلائل متعددة. يتم استخدام ملف التكوين الأقرب لملف bicep في التدريج الهرمي للدليل. عند تحديد هذا الأمر، يفتح الملحق مربع حوار لك لتحديد مجلد. المجلد الافتراضي هو المكان الذي تقوم فيه بتخزين ملف Bicep. إذا كان الملف bicepconfig.json موجودًا بالفعل في المجلد، فلديك خيار الكتابة فوق الملف الموجود.

لإنشاء ملف تكوين Bicep:

فتح Visual Studio Code.
من القائمة عرض، حدد لوحة الأوامر (أو اضغط على Ctrl/Cmd+Shift+P)، ثم حدد Bicep: إنشاء ملف تكوين Bicep.
حدد دليل الملف حيث تريد وضع الملف.
احفظ ملف التكوين عند الانتهاء.

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

يؤدي هذا الأمر إلى إلغاء تحويل قالب ARM JSON إلى ملف Bicep، ويضعه في نفس الدليل مثل قالب ARM JSON. الملف الجديد له نفس اسم الملف مع ملحق .bicep . إذا كان ملف Bicep بنفس اسم الملف موجودا بالفعل في نفس المجلد، فسيطالبك Visual Studio Code بالكتابة فوق الملف الموجود أو إنشاء نسخة.

نشر ملف Bicep

يمكنك توزيع ملفات Bicep مباشرة من Visual Studio Code. حدد Deploy Bicep file من لوحة الأوامر أو من قائمة السياق. يطالبك الملحق بتسجيل الدخول إلى Azure وتحديد الاشتراك وإنشاء / تحديد مجموعة الموارد وإدخال قيم المعلمات.

إشعار

يستخدم أمر توزيع Bicep من داخل vscode ملحق حساب Azure للمصادقة. لا يستخدم ملفات تعريف السحابة من bicepconfig.json.

إنشاء ملف المعلمات

يقوم هذا الأمر بإنشاء ملف معلمة في نفس المجلد مثل ملف Bicep. يمكنك اختيار إنشاء ملف معلمة Bicep أو ملف معلمة JSON. اسم ملف معلمة Bicep الجديد هو <bicep-file-name>.bicepparam، بينما اسم ملف معلمة JSON الجديد هو <bicep-file-name>.parameters.json.

استيراد بيان Kubernetes (معاينة)

يستورد هذا الأمر ملف بيان Kubernetes، وينشئ وحدة Bicep. لمزيد من المعلومات، راجع موفر Kubernetes القابل للتوسعة ل Bicep، والبدء السريع: نشر تطبيقات Azure إلى نظام مجموعة خدمة Azure Kubernetes (AKS) باستخدام موفر Bicep Kubernetes (معاينة).

أدخل المورد

يضيف الأمر insert resource إعلان مورد في ملف Bicep عن طريق توفير معرف المورد لمورد موجود. بعد تحديد إدراج مورد، أدخل معرف المورد في لوحة الأوامر. يستغرق إدراج المورد بضع لحظات.

يمكنك العثور على معرف المورد باستخدام إحدى هذه الطرق:

استخدم ملحق مورد Azure ل Visual Studio Code.
استخدام مدخل Azure.
استخدم Azure CLI أو Azure PowerShell:
- المبادره القطريه
- بوويرشيل
```
az resource list
```
```
Get-AzResource
```

على غرار تصدير القوالب، تحاول العملية إنشاء مورد قابل للاستخدام. ومع ذلك، تتطلب معظم القوالب المدرجة بعض التعديلات قبل استخدامها لتوزيع موارد Azure.

لمزيد من المعلومات، راجع إلغاء التحويل البرمجي لـ JSON لقالب ARM إلى Bicep.

افتح متخيل العضلة ذات الرأسين

يعرض المصور المرئي الموارد المعرّفة في ملف Bicep مع معلومات تبعية المورد. يمثل الرسم التخطيطي تصور ملف Bicep للجهاز الظاهري الذي يعمل بنظام Linux.

يمكنك أيضًا فتح المصور المرئي جنبًا إلى جنب مع ملف Bicep.

استعادة وحدات Bicep

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

عرض نوع المستند

من Visual Studio Code، يمكنك فتح مرجع القالب لنوع المورد الذي تعمل عليه. للقيام بذلك، مرر مؤشر الماوس فوق الاسم الرمزي للمورد، ثم حدد View type document.

لقطة شاشة لمستند نوع عرض Visual Studio Code Bicep.

الانتقال إلى التعريف

عند تعريف وحدة نمطية، بغض النظر عن أنواع الملف المشار إليه - سواء كان ملفا محليا أو ملف تسجيل وحدة نمطية أو مواصفات قالب، يمكنك فتح الملف المشار إليه عن طريق تحديد مسار الوحدة النمطية أو تمييزه ثم الضغط على [F12]. إذا كان الملف المشار إليه هو Azure Verified Modules (AVM)، يمكنك التبديل بين ملف JSON أو Bicep المحول برمجيا. لكي تتمكن من فتح ملف Bicep لوحدة تسجيل خاصة، تأكد من نشر الوحدة النمطية إلى السجل مع WithSource تمكين التبديل. لمزيد من المعلومات، راجع نشر الملفات إلى السجل. مطلوب إصدار ملحق Visual Studio Code Bicep 0.27.1 أو أحدث لفتح ملف Bicep من سجل الوحدة النمطية الخاص.

لصق ك Bicep

يمكنك لصق مقتطف JSON من قالب ARM إلى ملف Bicep. يقوم Visual Studio Code تلقائيا بإلغاء التحويل البرمجي ل JSON إلى Bicep. تتوفر هذه الميزة فقط مع إصدار ملحق Bicep 0.14.0 أو أحدث. يتم تمكين هذه الميزة بشكل افتراضي. لتعطيل الميزة، راجع VS Code وملحق Bicep.

باستخدام هذه الميزة، يمكنك لصق:

قوالب ARM JSON الكاملة.
مورد واحد أو موارد متعددة.
قيم JSON، مثل الكائنات والصفائف والسلاسل. يتم تحويل سلسلة ذات علامات اقتباس مزدوجة إلى علامات اقتباس مفردة.

على سبيل المثال، يمكنك البدء بملف Bicep التالي:

@description('Storage Account type')
@allowed([
  'Standard_LRS'
  'Standard_GRS'
  'Standard_ZRS'
  'Premium_LRS'
])
param storageAccountsku string = 'Standard_LRS'

@description('Location for all resources.')
param location string = resourceGroup().location

var storageAccountName = '${uniqueString(resourceGroup().id)}storage'

resource storageAccount 'Microsoft.Storage/storageAccounts@2021-08-01' = {
  name: storageAccountName
  location: location
  sku: {
    name: storageAccountsku
  }
  kind: 'StorageV2'
  tags: {
    ObjectName: storageAccountName
  }
  properties: {}
}

output storageAccountName string = storageAccountName

والصق JSON التالي:

{
  "type": "Microsoft.Batch/batchAccounts",
  "apiVersion": "2021-06-01",
  "name": "[parameters('batchAccountName')]",
  "location": "[parameters('location')]",
  "tags": {
    "ObjectName": "[parameters('batchAccountName')]"
  },
  "properties": {
    "autoStorage": {
      "storageAccountId": "[resourceId('Microsoft.Storage/storageAccounts', variables('storageAccountName'))]"
    }
  }
}

يحول Visual Studio Code تلقائيا JSON إلى Bicep. لاحظ أنك تحتاج أيضا إلى إضافة المعلمة المسماة batchAccountName.

يمكنك التراجع عن إلغاء التحويل البرمجي باستخدام Ctrl+Z. يظهر JSON الأصلي في الملف.

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

للتجول في خطوات التشغيل السريع، راجع التشغيل السريع: إنشاء ملفات Bicep باستخدام Visual Studio Code.

Share via