dsc-erőforráskészlet eredményséma-referenciája
Áttekintés
A parancs eredménykimenete dsc resource set
.
Metaadatok
SchemaDialect: https://json-schema.org/draft/2020-12/schema
SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/outputs/resource/set.json
Type: object
Description
Egy DSC-erőforráspéldány visszaadott adatait ismerteti a dsc resource set
parancsból. A visszaadott adatok vagy egyetlen objektum, amely egy nem beágyazott példány kényszerített állapotát írja le, vagy olyan objektumtömb, amely egy csoport vagy adapter erőforrás beágyazott példányainak kényszerített állapotát írja le.
A DSC egy egyszerű halmazválaszt ad vissza, ha a példány nem csoporterőforrás, adaptererőforrás, vagy nem egy csoport vagy adapter erőforrásában van beágyazva.
Ha a lekért példány csoporterőforráshoz, adaptererőforráshoz vagy egy csoport- vagy adaptererőforrásba ágyazott, a DSC egy teljes eredményhalmazt ad vissza, amely tartalmazza az erőforrás típusát és a példány nevét is.
Egyszerű halmaz válasza
Egy DSC-erőforráspéldány visszaadott adatait ismerteti a dsc resource set
parancsból. A visszaadott adatok vagy egyetlen objektum, amely egy nem beágyazott példány kényszerített állapotát írja le, vagy olyan objektumtömb, amely egy csoport vagy adapter erőforrás beágyazott példányainak kényszerített állapotát írja le.
Kötelező tulajdonságok
A kimenet mindig a következő tulajdonságokat tartalmazza:
Tulajdonságok
beforeState
A beállított művelet előtt visszaadott példány állapotát jelöli. A DSC ellenőrzi ennek a tulajdonságnak az értékét az erőforrás példánysémája alapján.
Type: object
Required: true
afterState
A készletművelet után visszaadott példány állapotát jelöli. A DSC ellenőrzi ennek a tulajdonságnak az értékét az erőforrás példánysémája alapján.
Type: object
Required: true
changedProperties
Meghatározza a halmazművelet által kikényszerített tulajdonságok nevét. Ha ez az érték egy üres tömb, az erőforrás nem végzett módosításokat a beállított művelet során.
Type: array
Required: true
ItemsType: string
Teljes készlet eredménye
Egy erőforráspéldány műveletének teljes eredményéhez tartozó visszatérési set
adatokat ismerteti. Ezeket az adatokat a következő módon adja vissza:
- A konfigurációs dokumentum minden példányához, amikor a
dsc config set
parancsot használja. - Csoport vagy adapter erőforrás beágyazott példányai esetén a
dsc resource set
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 tulajdonságok a Microsoft.DSC
művelet kontextusát írják le.
- Duration a konfigurációs dokumentumon vagy erőforráspéldányon végzett DSC-művelet időtartamát határozza meg sztringként a ISO8601 ABNF-ben definiált formátumot követve
duration
. PéldáulPT0.611216S
egy 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-referencia.
Type: string
Required: true
Pattern: ^\w+(\.\w+){0,2}\/\w+$
name
A name
tulajdonság a példányt a rövid, egyedi, olvasható neve alapján azonosítja.
Type: string
Required: true
result
A result
tulajdonság tartalmazza az erőforrás kényszerített állapotát. Ez az érték a következő:
- A példány egyszerű halmazvá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