اختبار تكوين dsc

الخلاصة

يتحقق ما إذا كانت مثيلات الموارد في مستند التكوين في الحالة المطلوبة.

بناء الجملة

مستند التكوين من stdin

<document-string> | dsc config test [Options]

مستند التكوين من سلسلة الخيارات

dsc config test [Options] --document <document-string>

مستند التكوين من الملف

dsc config test [Options] --path <document-filepath>

الوصف

test يتحقق الأمر الفرعي من ما إذا كانت مثيلات الموارد في مستند التكوين في الحالة المطلوبة. عند تشغيل هذا الأمر، يتحقق DSC من صحة مستند التكوين قبل استدعاء عملية الاختبار لكل مثيل مورد معرف في المستند.

يجب تمرير مستند التكوين إلى هذا الأمر ك JSON أو YAML عبر stdin، كسلسلة مع خيار المستند ، أو من ملف مع خيار المسار .

أمثلة

مثال 1 - اختبار ما إذا كانت مثيلات موارد التكوين في الحالة المطلوبة

يقوم الأمر بإرجاع الحالة والحالة المطلوبة والحالة الفعلية والخصائص المختلفة لمثيلات الموارد المحددة في مستند التكوين المحفوظ ك example.dsc.config.yaml.

# example.dsc.config.yaml
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
resources:
- name: Windows only
  type: Microsoft.DSC/Assertion
  properties:
    $schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
    resources:
    - name: os
      type: Microsoft/OSInfo
      properties:
        family: Windows
- name: Current user registry example
  type: Microsoft.Windows/Registry
  properties:
    keyPath: HKCU\example
    _exist: true
  dependsOn:
    - "[resourceId('Microsoft.DSC/Assertion', 'Windows only')"

cat ./example.dsc.config.yaml | dsc config test

مثال 2 - تمرير ملف للقراءة كمستند التكوين

يستخدم الأمر خيار المسار للتحقق من صحة التكوين المحدد في example.dsc.config.yaml الملف.

dsc config test --path ./example.dsc.config.yaml

مثال 3 - تمرير مستند تكوين كمتغير

يستخدم الأمر خيار المستند للتحقق من صحة التكوين المخزن في $desired المتغير.

dsc config test --document $desired

الخيارات

-d، --document

يحدد مستند التكوين للتحقق من صحة الحالة له. يجب أن يكون المستند سلسلة تحتوي على كائن JSON أو YAML. يتحقق DSC من صحة المستند مقابل مخطط مستند التكوين. إذا فشل التحقق من الصحة، فإن DSC يثير خطأ.

لا يمكن استخدام هذا الخيار مع مستند التكوين عبر stdin أو --path الخيار . اختر ما إذا كنت تريد تمرير مستند التكوين إلى الأمر عبر stdin أو من ملف يحتوي على --path الخيار أو مع --document الخيار .

Type:      String
Mandatory: false

-p، --path

يحدد المسار إلى مستند تكوين للتحقق من صحة الحالة بدلا من توصيل المستند من stdin أو تمريره كسلسلة مع --document الخيار . يجب أن يحتوي الملف المحدد على مستند تكوين كعنصر JSON أو YAML. يتحقق DSC من صحة المستند مقابل مخطط مستند التكوين. إذا فشل التحقق من الصحة، أو إذا لم يكن الملف المحدد موجودا، فإن DSC يثير خطأ.

هذا الخيار حصري بشكل متبادل مع --document الخيار . عند استخدام هذا الخيار، يتجاهل DSC أي إدخال من stdin.

Type:      String
Mandatory: false

-f، --format

--format يتحكم الخيار في تنسيق إخراج وحدة التحكم للأمر . إذا تمت إعادة توجيه إخراج الأمر أو تسجيله كمتغير، يكون الإخراج دائما JSON.

Type:         String
Mandatory:    false
DefaultValue: yaml
ValidValues:  [json, pretty-json, yaml]

-h، - مساعدة

يعرض التعليمات للأمر الحالي أو الأمر الفرعي الحالي. عند تحديد هذا الخيار، يتجاهل التطبيق جميع الخيارات والوسيطات بعد هذا الخيار.

Type:      Boolean
Mandatory: false

المخرجات

يقوم هذا الأمر بإرجاع إخراج JSON الذي يتضمن ما إذا كانت العملية أو أي موارد قد أثارت أي أخطاء، ومجموعة الرسائل المنبعثة أثناء العملية، ونتائج عملية الاختبار لكل مثيل. لمزيد من المعلومات، راجع مخطط نتيجة اختبار تكوين dsc.