Список ресурсов dsc

Синопсис

Извлекает список доступных ресурсов DSC с помощью необязательного фильтра.

Синтаксис

dsc resource list [Options] <RESOURCE_NAME>

Описание

Подкоманда list выполняет поиск доступных ресурсов DSC и возвращает информацию о них. DSC обнаруживает ресурсы, сначала выполняя поиск PATH в переменной среды or DSC_RESOURCE_PATH для .dsc.resource.json, .dsc.resource.ymlи dsc.resource.yaml файлов. Дополнительные сведения о переменных среды, используемых DSC, см. в разделе Переменные среды

Если какой-либо из обнаруженных ресурсов является адаптером ресурсов, DSC вызывает list операцию для этих адаптеров, если параметр --adapter указывает соответствующий фильтр. По умолчанию DSC не возвращает адаптированные ресурсы. Когда вы используете эту --adapter опцию, команда не возвращает неадаптированные ресурсы.

DSC возвращает список обнаруженных ресурсов с информацией о реализации и метаданными. Если команда содержит аргумент, RESOURCE_NAME DSC фильтрует список обнаруженных ресурсов перед их возвратом. Опции --description and --tags фильтруют результаты по описаниям и тегам ресурсов. Фильтры всегда применяются после обнаружения ресурсов.

Адаптированный кэш ресурсов

DSC поддерживает кэш обнаруженных адаптированных ресурсов для оптимизации производительности. Расположение кэша зависит от операционной системы, как показано в следующей таблице.

Операционная система	Путь к кэшу
Линукс	`~/.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.* будут возвращены только ресурсы, опубликованные корпорацией Майкрософт. Указание фильтра *Sql* возвращает любой ресурс со строкой Sql в имени, независимо от регистра.

Type      : string
Mandatory : false

Параметры

-a, --адаптер

Задает фильтр для определения ресурсов адаптера для перечисления адаптированных ресурсов. По умолчанию команда не вызывает list команду для ресурсов адаптера. При указании этого параметра DSC ищет ресурсы адаптера с именами типов, соответствующими фильтру. Если он обнаруживает какие-либо адаптеры, соответствующие фильтру, он вызывает list команду для этих адаптеров и возвращает адаптированные ресурсы. DSC извлекает адаптированные ресурсы перед применением других фильтров для команды.

При использовании этого параметра команда не возвращает неадаптированные ресурсы.

Если вы укажете этот параметр в фильтре *, DSC вызовет list каждый найденный ресурс адаптера, прежде чем применить другие фильтры.

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

-d, --описание

Указывает строку для сопоставления в описании ресурса. Если этот параметр указан, 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

Эта --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, --помощь

Отображает справку для текущей команды или подкоманда. При указании этого параметра приложение игнорирует все остальные параметры и аргументы.

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

Выпуск

Эта команда возвращает отформатированный массив, содержащий объект для каждого ресурса, который включает тип, версию, параметры манифеста и другие метаданные. Дополнительные сведения см. в разделе Результирующая схема списка ресурсов dsc.

Если выходные данные команды не записываются или перенаправляются, она отображается в консоли по умолчанию в виде сводной таблицы для возвращаемых ресурсов. Сводная таблица содержит следующие столбцы, отображаемые в указанном порядке:

Type — полное имя типа ресурса.
Kind — является ли ресурс , adapter, group, или типичным importerResource. Дополнительные сведения см. в справочнике по схеме типа ресурсов DSC.
Version - Семантическая версия ресурса.
Capabilities (Возможности ) — отображение возможностей ресурса в виде флагов. Возможности отображаются в следующем порядке, с использованием буквы вместо - нужной, если ресурс не имеет определенной возможности:
- g Указывает, что ресурс имеет возможность GET.
- s указывает, что ресурс имеет установленную возможность
- x указывает, что ресурс имеет возможность setHandlesExist
- w указывает, что ресурс имеет возможность whatIf
- t указывает, что ресурс имеет возможность тестирования
- d указывает, что ресурс имеет возможность удаления
- e указывает, что ресурс имеет возможность экспорта
- r указывает, что ресурс имеет возможность разрешения
Например, Microsoft.Windows/Registry ресурс имеет следующие возможности: gs--d-, указывая на то, что у него есть getвозможности , setи delete .
RequireAdapter — полное имя типа ресурса адаптера, который DSC использует для вызова возвращенного ресурса.
Description - Краткое описание назначения и использования ресурса.

Для получения дополнительной информации о форматировании выходных данных см. опцию --output-format.

Обратная связь

Были ли сведения на этой странице полезными?

Last updated on 2025-07-10