Prueba de recursos dsc

Sinopsis

Invoca la operación de prueba de un recurso.

Syntax

Propiedades de instancia de stdin

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

Propiedades de instancia de la opción de entrada

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

Propiedades de instancia del archivo

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

Descripción

El test subcomando valida el estado real de una instancia de recurso con un estado deseado.

Este subcomando prueba una instancia de un recurso de DSC específico. Para probar varios recursos, use un grupo de recursos o el comando dsc config test .

El estado deseado de la instancia que se va a probar debe pasar a este comando como un objeto JSON o YAML. Las propiedades del objeto deben ser propiedades válidas para el recurso. Las propiedades de instancia se pueden pasar a este comando desde stdin, como una cadena con la --input opción o desde un archivo guardado con la --path opción .

Si se invoca este comando para un recurso de DSC basado en comandos que no define su propia operación de prueba, DSC realiza una prueba sintética. La prueba sintética compara cada propiedad para el estado deseado de una instancia con el estado real. La prueba sintética usa equivalencia estricta y con distinción entre mayúsculas y minúsculas. Si el estado deseado para una propiedad y el estado real no son los mismos, DSC marca la propiedad como fuera del estado deseado.

Este comando solo valida las propiedades de instancia en dos condiciones:

1. Cuando la propiedad se incluye explícitamente en la entrada de estado deseada.
2. Cuando la propiedad tiene un valor predeterminado y no se incluye explícitamente en la entrada de estado deseado.

Ejemplos

Ejemplo 1: Prueba de un recurso con propiedades de stdin

El comando comprueba si la Example clave existe en el subárbol del usuario actual. Especifica las propiedades de la instancia de recurso como JSON y las pasa desde stdin.

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

Ejemplo 2: Prueba de un recurso con la opción de entrada

El comando comprueba si la Example clave existe en el subárbol del usuario actual. Especifica las propiedades de la instancia de recurso como JSON y las pasa con la opción de entrada .

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

Ejemplo 3: Prueba de un recurso con propiedades de un archivo YAML

El comando comprueba si la Example clave existe en el subárbol del usuario actual. Especifica la ruta de acceso a un archivo YAML que define las propiedades de la instancia de recurso con la opción path .

keyPath: HKCU\\Example
_exist:  true

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

Opciones

-r, --resource

Especifica el nombre de tipo completo del recurso de DSC que se va a usar, como Microsoft.Windows/Registry.

La sintaxis de nombre de tipo completo es: <owner>[.<group>][.<area>]/<name>, donde:

• owner es el autor u organización que mantiene el recurso.
• y grouparea son componentes de nombre opcionales que habilitan el espaciado de nombres para un recurso.
• name identifica el componente que administra el recurso.

Type:      String
Mandatory: true

-i, --input

Especifica un objeto JSON o YAML con las propiedades que definen el estado deseado de una instancia de recurso de DSC. DSC valida el objeto en el esquema de instancia del recurso. Si se produce un error en la validación, DSC genera un error.

Esta opción no se puede usar con propiedades de instancia sobre stdin o la --path opción . Elija si se pasan las propiedades de instancia al comando a través de stdin, desde un archivo con la --path opción o con la --input opción .

Type:      String
Mandatory: false

-p, --path

Define la ruta de acceso a un archivo de texto que se va a leer como entrada para el comando en lugar de canalizar la entrada desde stdin o pasarla como una cadena con la --input opción . El archivo especificado debe contener JSON o YAML que represente propiedades válidas para el recurso. DSC valida el objeto en el esquema de instancia del recurso. Si se produce un error en la validación o si el archivo especificado no existe, DSC genera un error.

Esta opción es mutuamente excluyente con la --input opción . Al usar esta opción, DSC omite cualquier entrada de stdin.

Type:      String
Mandatory: false

-f, --format

La --format opción controla el formato de salida de la consola para el comando . Si la salida del comando se redirige o captura como una variable, la salida siempre es JSON.

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

-h, --help

Muestra la ayuda del comando o subcomando actual. Al especificar esta opción, la aplicación omite todas las opciones y argumentos después de esta.

Type:      Boolean
Mandatory: false

Resultados

Este comando devuelve una salida JSON que incluye el estado deseado de la instancia, el estado real, la lista de propiedades que están fuera del estado deseado y un valor booleano que indica si la instancia está en el estado deseado. Para obtener más información, consulte esquema de resultados de pruebas de recursos dsc.