Тест ресурсов dsc

Краткий обзор

Вызывает тестовую операцию ресурса.

Синтаксис

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

<instance-properties> | dsc resource set [Options] --resource <RESOURCE>

Свойства экземпляра из входного параметра

dsc resource set --input '<instance-properties>' --resource <RESOURCE>

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

dsc resource set --path <instance-properties-filepath> --resource <RESOURCE>

Описание

Подкоманда test проверяет фактическое состояние экземпляра ресурса на соответствие требуемому состоянию.

Эта подкоманда проверяет один экземпляр определенного ресурса DSC. Чтобы протестировать несколько ресурсов, используйте группу ресурсов или команду dsc config test .

Требуемое состояние проверяемого экземпляра должно быть передано этой команде в виде объекта JSON или YAML. Свойства объекта должны быть допустимыми свойствами для ресурса. Свойства экземпляра можно передать в эту команду из stdin в виде строки с параметром --input или из сохраненного файла с параметром --path .

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

Эта команда проверяет свойства экземпляра только при двух условиях:

1. Когда свойство явно включается в входные данные требуемого состояния.
2. Если свойство имеет значение по умолчанию и не включается явным образом во входные данные требуемого состояния.

Примеры

Пример 1. Тестирование ресурса со свойствами из stdin

Команда проверяет, Example существует ли ключ в кусте текущего пользователя. Он задает свойства экземпляра ресурса как JSON и передает их из stdin.

'{
    "keyPath": "HKCU\\Example",
    "_exist": true
}' | dsc resource test --resource Microsoft.Windows/Registry

Пример 2. Тестирование ресурса с параметром ввода

Команда проверяет, Example существует ли ключ в кусте текущего пользователя. Он задает свойства экземпляра ресурса как JSON и передает их с параметром ввода .

dsc resource test --resource Microsoft.Windows/Registry --input '{
    "keyPath": "HKCU\\Example",
    "_exist": true
}'

Пример 3. Тестирование ресурса со свойствами из ФАЙЛА YAML

Команда проверяет, Example существует ли ключ в кусте текущего пользователя. Он задает путь к YAML-файлу, определяя свойства экземпляра ресурса с параметром path .

keyPath: HKCU\\Example
_exist:  true

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

Варианты

-r, --resource

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

Полный синтаксис имени типа: <owner>[.<group>][.<area>]/<name>, где:

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

Type:      String
Mandatory: true

-i, --input

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

Этот параметр нельзя использовать со свойствами экземпляра над stdin или параметром --path . Выберите, следует ли передавать свойства экземпляра команде через stdin, из файла с параметром --path или с параметром --input .

Type:      String
Mandatory: false

-p, --path

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

Этот параметр является взаимоисключающим с параметром --input . При использовании этого параметра DSC игнорирует любые входные данные из stdin.

Type:      String
Mandatory: false

-f, --format

Параметр --format управляет форматом выходных данных консоли для команды. Если выходные данные команды перенаправляются или записываются в виде переменной, выходные данные всегда будут json.

Type:         String
Mandatory:    false
DefaultValue: yaml
ValidValues:  [json, pretty-json, yaml]

-h, --help

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

Type:      Boolean
Mandatory: false

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

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