Получение ресурса dsc

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

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

Синтаксис

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

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

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

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

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

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

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

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

Описание

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

По умолчанию эта подкоманда возвращает один экземпляр из определенного ресурса DSC. Чтобы вернуть несколько ресурсов, используйте --all параметр a resource group или команду dsc config get .

Все свойства, необходимые ресурсу для получения состояния экземпляра, должны быть переданы этой команде в виде объекта JSON или YAML с параметром or --input--file .

Примеры

Пример 1 - Получение экземпляра ресурса без каких-либо входных данных

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

dsc resource get --resource Microsoft/OSInfo

actualState:
  $id: https://developer.microsoft.com/json-schemas/dsc/os_info/20230303/Microsoft.Dsc.OS_Info.schema.json
  family: Windows
  version: 10.0.22621
  edition: Windows 11 Enterprise
  bitness: '64'

Пример 2 - Получение экземпляра ресурса с опцией input

Если ресурсу требуется одно или несколько значений свойства для возврата фактического состояния экземпляра, свойства экземпляра могут быть переданы с параметром --input JSON или YAML.

dsc resource get --resource Microsoft.Windows/Registry --input '{
    "keyPath": "HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion",
    "valueName": "SystemRoot"
}'

actualState:
  $id: https://developer.microsoft.com/json-schemas/windows/registry/20230303/Microsoft.Windows.Registry.schema.json
  keyPath: HKLM\Software\Microsoft\Windows NT\CurrentVersion
  valueName: SystemRoot
  valueData:
    String: C:\WINDOWS

Пример 3 - Получение экземпляра ресурса с входными данными из stdin

Если ресурсу требуется одно или несколько значений свойства для возврата фактического состояния экземпляра, свойства экземпляра можно передать через stdin в формате JSON или YAML с этим параметром --file .

'{
    "keyPath": "HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion",
    "valueName": "SystemRoot"
}' | dsc resource get --resource Microsoft.Windows/Registry --file -

actualState:
  $id: https://developer.microsoft.com/json-schemas/windows/registry/20230303/Microsoft.Windows.Registry.schema.json
  keyPath: HKLM\Software\Microsoft\Windows NT\CurrentVersion
  valueName: SystemRoot
  valueData:
    String: C:\WINDOWS

Пример 4 — получение экземпляра ресурса с входными данными из файла YAML

Если ресурсу требуется одно или несколько значений свойства для возврата фактического состояния экземпляра, свойства экземпляра можно получить из сохраненного файла JSON или YAML.

# ./example.yaml
keyPath:   HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion
valueName: SystemRoot

dsc resource get --resource Microsoft.Windows/Registry --path ./example.yaml

actualState:
  $id: https://developer.microsoft.com/json-schemas/windows/registry/20230303/Microsoft.Windows.Registry.schema.json
  keyPath: HKLM\Software\Microsoft\Windows NT\CurrentVersion
  valueName: SystemRoot
  valueData:
    String: C:\WINDOWS

Опции

-а, --все

Указывает, что команда должна возвращать каждый экземпляр указанного ресурса DSC, а не конкретный экземпляр.

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

Если указан этот параметр, DSC игнорирует --input параметры and --path .

Type:      Boolean
Mandatory: false

-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 выдает ошибку.

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

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

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

-o, --output-format

Эта --output-format опция определяет, какой формат DSC использует для данных, возвращаемых командой. Доступные форматы:

• json , чтобы выдать данные в виде строки JSON. При использовании параметра --all каждый экземпляр возвращается в виде строки JSON.
• pretty-json , чтобы выдать данные в формате JSON с переводом строк, отступами и пробелами для удобочитаемости.
• yaml , чтобы выдавать данные в формате YAML. При использовании этого --all параметра каждый экземпляр возвращается как документ YAML с разделителем документов между каждым возвращенным экземпляром --- .
• json-array , чтобы выдать данные в виде одного массива JSON, содержащего каждый объект. Эта опция действительна только с опцией --all.
• pass-through , чтобы вернуть данные из ресурса напрямую, не оборачивая их в результат DSC. При использовании этого варианта вывода сгенерированная строка JSON привязывается к схеме экземпляра ресурса, а не к схеме получения результата DSC.

Формат вывода по умолчанию зависит от того, обнаруживает ли DSC, что вывод перенаправляется или записывается как переменная:

• Если команда не перенаправляется или не записывается, DSC отображает выходные данные в виде формата yaml в консоли.
• Если вывод команды перенаправляется или записывается, DSC выдает данные в json формате stdout.

При использовании этого параметра DSC использует указанный формат независимо от того, перенаправляется ли команда или захватывается.

Если команда не перенаправляется или не записывается, выходные данные в консоли форматируются для улучшения читаемости. Если команда не перенаправляется или не записывается, выходные данные включают последовательности терминалов для форматирования.

Type        : string
Mandatory   : false
ValidValues : [json, pretty-json, yaml, json-array, pass-through]
LongSyntax  : --output-format <OUTPUT_FORMAT>
ShortSyntax : -o <OUTPUT_FORMAT>

-h, --помощь

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

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

Выходные данные

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

Дополнительные сведения о структуре выходного JSON см. в разделе Схема результата получения ресурса dsc.

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