set di risorse dsc

Riepilogo

Richiama l'operazione set 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 set sottocomando applica lo stato desiderato di un'istanza della risorsa e restituisce lo stato finale.

Questo sottocomando imposta un'istanza di una risorsa DSC specifica. Per impostare più risorse, usare un gruppo di risorse o il comando dsc config set .

Lo stato desiderato dell'istanza da impostare 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 .

Questo sottocomando può essere richiamato solo per le risorse DSC basate su comandi che definiscono la set sezione del manifesto della risorsa. Se questo sottocomando viene chiamato per una risorsa che non definisce un'operazione set, DSC genera un errore.

Importante

Il dsc resource set comando richiama sempre l'operazione set per la risorsa. Le risorse possono, ma non sono necessarie, implementare la logica che pretesti un'istanza per l'operazione set .

Ciò è diverso dal funzionamento del set di configurazione dsc , in cui DSC testa sempre un'istanza, in modo sintetico o richiamando l'operazione test per la risorsa e richiama set solo per un'istanza se non è nello stato desiderato.

Le risorse basate su comandi indicano se implementano pretesto per l'operazione set definendo la proprietà set.implementsPretest nel manifesto della risorsa. Se tale proprietà è definita come true, indica che la risorsa implementa pretesto. Se set.implementsPretest è impostato su false o non è definito, il manifesto indica che la risorsa non implementa pretesto.

Se una risorsa indica che implementa pretesto, gli utenti devono aspettarsi che la risorsa modifichi un'istanza solo durante un'operazione set se il pretesto indica che l'istanza non è nello stato desiderato.

Se una risorsa non implementa pretesto, gli utenti devono aspettarsi che la risorsa modifichi sempre un'istanza durante un'operazione set .

Per le risorse che non implementano pretesto per l'operazione set , Microsoft consiglia sempre di chiamare dsc resource test su un'istanza di per verificare se si trova nello stato desiderato prima di richiamare dsc resource set. Ciò consente di evitare errori accidentali causati da risorse che non implementano un comando completamente idempotente set .

Esempio

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

Il comando garantisce che la Example chiave esista 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 set --resource Microsoft.Windows/Registry

Esempio 2 - Impostazione di una risorsa con l'opzione di input

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

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

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

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

cat ./example.yaml

keyPath: HKCU\\Example
_exist:  true

dsc resource set --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 effettivo dell'istanza prima e dopo l'operazione di impostazione e l'elenco di proprietà modificate dall'operazione di impostazione. Per altre informazioni, vedere Schema dei risultati del set di risorse dsc.