dsc-erőforrás lekérése

Áttekintés

Meghívja egy erőforrás lekérési műveletét.

Syntax

Példánytulajdonságok nélkül

dsc resource get [Options] --resource <RESOURCE>

Példánytulajdonságok az stdinből

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

Példánytulajdonságok a bemeneti beállításból

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

Példánytulajdonságok fájlból

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

Description

Az get alparancs egy erőforráspéldány aktuális állapotát adja vissza.

Alapértelmezés szerint ez az alparancs egy példányt ad vissza egy adott DSC-erőforrásból. Több erőforrás visszaadásához használja a --all paramétert, egy erőforráscsoportot vagy a dsc config get parancsot.

Az erőforrás által a példány állapotának lekéréséhez szükséges tulajdonságokat JSON- vagy YAML-objektumként kell átadni ennek a parancsnak. Az objektum átadható ennek a parancsnak az stdinből vagy a --input beállítással. Az objektumot JSON- vagy YAML-fájlból is --path beolvashatja.

Példák

1. példa – Erőforráspéldány beolvasása bemenet nélkül

Az olyan egypéldányos erőforrások esetében, amelyeknél nincs szükség tulajdonságértékre az erőforráspéldány tényleges állapotának visszaadásához, a példány tulajdonságaira nincs szükség.

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'

2. példa – Erőforráspéldány lekérése bemeneti beállítással

Ha egy erőforrásnak egy vagy több tulajdonságértékre van szüksége a példány tényleges állapotának visszaadásához, a példánytulajdonságok JSON vagy YAML formátumban is átadhatók a bemeneti beállítással.

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

3. példa – Erőforráspéldány lekérése stdinből származó bemenettel

Ha egy erőforrásnak egy vagy több tulajdonságértékre van szüksége a példány tényleges állapotának visszaadásához, a példánytulajdonságok átadhatók az stdinnek JSON-ként vagy YAML-ként.

'{
    "keyPath": "HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion",
    "valueName": "SystemRoot"
}' | dsc resource get --resource Microsoft.Windows/Registry

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

4. példa – Erőforráspéldány lekérése YAML-fájlból származó bemenettel

Ha egy erőforrásnak egy vagy több tulajdonságértékre van szüksége a példány tényleges állapotának visszaadásához, a példánytulajdonságok lekérhetők egy mentett JSON- vagy YAML-fájlból.

cat ./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

Beállítások

-a, --all

Meghatározza, hogy a parancs a megadott DSC-erőforrás minden példányát visszaadja egy adott példány helyett.

Ez a beállítás csak akkor érvényes, ha az Erőforrás egy exportálható erőforrás, amely meghatározza a bemeneti konfiguráció exportálási szakaszát. Ha az erőforrástípus nem exportálható, a DSC hibát jelez.

Ha ez a beállítás meg van adva, a DSC figyelmen kívül hagyja a és --path a --input beállításokat, valamint az stdin parancsnak küldött JSON-t vagy YAML-t.

Type:      Boolean
Mandatory: false

-r, --resource

Megadja a használni kívánt DSC-erőforrás teljes típusnevét, például Microsoft.Windows/Registry: .

A teljes típusnévszintaxis a következő: <owner>[.<group>][.<area>]/<name>, ahol:

• A owner az erőforrás karbantartó szerzője vagy szervezete.
• A group és area nem kötelező névösszetevők, amelyek lehetővé teszik az erőforrások névkészítését.
• A name azonosítja az erőforrás által kezelt összetevőt.

Type:      String
Mandatory: true

-i, --input

A DSC-erőforrás egy példányának lekéréséhez szükséges tulajdonságokkal rendelkező JSON- vagy YAML-objektumot határoz meg. A DSC ellenőrzi az objektumot az erőforrás példánysémája alapján. Ha az ellenőrzés sikertelen, a DSC hibát jelez.

Ez a beállítás nem használható az stdin vagy a --path beállítás feletti példánytulajdonságokkal. Adja meg, hogy a példánytulajdonságokat át szeretné-e adni az stdin parancsnak, egy beállítással rendelkező --path fájlból vagy a --input beállítással.

A DSC figyelmen kívül hagyja ezt a beállítást, ha a --all beállítás meg van adva.

Type:      String
Mandatory: false

-p, --path

A parancs bemeneteként beolvasandó szövegfájl elérési útját határozza meg ahelyett, hogy a bemenetet az stdinből íratja, vagy sztringként adja át a --input beállítással. A megadott fájlnak olyan JSON-t vagy YAML-t kell tartalmaznia, amely az erőforrás érvényes tulajdonságait jelöli. A DSC ellenőrzi az objektumot az erőforrás példánysémája alapján. Ha az ellenőrzés sikertelen, vagy ha a megadott fájl nem létezik, a DSC hibát jelez.

Ez a lehetőség kölcsönösen kizárja a --input lehetőséget. Ha ezt a beállítást használja, a DSC figyelmen kívül hagyja az stdin összes bemenetét.

A DSC figyelmen kívül hagyja ezt a beállítást, ha a --all beállítás meg van adva.

Type:      String
Mandatory: false

-f, --format

A --format beállítás szabályozza a parancs konzolkimeneti formátumát. Ha a parancs kimenetét átirányítja vagy változóként rögzíti, a kimenet mindig JSON lesz.

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

-h, --help

Megjeleníti az aktuális parancs vagy alparancs súgóját. Ha ezt a beállítást adja meg, az alkalmazás figyelmen kívül hagyja az összes beállítást és argumentumot ezt követően.

Type:      Boolean
Mandatory: false

Kimenet

Alapértelmezés szerint ez a parancs olyan JSON-kimenetet ad vissza, amely tartalmazza a példány tényleges állapotát. Ha a --all beállítás meg van adva, a parancs az egyes példányok JSON-kimenetét adja vissza JSON-sorokként.

A kimeneti JSON szerkezetéről további információt a dsc-erőforrás eredménysémája című témakörben talál.