dsc konfigurációkészlet eredményséma-referenciája
Áttekintés
A dsc config set
parancs eredménykimenete.
Metaadatok
SchemaDialect: https://json-schema.org/draft/2020-12/schema
SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/outputs/config/set.json
Type: object
Leírás
A dsc config set
parancs kimenete tartalmazza a beállítási művelet előtti és utáni konfigurációban lévő összes erőforráspéldány állapotát, valamint az egyes példányok esetében módosított tulajdonságok listáját.
Kötelező tulajdonságok
A kimenet mindig tartalmazza az alábbi tulajdonságokat:
Kellékek
metaadatok
Egy konfigurációs művelet metaadatainak DSC-visszatérését határozza meg. A Microsoft.DSC
tulajdonság tulajdonságai a művelet kontextusát írják le.
Type: object
Required: true
Microsoft.DSC
A tulajdonság metaadatai az általános művelet kontextusát írják le:
- verzió határozza meg a parancsot futtató DSC-verziót. Ez az érték mindig a DSC parancs szemantikai verziója, például
3.0.0-preview.7
. - művelet határozza meg a konfigurációs dokumentumra alkalmazott műveletet:
Get
,Set
,Test
vagyExport
. - executionType határozza meg, hogy a DSC ténylegesen alkalmazott-e műveletet a konfigurációra, vagy
WhatIf
módban futott. Ez a tulajdonság mindigActual
Get
,Test
ésExport
műveletekhez.Set
műveletek esetében ez az értékWhatIf
, amikor a DSC meghívása a--what-if
argumentummal történik. - startDatetime a DSC-művelet kezdési dátumát és időpontját időbélyegként határozza meg az RFC3339 5.
2024-04-14T08:49:51.395686600-07:00
date-time
6. - endDatetime a DSC-művelet befejezési dátumát és időpontját időbélyegként határozza meg az RFC3339 5.6. szakaszában (lásd
date-time
), például2024-04-14T08:49:51.395686600-07:00
. - időtartam egy konfigurációs dokumentumon vagy erőforráspéldányon végzett DSC-művelet időtartamát sztringként határozza meg az ISO8601 ABNF for
duration
. APT0.611216S
például körülbelül0.61
másodpercet jelöl. - securityContext határozza meg a DSC által futtatott biztonsági környezetet. Ha ennek a metaadat-tulajdonságnak az értéke
Elevated
, a DSCroot
(nem Windows) vagy rendszergazdai jogosultságokkal rendelkező emelt szintű munkamenetként futott (Windows rendszeren). Ha az értékRestricted
, a DSC normál felhasználóként vagy fiókként futott egy nem emelt szintű munkamenetben.
Eredmények
Meghatározza a konfigurációs dokumentum minden példányán meghívott set
művelet eredményeinek listáját. A lista minden bejegyzése tartalmazza az erőforrás típusnevét, a példány nevét és a példány eredményadatait.
Type: array
Required: true
ItemsType: object
típus
Egy elem type
tulajdonsága a példány DSC-erőforrását a teljes típusnév alapján azonosítja.
További információ a típusnevekről: DSC-erőforrás teljes típusnévséma-referencia.
Type: string
Required: true
Pattern: ^\w+(\.\w+){0,2}\/\w+$
név
Egy elem name
tulajdonsága a példányt a rövid, egyedi, olvasható neve alapján azonosítja.
Type: string
Required: true
eredmény
Egy elem result
tulajdonsága tartalmazza az erőforráspéldány kényszerített állapotát. A tulajdonság értéke ugyanazt a sémát követi, mint a dsc resource set
parancs kimenete. További információ: dsc erőforráskészlet eredményséma-referencia.
Üzenetek
Meghatározza az erőforrások által a beállított művelet során kibocsátott strukturált üzenetek listáját. További információ: Strukturált üzenetséma-referencia.
Type: array
Required: true
hadErrors
Azt jelzi, hogy a művelet hibát észlelt-e. Ez az érték true
, ha a konfigurációs dokumentum ellenőrzése sikertelen volt, vagy ha az erőforrás nem 0
kilépési kóddal lépett ki.
Type: boolean
Required: true