dsc-erőforráslista eredményséma-referenciája

Áttekintés

A dsc resource list 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/resource/list.json
Type:          object

Leírás

A dsc resource list parancs kimenete tartalmazza a felderített DSC-erőforrások JSON-soroksorozatát. Ez a séma az egyes erőforrásokhoz visszaadott JSON-objektumot ismerteti.

Kötelező tulajdonságok

A kimenet minden erőforrása a következő tulajdonságokat tartalmazza:

• típus
• verzió
• elérési út
• címtár
• implementáltA
• szerző
• tulajdonságok
• szükséges AzAdapter
• jegyzék

Kellékek

típus

Azonosítja az erőforrás teljes típusnevét. Az erőforrás konfigurációs dokumentumokban való megadására szolgál, valamint a --resource jelölő értékeként a dsc resource * parancsok használatakor. További információ az erőforrástípusnevekről: DSC-erőforrás teljes típusnévséma-referencia.

Type:     string
Required: true
Pattern:  ^\w+(\.\w+){0,2}\/\w+$

fajta

Azt határozza meg, hogy egy erőforrás adapter erőforrás-, csoporterőforrás-vagy egyik sem. Ezt az értéket a erőforrásjegyzékben vagy a DSC határozza meg. További információ az erőforrástípusokról: DSC erőforrástípus sémahivatkozása.

Type:          string
Required:      true
ValidValues:  [Resource, Adapter, Group]

verzió

Az erőforrás aktuális verzióját jelöli érvényes szemantikai (szemantikai) sztringként. A verzió az erőforrásra vonatkozik, nem az általa kezelt szoftverre.

Type:     string
Required: true
Pattern:  ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$

Képességek

Meghatározza azokat a műveleteket és viselkedéseket, amelyeket az erőforrás a támogatás érdekében implementál. Ez a tulajdonság képességek tömbje. Az erőforrások mindig rendelkeznek a Get képességgel, de a többi képesség nem kötelező, és az erőforrástól függ.

Az alábbi lista az erőforrások rendelkezésre álló képességeit ismerteti:

• Get – Az erőforrás támogatja a példány aktuális állapotának lekérését. Minden DSC-erőforrásnak rendelkeznie kell ezzel a képességgel. Egy erőforrás akkor rendelkezik ezzel a képességgel, ha meghatározza a kötelező tulajdonság lekérése az erőforrásjegyzékben.

• Set – Az erőforrás támogatja a példány kívánt állapotának kikényszerítését. Egy erőforrás akkor rendelkezik ezzel a képességgel, ha meghatározza a tulajdonságot az erőforrásjegyzékben. Az ilyen képesség nélküli erőforrások nem használhatók a dsc erőforráskészlettel vagy dsc konfigurációkészlettel parancsokkal, kivéve, ha beágyazott példányként Microsoft.DSC/Assertion csoportban vannak.

• – Az erőforrás közvetlenül támogatja a _exist tulajdonságot. Egy erőforrás akkor rendelkezik ezzel a képességgel, ha a handlesExist tulajdonságot true definiálja az erőforrás-jegyzékben szereplő parancstulajdonság definíciójában.

  Ha egy erőforrás rendelkezik ezzel a képességgel, a _exist tulajdonság az erőforrás példányséma része, és az erőforrás kezeli az erőforrás példányainak törlését a set parancsban.

  Ha egy erőforrás nem rendelkezik ezzel a képességgel, amikor a DSC megkeresi az erőforrás _existfalsebeállítású példányát, az törlési művelet meghívását kezeli.

  Ha az erőforrás nem rendelkezik ezzel a képességgel vagy a Delete képességgel, a DSC hibát jelez, amikor egy példány _exist definiál false.

• WhatIf – Az erőforrás támogatja, hogy explicit információkat adjon vissza arról, hogyan módosítja az állapotot, amikor egy felhasználó meghívja dsc konfigurációkészletet a --what-if beállítással. Egy erőforrás akkor rendelkezik ezzel a képességgel, ha meghatározza a What-if metódust az erőforrás-jegyzékben.

  Ha egy erőforrás rendelkezik ezzel a képességgel, a DSC meghívja a definiált parancsot az argumentumaival együtt, amikor egy felhasználó végrehajtja a dsc config set parancsot a --what-if beállítással.

  Ha egy erőforrás nem rendelkezik ezzel a képességgel, a DSC szintetizálja az erőforrás változását és a példányt úgy, hogy a példány Test eredményét Set eredményké alakítja. A szintetikus művelet nem jelezhet olyan lehetséges problémákat vagy változásokat, amelyek nem határozhatók meg a Test művelet eredményének az erőforrás kívánt állapotával való összehasonlításával. Az erőforrások teszteléséhez használt hitelesítő adatok például érvényesek lehetnek erre a műveletre, de nem rendelkeznek a rendszerállapot módosítására vonatkozó engedélyekkel. Csak az ilyen képességgel rendelkező erőforrások képesek teljes körűen jelenteni, hogy az erőforrás megváltoztatja-e a rendszerállapotot.

