dsc-erőforrás lekérése eredményséma-referencia
Áttekintés
A parancs eredménykimenete dsc resource get
.
Metaadatok
SchemaDialect: https://json-schema.org/draft/2020-12/schema
SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/outputs/resource/get.json
Type: object
Description
Egy DSC-erőforráspéldány visszaadott adatait ismerteti a dsc resource get
parancsból. A visszaadott adatok vagy egyetlen objektum, amely egy nem beágyazott példány tényleges állapotát írja le, vagy egy olyan objektumtömb, amely egy csoport- vagy adaptererőforrás beágyazott példányainak tényleges állapotát írja le.
A DSC egyszerű lekéréses választ ad vissza, ha a példány nem csoporterőforrás, adaptererőforrás vagy beágyazott egy csoport vagy adapter erőforrásában.
Ha a lekért példány csoporterőforráshoz, adaptererőforráshoz vagy egy csoport- vagy adaptererőforrásba ágyazott, a DSC teljes lekéréses eredményt ad vissza, amely tartalmazza az erőforrás típusát és a példány nevét is.
Egyszerű válasz kérése
Egyetlen DSC-erőforráspéldány visszaadott adatait ismerteti a dsc resource get
parancsból.
Ezek az adatok olyan példányok esetén lesznek visszaadva, amelyek nem csoportosítják az erőforrásokat, az adapter-erőforrásokat, vagy egy csoport- vagy adaptererőforrásba vannak ágyazva.
Kötelező tulajdonságok
A kimenet mindig tartalmazza az alábbi tulajdonságokat:
Tulajdonságok
actualState
A actualState
tulajdonság mindig tartalmazza a visszaadott példány állapotát, amikor a DSC meghívja az erőforrás lekérési műveletét. A DSC ellenőrzi a tulajdonság értékét az erőforrás példánysémája alapján.
Type: object
Required: true
Teljes eredmény lekérése
Egy erőforráspéldány műveletének teljes eredményéhez tartozó visszatérési get
adatokat ismerteti. A visszaadott adatok:
- A konfigurációs dokumentum minden példányához, amikor a
dsc config get
parancsot használja. - Csoport- vagy adaptererőforrás beágyazott példányai esetén a
dsc resource get
parancs használatakor.
Kötelező tulajdonságok
Tulajdonságok
metaadatok
A konfigurációs művelet metaadatainak DSC-visszaadott értékét határozza meg. A tulajdonság alatti Microsoft.DSC
tulajdonságok a művelet kontextusát írják le.
- duration a konfigurációs dokumentumon vagy erőforráspéldányon végrehajtott DSC-művelet időtartamát határozza meg sztringként a ISO8601 ABNF-ben definiált formátumot követve
duration
. Például egyPT0.611216S
körülbelül0.61
másodperces időtartamot jelöl.
Type: object
Required: true
típus
A type
tulajdonság a példány DSC-erőforrását a teljes típusnév alapján azonosítja.
A típusnevekkel kapcsolatos további információkért lásd: DSC-erőforrás teljes típusnévséma-referenciája.
Type: string
Required: true
Pattern: ^\w+(\.\w+){0,2}\/\w+$
name
A name
tulajdonság a példányt rövid, egyedi, emberi olvasásra alkalmas neve alapján azonosítja.
Type: string
Required: true
result
A result
tulajdonság tartalmazza az erőforrás tényleges állapotát. Ez az érték a következő lehet:
- A példány egyszerű get válasza
- Az egyes beágyazott példányok teljes eredményobjektumainak tömbje, ha az erőforrás csoport- vagy adaptererőforrás.
Type: [object, array]
Required: true