Test delle risorse dsc

Riepilogo

Richiama l'operazione di test di una risorsa.

Sintassi

Proprietà dell'istanza da stdin

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

Proprietà dell'istanza dall'opzione di input

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

Proprietà dell'istanza dal file

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

Descrizione

Il test sottocomando convalida lo stato effettivo di un'istanza di risorsa rispetto a uno stato desiderato.

Questo sottocomando testa un'istanza di una risorsa DSC specifica. Per testare più risorse, usare un gruppo di risorse o il comando dsc config test .

Lo stato desiderato dell'istanza da testare deve essere passato a questo comando come oggetto JSON o YAML. Le proprietà dell'oggetto devono essere proprietà valide per la risorsa. Le proprietà dell'istanza possono essere passate a questo comando da stdin, come stringa con l'opzione --input o da un file salvato con l'opzione --path .

Se questo comando viene richiamato per una risorsa DSC basata su comandi che non definisce la propria operazione di test, DSC esegue un test sintetico. Il test sintetico confronta ogni proprietà per lo stato desiderato di un'istanza rispetto allo stato effettivo. Il test sintetico usa un'equivalenza rigorosa e con distinzione tra maiuscole e minuscole. Se lo stato desiderato per una proprietà e lo stato effettivo non sono uguali, DSC contrassegna la proprietà come fuori dello stato desiderato.

Questo comando convalida solo le proprietà dell'istanza in due condizioni:

1. Quando la proprietà viene inclusa in modo esplicito nell'input dello stato desiderato.
2. Quando la proprietà ha un valore predefinito e non è inclusa in modo esplicito nell'input dello stato desiderato.

Esempio

Esempio 1- Test di una risorsa con proprietà da stdin

Il comando verifica se la Example chiave esiste nell'hive utente corrente. Specifica le proprietà dell'istanza della risorsa come JSON e le passa da stdin.

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

Esempio 2: Test di una risorsa con l'opzione di input

Il comando verifica se la Example chiave esiste nell'hive utente corrente. Specifica le proprietà dell'istanza della risorsa come JSON e le passa con l'opzione di input .

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

Esempio 3- Test di una risorsa con proprietà da un file YAML

Il comando verifica se la Example chiave esiste nell'hive utente corrente. Specifica il percorso di un file YAML che definisce le proprietà dell'istanza della risorsa con l'opzione path .

keyPath: HKCU\\Example
_exist:  true

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

Opzioni

-r, --resource

Specifica il nome completo del tipo della risorsa DSC da usare, ad esempio Microsoft.Windows/Registry.

La sintassi del nome completo del tipo è: <owner>[.<group>][.<area>]/<name>, dove:

• owner è l'autore o l'organizzazione per la risorsa.
• e grouparea sono componenti dei nomi facoltativi che abilitano l'applicazione dei nomi per una risorsa.
• Identifica name il componente gestito dalla risorsa.

Type:      String
Mandatory: true

-i, --input

Specifica un oggetto JSON o YAML con le proprietà che definiscono lo stato desiderato di un'istanza della risorsa DSC. DSC convalida l'oggetto rispetto allo schema dell'istanza della risorsa. Se la convalida non riesce, DSC genera un errore.

Questa opzione non può essere usata con le proprietà dell'istanza su stdin o l'opzione --path . Scegliere se passare le proprietà dell'istanza al comando su stdin, da un file con l'opzione --path o con l'opzione --input .

Type:      String
Mandatory: false

-p, --path

Definisce il percorso di un file di testo da leggere come input per il comando anziché eseguire il piping dell'input da stdin o passarlo come stringa con l'opzione --input . Il file specificato deve contenere JSON o YAML che rappresenta le proprietà valide per la risorsa. DSC convalida l'oggetto rispetto allo schema dell'istanza della risorsa. Se la convalida non riesce o se il file specificato non esiste, DSC genera un errore.

Questa opzione si escludono a vicenda con l'opzione --input . Quando si usa questa opzione, DSC ignora qualsiasi input da stdin.

Type:      String
Mandatory: false

-f, --format

L'opzione --format controlla il formato di output della console per il comando . Se l'output del comando viene reindirizzato o acquisito come variabile, l'output è sempre JSON.

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

-h, --help

Visualizza la Guida per il comando o il sottocomando corrente. Quando si specifica questa opzione, l'applicazione ignora tutte le opzioni e gli argomenti dopo questo.

Type:      Boolean
Mandatory: false

Output

Questo comando restituisce l'output JSON che include lo stato desiderato dell'istanza, lo stato effettivo, l'elenco di proprietà fuori dallo stato desiderato e un valore booleano che indica se l'istanza è nello stato desiderato. Per altre informazioni, vedere Schema dei risultati del test delle risorse dsc.