Экспорт ресурсов dsc

Краткие сведения

Создает документ конфигурации, определяющий существующие экземпляры определенного ресурса.

Синтаксис

Без свойств экземпляра

dsc resource export [Options] --resource <RESOURCE>

Свойства экземпляра из опции input

dsc resource export --input <INPUT> --resource <RESOURCE>

Свойства экземпляра из файла

dsc resource export --file <FILE> --resource <RESOURCE>

Свойства экземпляра из stdin

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

Описание

Подкоманда export создает документ конфигурации, который включает каждый экземпляр определенного ресурса. Ресурс должен быть указан с помощью --resource опции.

Начиная с DSC 3.1.0, можно использовать --input параметр or --file для указания экземпляра ресурса, который будет использоваться в качестве фильтра для экспортируемых ресурсов. Когда вы это сделаете, указанный экземпляр будет передан ресурсу для использования в фильтрации. Реализация фильтрации зависит от каждого ресурса, а не от самой DSC.

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

Опции

-r, --resource

Указывает полное имя типа ресурса DSC для экспорта, например Microsoft.Windows/Registry.

Полный синтаксис имени типа выглядит следующим образом: <owner>[.<group>][.<area>]/<name>, где:

• Это owner поддерживающий автор или организация для ресурса.
• И grouparea — это необязательные компоненты имен, которые обеспечивают пространство имен для ресурса.
• Определяет name компонент, которым управляет ресурс.

Type        : string
Mandatory   : true
LongSyntax  : --resource <RESOURCE>
ShortSyntax : -r <RESOURCE>

-i, --input

Указывает экземпляр ресурса, который будет использоваться в качестве фильтра для экспортируемых экземпляров ресурсов.

Экземпляр должен быть строкой, содержащей объект JSON или YAML. DSC проверяет объект на соответствие схеме экземпляра ресурса. Если проверка завершается неудачей, DSC выдает ошибку.

Этот вариант является взаимоисключающим с вариантом --file .

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

-f, --файл

Определяет путь к файлу, определяющий экземпляр ресурса, который будет использоваться в качестве фильтра для экспортируемых экземпляров ресурсов.

Указанный файл должен содержать объект JSON или YAML, представляющий допустимые свойства для ресурса. DSC проверяет объект на соответствие схеме экземпляра ресурса. Если проверка завершается ошибкой или если указанный файл не существует, DSC выдает ошибку.

Этот вариант является взаимоисключающим с вариантом --input .

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

-o, --output-format

Эта --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.