قائمة موارد dsc

خلاصه

استرداد قائمة موارد DSC المتوفرة باستخدام عامل تصفية اختياري.

إعراب

dsc resource list [Options] <RESOURCE_NAME>

وصف

يبحث list الأمر الفرعي عن موارد DSC المتوفرة ويرجع معلوماتها. يكتشف DSC الموارد عن طريق البحث أولا في PATH متغير البيئة أو DSC_RESOURCE_PATH عن .dsc.resource.json، .dsc.resource.ymlو dsc.resource.yaml والملفات. لمزيد من المعلومات حول متغيرات البيئة التي يستخدمها DSC، راجع متغيرات البيئة

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

ترجع DSC قائمة الموارد المكتشفة بمعلومات التنفيذ وبيانات التعريف الخاصة بها. إذا كان الأمر يتضمن الوسيطة RESOURCE_NAME ، يقوم DSC بتصفية قائمة الموارد المكتشفة قبل إرجاعها. تقوم الخيارات --description وتقوم --tags بتصفية النتائج حسب أوصاف الموارد والعلامات. يتم تطبيق عوامل التصفية دائما بعد اكتشاف الموارد.

ذاكرة التخزين المؤقت للموارد المعدلة

يحتفظ DSC بذاكرة تخزين مؤقت للموارد المكتشفة المكيفة لتحسين الأداء. يعتمد موقع ذاكرة التخزين المؤقت على نظام التشغيل ، كما هو موضح في الجدول التالي.

نظام التشغيل مسار ذاكرة التخزين المؤقت
Linux ~/.dsc/AdaptedResourcesLookupTable.json
macOS ~/.dsc/AdaptedResourcesLookupTable.json
بالنسبة لنظام التشغيل %LOCALAPPDATA%\dsc\AdaptedResourcesLookupTable.json

امثله

مثال 1 - سرد جميع الموارد غير المتكيفة

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

dsc resource list

Type                                        Kind      Version  Capabilities  RequireAdapter  Description
--------------------------------------------------------------------------------------------------------------------------------------------------------------
Microsoft.DSC.Debug/Echo                    Resource  1.0.0    gs--t---
Microsoft.DSC.Transitional/RunCommandOnSet  Resource  0.1.0    gs------                      Takes a single-command line to execute on DSC set operation      
Microsoft.DSC/Assertion                     Group     0.1.0    gs--t---                      `test` will be invoked for all resources in the supplied configu…
Microsoft.DSC/Group                         Group     0.1.0    gs--t---                      All resources in the supplied configuration is treated as a grou…
Microsoft.DSC/Include                       Importer  0.1.0    gs--t---                      Allows including a configuration file with optional parameter fi…
Microsoft.DSC/PowerShell                    Adapter   0.1.0    gs--t-e-                      Resource adapter to classic DSC Powershell resources.
Microsoft.Windows/RebootPending             Resource  0.1.0    g-------                      Returns info about pending reboot.
Microsoft.Windows/Registry                  Resource  0.1.0    gs-w-d--                      Manage Windows Registry keys and values
Microsoft.Windows/WMI                       Adapter   0.1.0    g-------                      Resource adapter to WMI resources.
Microsoft.Windows/WindowsPowerShell         Adapter   0.1.0    gs--t---                      Resource adapter to classic DSC Powershell resources in Windows …
Microsoft/OSInfo                            Resource  0.1.0    g-----e-                      Returns information about the operating system.

مثال 2 - سرد مورد معين

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

dsc resource list Microsoft.DSC/Group

Type                 Kind   Version  Capabilities  RequireAdapter  Description
-------------------------------------------------------------------------------------------------------------------------------------
Microsoft.DSC/Group  Group  0.1.0    gs--t---                      All resources in the supplied configuration is treated as a group.

مثال 3 - سرد الموارد باسم نوع مطابق

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

