الحصول على تكوين dsc

خلاصه

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

بناء الجملة

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

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

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

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

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

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

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

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

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

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

‏‏الوصف

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

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

الأمثلة

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

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

# 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 get --file -

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

يستخدم --file الأمر خيار استرداد طبعات الموارد المحددة في example.dsc.config.yaml الملف.

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

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

يستخدم --input الأمر خيار استرداد طبعات الموارد المحددة في مستند تكوين مخزن في المتغير $desired .

dsc config get --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>

-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، - مساعدة

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

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

المخرجات

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

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