مجموعة تكوين dsc

خلاصه

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

إعراب

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

dsc config set [Options] --file <FILE>

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

dsc config set [Options] --input <INPUT>

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

cat <FILE> | dsc config set [Options] --file -

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

cat <PARAMETERS_FILE> | dsc config --parameters-file - set [Options] --file <FILE>

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

cat <PARAMETERS_FILE> | dsc config --parameters-file - set [Options] --input <INPUT>

وصف

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

يجب تمرير مستند التكوين إلى هذا الأمر ك JSON أو YAML مع --input الخيار أو --file .

امثله

مثال 1 - تعيين مثيلات موارد التكوين إلى الحالة المطلوبة

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

# example.dsc.config.yaml
$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
resources:
- name: Windows only
  type: Microsoft.DSC/Assertion
  properties:
    $schema: https://aka.ms/dsc/schemas/v3/bundled/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 set --file -

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

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

dsc config set --file ./example.dsc.config.yaml

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

يستخدم الأمر خيار الإدخال لفرض التكوين المخزن في المتغير $desired .

dsc config set --input $desired

خيارات

-i، --input

تحديد مستند التكوين لفرض الحالة له.

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

هذا الخيار حصري بشكل متبادل مع الخيار --file .

Type        : string
Mandatory   : false
LongSyntax  : --input <INPUT>
ShortSyntax : -i <INPUT>

-و، --ملف

يحدد المسار إلى مستند تكوين لفرض الحالة له.

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

يمكنك أيضا استخدام هذا الخيار لتمرير مستند تكوين من stdin، كما هو موضح في المثال 1.

هذا الخيار حصري بشكل متبادل مع الخيار --input .

Type        : string
Mandatory   : false
LongSyntax  : --file <FILE>
ShortSyntax : -f <FILE>

-w، --ماذا لو

عند تحديد خيار العلامة هذا، لا يقوم DSC فعليا بتغيير حالة النظام مع العملية set . بدلا من ذلك ، يقوم بإرجاع الإخراج الذي يشير إلى كيفية تغيير العملية لحالة النظام عند الاتصال بدون هذا الخيار. استخدم هذا الخيار لمعاينة التغييرات التي سيقوم بها DSC على النظام.

يكون إخراج الأمر عند استخدام هذا الخيار هو نفسه بدون، باستثناء أنه تم تعيين حقل البيانات الوصفية ExecutionType إلى WhatIf بدلا من Actual.

Type        : boolean
Mandatory   : false
LongSyntax  : --what-if
ShortSyntax : -w

-o، --تنسيق الإخراج

يتحكم --output-format الخيار في التنسيق الذي يستخدمه DSC للبيانات التي يرجعها الأمر. التنسيقات المتاحة هي:

• json لإصدار البيانات كخط JSON.
• pretty-json لإصدار البيانات ك JSON مع أسطر جديدة ومسافة بادئة ومساحات لسهولة القراءة.
• yaml لإصدار البيانات ك YAML.

يعتمد تنسيق الإخراج الافتراضي على ما إذا كان DSC يكتشف أن الإخراج تتم إعادة توجيهه أو التقاطه كمتغير:

• إذا لم تتم إعادة توجيه الأمر أو التقاطه، يعرض DSC الإخراج كتنسيق yaml في وحدة التحكم.
• إذا تمت إعادة توجيه إخراج الأمر أو التقاطه، يصدر DSC البيانات كتنسيق json stdout.

عند إستخدام هذا الخيار، يستخدم DSC التنسيق المحدد بغض النظر عما إذا كان الأمر تتم إعادة توجيهه أو التقاطه.

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

Type        : string
Mandatory   : false
ValidValues : [json, pretty-json, yaml]
LongSyntax  : --output-format <OUTPUT_FORMAT>
ShortSyntax : -o <OUTPUT_FORMAT>

-h، --help

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

Type        : boolean
Mandatory   : false
LongSyntax  : --help
ShortSyntax : -h

الناتج

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

لمزيد من المعلومات حول تنسيق بيانات الإخراج، راجع الخيار --output-format.