dsc resource list Microsoft.DSC/*

Type                      Kind      Version  Capabilities  RequireAdapter  Description
--------------------------------------------------------------------------------------------------------------------------------------------------
Microsoft.DSC/Assertion   Group     0.1.0    gs--t---                      `test` will be invoked for all resources in the supplied configuration.
Microsoft.DSC/Group       Group     0.1.0    gs--t---                      All resources in the supplied configuration is treated as a group.
Microsoft.DSC/Include     Importer  0.1.0    gs--t---                      Allows including a configuration file with optional parameter file.
Microsoft.DSC/PowerShell  Adapter   0.1.0    gs--t-e-                      Resource adapter to classic DSC Powershell resources.

مثال 4 - سرد الموارد مع وصف مطابق

عندما يتضمن الأمر الخيار *--description ، تتضمن النتائج الموارد التي تحتوي على وصف يحتوي على القيمة المحددة.

dsc resource list --description 'supplied configuration'

Type                     Kind   Version  Capabilities  RequireAdapter  Description
----------------------------------------------------------------------------------------------------------------------------------------------
Microsoft.DSC/Assertion  Group  0.1.0    gs--t---                      `test` will be invoked for all resources in the supplied configuration.
Microsoft.DSC/Group      Group  0.1.0    gs--t---                      All resources in the supplied configuration is treated as a group.

مثال 5 - سرد الموارد بعلامات مطابقة

عندما يتضمن الأمر مثيلات متعددة من الخيار --tags ، تتضمن النتائج الموارد التي تحتوي على أي من العلامات المحددة.

dsc resource list --tags Windows --tags Linux

Type                        Kind      Version  Capabilities  RequireAdapter  Description
----------------------------------------------------------------------------------------------------------------------------
Microsoft.Windows/Registry  Resource  0.1.0    gs-w-d--                      Manage Windows Registry keys and values
Microsoft/OSInfo            Resource  0.1.0    g-----e-                      Returns information about the operating system.

مثال 6 - سرد الموارد لمحول معين

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

dsc resource list --adapter Microsoft.Windows/WindowsPowerShell

يحدد هذا الأمر التالي عامل تصفية *Windows*اسم المورد ، مما يحد من قائمة الموارد التي تم إرجاعها:

dsc resource list --adapter Microsoft.Windows/WindowsPowerShell *Windows*

الحجج

RESOURCE_NAME

تحديد عامل تصفية اختياري لتطبيقه على أسماء أنواع موارد DSC المكتشفة. يمكن أن يتضمن عامل التصفية أحرف بدل (*). عامل التصفية غير حساس لحالة الأحرف.

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

على سبيل المثال، يؤدي تحديد عامل التصفية Microsoft.* إلى إرجاع الموارد المنشورة بواسطة Microsoft فقط. يؤدي تحديد عامل التصفية *Sql* إلى إرجاع أي مورد به السلسلة Sql في اسمها، بغض النظر عن الغلاف.

Type      : string
Mandatory : false

خيارات

-a، --محول

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

عند استخدام هذا الخيار، لا يقوم الأمر بإرجاع أي موارد غير معدلة.

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

Type        : string
Mandatory   : false
LongSyntax  : --adapter <ADAPTER_NAME>
ShortSyntax : -a <ADAPTER_NAME>

-d، --description

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

Type        : string
Mandatory   : false
LongSyntax  : --description <DESCRIPTION>
ShortSyntax : -d <DESCRIPTION>

-t، --العلامات

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

يمكنك تحديد هذا الخيار أكثر من مرة للتصفية على مجموعة من العلامات. تتضمن النتائج الموارد التي تحتوي على علامة واحدة على الأقل محددة مع هذا الخيار.

Type        : string
Mandatory   : false
LongSyntax  : --tags <TAGS>
ShortSyntax : -t <TAGS>

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

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

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

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

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

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

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

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

-h، --help

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

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

الناتج

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

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

  • النوع - اسم النوع المؤهل بالكامل للمورد.

  • النوع - ما إذا كان المورد adapter، groupأو importerنموذجي Resource. لمزيد من المعلومات، راجع مرجع مخطط نوع مورد DSC.

  • الإصدار - النسخة الدلالية للمورد.

  • القدرات - عرض لقدرات المورد كعلامات. يتم عرض الإمكانات بالترتيب التالي، باستخدام الحرف - بدلا من الحرف المناسب إذا لم يكن للمورد قدرة محددة:

    على سبيل المثال، يحتوي المورد Microsoft.Windows/Registry على الإمكانات التالية: gs--d-، مما يشير إلى أنه يحتوي على القدرات get، setوقدرات delete .

  • RequireAdapter - اسم النوع المؤهل بالكامل لمورد المحول الذي يستخدمه DSC لاستدعاء المورد الذي تم إرجاعه.

  • الوصف - الوصف المختصر للغرض من المورد واستخدامه.

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

  • Last updated on