Remarque
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de vous connecter ou de modifier des répertoires.
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de modifier des répertoires.
Synopsis
Récupère l’état réel d’une instance de ressource.
Syntaxe
Sans propriétés d’instance
dsc resource get [Options] --resource <RESOURCE>
Propriétés d’instance à partir de l’option d’entrée
dsc resource get --input <INPUT> --resource <RESOURCE>
Propriétés d’instance à partir du fichier
dsc resource get --file <FILE> --resource <RESOURCE>
Propriétés d’instance à partir de stdin
cat <FILE> | dsc resource get [Options] --resource <RESOURCE> --file -
Descriptif
La get sous-commande renvoie l’état actuel d’une instance de ressource.
Par défaut, cette sous-commande retourne une instance à partir d’une ressource DSC spécifique. Pour retourner plusieurs ressources, utilisez le --all paramètre, un groupe de ressources ou la commande dsc config get .
Toutes les propriétés dont la ressource a besoin pour récupérer l’état d’une instance doivent être transmises à cette commande en tant qu’objet JSON ou YAML avec l’option --input or --file .
Exemples
Exemple 1 : obtenir une instance de ressource sans aucune entrée
Pour les ressources à instance unique qui n’ont pas besoin de valeurs de propriété pour retourner l’état réel de l’instance de ressource, les propriétés d’instance ne sont pas requises.
dsc resource get --resource Microsoft/OSInfo
actualState:
$id: https://developer.microsoft.com/json-schemas/dsc/os_info/20230303/Microsoft.Dsc.OS_Info.schema.json
family: Windows
version: 10.0.22621
edition: Windows 11 Enterprise
bitness: '64'
Exemple 2 - Obtenir une instance de ressource avec l’option d’entrée
Si une ressource nécessite une ou plusieurs valeurs de propriété pour retourner l’état réel de l’instance, les propriétés de l’instance peuvent être transmises avec l’option --input JSON ou YAML.
dsc resource get --resource Microsoft.Windows/Registry --input '{
"keyPath": "HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion",
"valueName": "SystemRoot"
}'
actualState:
$id: https://developer.microsoft.com/json-schemas/windows/registry/20230303/Microsoft.Windows.Registry.schema.json
keyPath: HKLM\Software\Microsoft\Windows NT\CurrentVersion
valueName: SystemRoot
valueData:
String: C:\WINDOWS
Exemple 3 - Obtenir une instance de ressource avec une entrée à partir de stdin
Si une ressource nécessite une ou plusieurs valeurs de propriété pour retourner l’état réel de l’instance, les propriétés de l’instance peuvent être transmises via stdin au format JSON ou YAML avec l’option --file .
'{
"keyPath": "HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion",
"valueName": "SystemRoot"
}' | dsc resource get --resource Microsoft.Windows/Registry --file -
actualState:
$id: https://developer.microsoft.com/json-schemas/windows/registry/20230303/Microsoft.Windows.Registry.schema.json
keyPath: HKLM\Software\Microsoft\Windows NT\CurrentVersion
valueName: SystemRoot
valueData:
String: C:\WINDOWS
Exemple 4 : obtenir une instance de ressource avec une entrée à partir d’un fichier YAML
Si une ressource nécessite une ou plusieurs valeurs de propriété pour retourner l’état réel de l’instance, les propriétés de l’instance peuvent être récupérées à partir d’un fichier JSON ou YAML enregistré.
# ./example.yaml
keyPath: HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion
valueName: SystemRoot
dsc resource get --resource Microsoft.Windows/Registry --path ./example.yaml
actualState:
$id: https://developer.microsoft.com/json-schemas/windows/registry/20230303/Microsoft.Windows.Registry.schema.json
keyPath: HKLM\Software\Microsoft\Windows NT\CurrentVersion
valueName: SystemRoot
valueData:
String: C:\WINDOWS
Paramètres
-a, --all
Spécifie que la commande doit renvoyer chaque instance de la ressource DSC spécifiée au lieu d’une instance spécifique.
Cette option n’est valide que si la ressource est une ressource exportable qui définit la section d’exportation dans la configuration d’entrée. Si le type de ressource n’est pas exportable, DSC génère une erreur.
Lorsque cette option est spécifiée, DSC ignore les --input options et --path .
Type: Boolean
Mandatory: false
-r, --ressource
Spécifie le nom de type complet de la ressource DSC à utiliser, par exemple Microsoft.Windows/Registry.
La syntaxe de nom de type complet est la suivante : <owner>[.<group>][.<area>]/<name>, où :
- Il
owners’agit de l’auteur ou de l’organisation responsable de la ressource. - Les
groupetareasont des composants de nom facultatifs qui activent l’espacement des noms pour une ressource. - Le identifie
namele composant géré par la ressource.
Type : string
Mandatory : true
LongSyntax : --resource <RESOURCE>
ShortSyntax : -r <RESOURCE>
-i, --input
Spécifie l’instance de ressource à récupérer.
L’instance doit être une chaîne contenant un objet JSON ou YAML. DSC valide l’objet par rapport au schéma d’instance de la ressource. En cas d’échec de la validation, DSC génère une erreur.
Cette option s’exclut mutuellement avec l’option --file .
Type : string
Mandatory : false
LongSyntax : --input <INPUT>
ShortSyntax : -i <INPUT>
-f, --fichier
Définit le chemin d’accès à un fichier définissant l’instance de ressource à récupérer.
Le fichier spécifié doit contenir un objet JSON ou YAML qui représente des propriétés valides pour la ressource. DSC valide l’objet par rapport au schéma d’instance de la ressource. Si la validation échoue ou si le fichier spécifié n’existe pas, DSC génère une erreur.
Vous pouvez également utiliser cette option pour passer une instance à partir de stdin, comme illustré dans l’exemple 3.
Cette option s’exclut mutuellement avec l’option --input .
Type : string
Mandatory : false
LongSyntax : --file <FILE>
ShortSyntax : -f <FILE>
-o, --format-de-sortie
L’option --output-format contrôle le format utilisé par DSC pour les données renvoyées par la commande. Les formats disponibles sont les suivants :
-
jsonpour émettre les données sous la forme d’une ligne JSON. Lorsque vous utilisez l’option --all, chaque instance est renvoyée sous la forme d’une ligne JSON. -
pretty-jsonpour émettre les données au format JSON avec des sauts de ligne, des retraits et des espaces pour plus de lisibilité. -
yamlpour émettre les données au format YAML. Lorsque vous utilisez l’option--all, chaque instance est renvoyée sous la forme d’un document YAML avec le séparateur de---document entre chaque instance renvoyée. -
json-arraypour émettre les données sous la forme d’un seul tableau JSON de lignes millimétriques contenant chaque objet. Cette option n’est valide qu’avec l’option --all. -
pass-throughpour retourner les données de la ressource directement sans les encapsuler dans un résultat DSC. Lorsque vous utilisez cette option de sortie, la ligne JSON émise adhère au schéma d’instance de la ressource, et non au schéma de résultat d’obtention DSC.
Le format de sortie par défaut varie selon que DSC détecte que la sortie est redirigée ou capturée en tant que variable :
- Si la commande n’est pas redirigée ou capturée, DSC affiche la sortie au
yamlformat dans la console. - Si la sortie de la commande est redirigée ou capturée, DSC émet les données au
jsonformat stdout.
Lorsque vous utilisez cette option, DSC utilise le format spécifié, que la commande soit redirigée ou capturée.
Lorsque la commande n’est pas redirigée ou capturée, la sortie de la console est formatée pour une meilleure lisibilité. Lorsque la commande n’est pas redirigée ou capturée, la sortie inclut des séquences terminales pour la mise en forme.
Type : string
Mandatory : false
ValidValues : [json, pretty-json, yaml, json-array, pass-through]
LongSyntax : --output-format <OUTPUT_FORMAT>
ShortSyntax : -o <OUTPUT_FORMAT>
-h, --help
Affiche l’aide de la commande ou de la sous-commande actuelle. Lorsque vous spécifiez cette option, l’application ignore toutes les autres options et arguments.
Type : boolean
Mandatory : false
LongSyntax : --help
ShortSyntax : -h
Sortie
Par défaut, cette commande renvoie un objet de données formaté qui inclut l’état réel de l’instance. Lorsque l’option --all est spécifiée, la commande renvoie les données formatées pour chaque instance. Lorsque vous spécifiez l’option de format de pass-through sortie, les données émises sont la sortie non modifiée de la ressource, et non le résultat d’une ressource DSC.
Pour plus d’informations sur la structure du JSON de sortie, consultez Schéma de résultat d’obtention de ressource dsc.
Pour plus d’informations sur le formatage des données de sortie, consultez l’option --output-format.
Collaborer avec nous sur GitHub
La source de ce contenu se trouve sur GitHub, où vous pouvez également créer et examiner les problèmes et les demandes de tirage. Pour plus d’informations, consultez notre guide du contributeur.
