تصدير تكوين dsc

خلاصه

ينشئ مستند تكوين يحدد المثيلات الموجودة لمجموعة من الموارد.

بناء الجملة

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

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

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

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

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

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

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

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

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

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

‏‏الوصف

يقوم الأمر export الفرعي بإنشاء مستند تكوين يتضمن كل مثيل لمجموعة من الموارد.

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

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

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

الأمثلة

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

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

# example.dsc.config.yaml
$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
resources:
- name: Operating system information
  type: Microsoft/OSInfo
  properties: {}
- name: Processes
  type: Microsoft/Process
  properties: {}
cat ./example.dsc.config.yaml | dsc config export --file -

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

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

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

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

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

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

المخرجات

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

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