Экспорт конфигурации 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 с опцией or --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>

-f, --файл

Определяет путь к документу конфигурации для проверки состояния.

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

Вы также можете использовать эту опцию для передачи конфигурационного документа из стандартного ввода, как показано в примере 1.

Этот вариант является взаимоисключающим с вариантом --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.