다음을 통해 공유

dsc 구성 테스트

개요

구성 문서의 리소스 인스턴스가 원하는 상태인지 확인합니다.

문법

파일의 구성 문서

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

옵션 문자열의 구성 문서

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

stdin의 구성 문서

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

stdin의 매개변수가 있는 파일의 구성 문서

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

stdin의 매개변수가 있는 옵션 문자열의 구성 문서

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

설명

subcommand는 test 구성 문서의 자원 인스턴스가 원하는 상태인지 여부를 확인합니다. 이 명령이 실행되면 DSC는 문서에 정의된 각 리소스 인스턴스에 대한 테스트 작업을 호출하기 전에 구성 문서의 유효성을 검사합니다.

구성 문서는 or --file 옵션을 사용하여 --input JSON 또는 YAML로 이 명령에 전달되어야 합니다.

예시

예제 1 - 구성의 리소스 인스턴스가 원하는 상태인지 테스트

이 명령은 로 example.dsc.config.yaml저장된 구성 문서에 정의된 리소스 인스턴스에 대한 상태, 원하는 상태, 실제 상태 및 다른 속성을 반환합니다. 옵션을 사용하여 --file stdin의 명령에 구성 문서를 전달합니다.

# 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 test --file -

예제 2 - 구성 문서로 읽을 파일 전달

이 명령은 옵션을 --file 사용하여 파일에 정의된 구성의 유효성을 검증합니다 example.dsc.config.yaml .

dsc config test --file ./example.dsc.config.yaml

예제 3 - 구성 문서를 변수로 전달

이 명령은 옵션을 --input 사용하여 변수에 저장된 구성의 유효성을 검사합니다 $desired .

dsc config test --input $desired

옵션

-i, --입력

상태의 유효성을 검사할 구성 문서를 지정합니다.

문서는 JSON 또는 YAML 객체를 포함하는 문자열이어야 합니다. DSC는 구성 문서 스키마에 대해 문서의 유효성을 검사합니다. 유효성 검사에 실패하면 DSC에서 오류가 발생합니다.

이 옵션은 옵션과 함께 사용할 수 --file 없습니다.

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

-f, --파일

상태의 유효성을 검사할 구성 문서의 경로를 정의합니다.

지정된 파일에는 구성 문서가 JSON 또는 YAML 개체로 포함되어야 합니다. DSC는 구성 문서 스키마에 대해 문서의 유효성을 검사합니다. 유효성 검사에 실패하거나 지정된 파일이 없는 경우 DSC에서 오류가 발생합니다.

이 옵션을 사용하여 Example 1과 같이 stdin에서 구성 문서를 전달할 수도 있습니다.

이 옵션은 옵션과 함께 사용할 수 --input 없습니다.

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

-o, --출력 형식

이 --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 옵션을 참조하십시오.

  • Last updated on