Dela via

resultatschemareferens för dsc-resurslista

  • Artikel

Sammanfattning

Resultatet utdata från kommandot dsc resource list.

Metadata

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

Beskrivning

Utdata från kommandot dsc resource list innehåller en representation av identifierade DSC-resurser som en serie JSON-rader. Det här schemat beskriver JSON-objektet som returneras för varje resurs.

Nödvändiga egenskaper

Varje resurs i utdata innehåller alltid följande egenskaper:

Egenskaper

typ

Identifierar resursens fullständigt kvalificerade typnamn. Den används för att ange resursen i konfigurationsdokumenten och som värdet för flaggan --resource när du använder dsc resource * kommandon. Mer information om resurstypsnamn finns i DSC-resursens fullständigt kvalificerade typnamnsschemareferens.

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

sort

Identifierar om en resurs är en nätverkskortresurs, en gruppresurseller ingetdera. Det här värdet definieras antingen i resursmanifestet eller härleds av DSC. Mer information om resurstyper finns i schemareferens för DSC-resurstyp.

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

version

Representerar den aktuella versionen av resursen som en giltig semantisk version (semver) sträng. Versionen gäller för resursen, inte den programvara som den hanterar.

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-]+)*))?$

Kapacitet

Definierar de åtgärder och beteenden som resursen implementeras för att stödja. Den här egenskapen är en matris med funktioner. Resurser har alltid den Get funktionen, men de andra funktionerna är valfria och beroende av resursen.

I följande lista beskrivs tillgängliga funktioner för en resurs:

  • Get – Resursen stöder hämtning av aktuellt tillstånd för en instans. Alla DSC-resurser måste ha den här funktionen. En resurs har den här funktionen när den definierar den obligatoriska hämta egenskapen i resursmanifestet.

  • Set – Resursen har stöd för att framtvinga önskat tillstånd för en instans. En resurs har den här funktionen när den definierar ange egenskap i resursmanifestet. Resurser utan den här funktionen kan inte användas med dsc-resursuppsättningen eller dsc-konfigurationsuppsättningen kommandon om de inte finns i en Microsoft.DSC/Assertion-grupp som en kapslad instans.

  • SetHandlesExist – Resursen stöder egenskapen _exist direkt. En resurs har den här funktionen när den definierar egenskapen hanterarExist som true i definitionen av ange kommandoegenskap i resursmanifestet.

    När en resurs har den här funktionen är egenskapen _exist en del av resursens instansschema och resursen hanterar borttagning av instanser av resursen i kommandot set.

    När en resurs inte har den här funktionen, när DSC hittar en instans av resursen med _exist inställd på false, hanterar den anropet ta bort åtgärd för resursen.

    Om resursen inte har den här funktionen eller funktionen Delete genererar DSC ett fel när en instans definierar _exist som false.

  • WhatIf – Resursen har stöd för att returnera explicit information om hur den ändrar tillstånd när en användare anropar dsc-konfigurationsuppsättning med alternativet --what-if. En resurs har den här funktionen när den definierar konsekvensmetoden i resursmanifestet.

    När en resurs har den här funktionen anropar DSC det definierade kommandot med sina argument när en användare kör kommandot dsc config set med alternativet --what-if.

    När en resurs inte har den här funktionen syntetiserar DSC hur resursen ändras och instansen genom att konvertera Test resultatet för instansen till ett Set resultat. Den syntetiska åtgärden kan inte indikera potentiella problem eller ändringar som inte kan fastställas genom att jämföra resultatet av den Test åtgärden med resursens önskade tillstånd. De autentiseringsuppgifter som används för att testa en resurs kan till exempel vara giltiga för den åtgärden, men de har inte behörighet att faktiskt ändra systemtillståndet. Endast en resurs med den här funktionen kan helt rapportera om och hur resursen kommer att ändra systemtillståndet.

  • Test – Resursen stöder validering av önskat tillstånd för en instans mot instansens aktuella tillstånd. En resurs har den här funktionen när den definierar egenskapen test i resursmanifestet.

    Om en resurs inte har funktionen Test använder DSC ett syntetiskt test för instanser av resursen. Det syntetiska testet jämför varje egenskap för det önskade tillståndet för en instans med det faktiska tillståndet. Det syntetiska testet använder strikt, skiftlägeskänslig ekvivalens. Om det önskade tillståndet för en egenskap och det faktiska tillståndet inte är detsamma markerar DSC egenskapen som ur önskat tillstånd.

  • Delete – Resursen stöder borttagning av en instans. En resurs har den här funktionen när den definierar ta bort-egenskapen i resursmanifestet. Den här funktionen är inte ömsesidigt uteslutande med egenskapen SetHandlesExist. En resurs kan hantera egenskapen _exist i uppsättningsåtgärder och anropas direkt med dsc-resursborttagning för att ta bort en instans.

  • Export – Resursen stöder uppräkning av varje instans av resursen. En resurs har den här funktionen när den definierar exportera-egenskapen i resursmanifestet. Endast resurser med den här funktionen kan användas med dsc-resursexport och dsc-konfigurationsexport kommandon.

  • Resolve – Resursen stöder matchning av kapslade resursinstanser från en extern källa. En resurs har den här funktionen när den definierar lösa egenskap i resursmanifestet. Den här funktionen används främst av importerresurser.

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

beskrivning

Definierar en synopsis för resursens syfte som en kort sträng. Om resursen inte har någon beskrivning är den här egenskapen null.

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

stig

Representerar sökvägen till resursens manifest på datorn. För anpassade resurser identifierar den här egenskapen sökvägen till filen som definierar resursen i stället.

Type:     string
Required: true

katalog

Representerar sökvägen till mappen som innehåller resursens manifest på datorn. För anpassade resurser identifierar den här egenskapen sökvägen till mappen som innehåller filen som definierar resursen i stället.

Type:     string
Required: true

implementedAs

Anger hur DSC-resursen implementerades. För kommandobaserade resurser är det här värdet alltid Command.

författare

Anger namnet på den person eller organisation som har utvecklat och underhåller DSC-resursen. Om den här egenskapen är nullär författaren okänd.

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

Egenskaper

Definierar egenskapsnamnen för anpassade resurser. För icke-anpassade resurser är den här egenskapen en tom matris.

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

requireAdapter

Definierar det fullständigt kvalificerade typnamnet för DSC-resurskortet som den här resursen görs tillgänglig via. Det här värdet definieras endast för anpassade resurser. För icke-anpassade resurser är det här värdet alltid null.

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

manifestera

Representerar de värden som definierats i resursens manifest. Det här värdet är null för resurser som inte är kommandobaserade. Mer information om värdet för den här egenskapen finns i kommandobaserad schemareferens för DSC-resursmanifestet.

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