• Test – Az erőforrás támogatja a példány kívánt állapotának a példány aktuális állapotával való érvényesítését. Egy erőforrás akkor rendelkezik ezzel a képességgel, ha meghatározza a teszt tulajdonságot az erőforrás-jegyzékben.

  Ha egy erőforrás nem rendelkezik Test képességgel, a DSC szintetikus tesztet használ az erőforrás példányaihoz. A szintetikus teszt összehasonlítja a példány kívánt állapotának minden tulajdonságát a tényleges állapottal. A szintetikus teszt szigorú, kis- és nagybetűkre érzékeny egyenértékűséget használ. Ha egy tulajdonság kívánt állapota és a tényleges állapot nem egyezik meg, a DSC a tulajdonságot a kívánt állapoton kívülre jelöli.

• Delete – Az erőforrás támogatja a példányok eltávolítását. Egy erőforrás akkor rendelkezik ezzel a képességgel, ha meghatározza a törlési tulajdonságot az erőforrásjegyzékben. Ez a képesség nem zárja ki egymást a SetHandlesExist tulajdonsággal. Az erőforrások kezelhetik a _exist tulajdonságot a beállítási műveletekben, és közvetlenül meghívhatók dsc erőforrás-törlési egy példány eltávolításához.

• Export – Az erőforrás támogatja az erőforrás minden példányának számbavételét. Egy erőforrás akkor rendelkezik ezzel a képességgel, ha meghatározza az exportálási tulajdonságot az erőforrásjegyzékben. Csak az ezzel a képességgel rendelkező erőforrások használhatók a dsc erőforrásexportálási és dsc konfiguráció exportálási parancsokkal.

• Resolve – Az erőforrás támogatja a beágyazott erőforráspéldányok külső forrásból történő feloldását. Egy erőforrás akkor rendelkezik ezzel a képességgel, ha meghatározza a tulajdonságot az erőforrásjegyzékben. Ezt a funkciót elsősorban az importáló erőforrások használják.

Type:              array
Required:          true
ItemsMustBeUnique: true
ItemsType:         string
ItemsValidValues: [Get, Set, SetHandlesExist, Test, Delete, Export]

leírás

Rövid sztringként definiálja az erőforrás céljának szinopszisát. Ha az erőforrás nem rendelkezik leírással, ez a tulajdonság null.

Type:     [string, 'null']
Required: true

ösvény

Az erőforrás jegyzékfájljának elérési útját jelöli a gépen. Az adaptált erőforrások esetében ez a tulajdonság azonosítja az erőforrást meghatározó fájl elérési útját.

Type:     string
Required: true

címtár

Az erőforrás jegyzékfájlját tartalmazó mappa elérési útját jelöli a gépen. Az adaptált erőforrások esetében ez a tulajdonság az erőforrást meghatározó fájlt tartalmazó mappa elérési útját azonosítja.

Type:     string
Required: true

implementA-k

A DSC-erőforrás implementálásának módját jelzi. A parancsalapú erőforrások esetében ez az érték mindig Command.

szerző

A DSC-erőforrást fejlesztő és karbantartó személy vagy szervezet nevét jelzi. Ha ez a tulajdonság null, a szerző ismeretlen.

Type:     [string, 'null']
Required: true

kellékek

Meghatározza az adaptált erőforrások tulajdonságneveit. A nem adaptált erőforrások esetében ez a tulajdonság egy üres tömb.

Type:         array
Required:     true
ItemsType:    string
ItemsPattern: ^\w+$

requireAdapter

Meghatározza annak a DSC-erőforrásadapternek a teljes típusnevét, amelyen keresztül ez az erőforrás elérhetővé válik. Ez az érték csak az adaptált erőforrásokhoz van definiálva. A nem adaptált erőforrások esetében ez az érték mindig null.

Type:     [string, 'null']
Required: true

kimutat

Az erőforrás jegyzékében meghatározott értékeket jelöli. Ez az érték nem parancsalapú erőforrások esetében null. A tulajdonság értékével kapcsolatos további információkért lásd parancsalapú DSC-erőforrásjegyzék sémahivatkozását.

Type:     [object, 'null']
Required: true