Получение конфигурации dsc

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

Извлекает текущее состояние экземпляров ресурсов в документе конфигурации.

Синтаксис

Конфигурационный документ из файла

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

Документ конфигурации из строки опций

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

Конфигурационный документ из stdin

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

Конфигурационный документ из файла с параметрами из stdin

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

Конфигурационный документ из строки опций с параметрами из stdin

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

Описание

Подкоманда get возвращает фактическое состояние экземпляров ресурса в документе конфигурации. При выполнении этой команды DSC проверяет документ конфигурации перед вызовом операции get для каждого экземпляра ресурса, определенного в документе.

Документ конфигурации должен быть передан этой команде в формате JSON или YAML с опцией or --input--file .

Примеры

Пример 1 — получение информации о текущем состоянии экземпляров ресурсов конфигурации

Команда возвращает фактическое состояние экземпляров ресурсов, определенных в документе конфигурации, сохраненных как example.dsc.config.yaml. Он передает документ конфигурации команде из stdin с помощью --file опции.

# example.dsc.config.yaml
$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
resources:
- name: Windows only
  type: Microsoft.DSC/Assertion
  properties:
    $schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
    resources:
    - name: os
      type: Microsoft/OSInfo
      properties:
        family: Windows
- name: Current user registry example
  type: Microsoft.Windows/Registry
  properties:
    keyPath: HKCU\example
    _exist: true
  dependsOn:
    - "[resourceId('Microsoft.DSC/Assertion', 'Windows only')"

cat ./example.dsc.config.yaml | dsc config get --file -

Пример 2 - Передача файла на чтение в качестве конфигурационного документа

Команда использует --file опцию для извлечения экземпляров ресурсов, определенных в файле example.dsc.config.yaml .

dsc config get --path ./example.dsc.config.yaml

Пример 3 - Передача конфигурационного документа в качестве переменной

Команда использует --input опцию для извлечения экземпляров ресурсов, определенных в документе конфигурации, $desired хранящемся в переменной.

dsc config get --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 config.

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

  • Last updated on