Dela via

Ordlista: Desired State Configuration

  • Artikel

Desired State Configuration (DSC) v3 använder flera termer som kan ha olika definitioner någon annanstans. I det här dokumentet visas termerna, deras betydelser och hur de formateras i dokumentationen.

Konfigurationsvillkor

Dokument om DSC-konfiguration

JSON- eller YAML-filen som definierar en lista över resursinstanser och deras önskade tillstånd.

Riktlinjer

  • Första omnämnandet: DSC-konfigurationsdokument
  • Efterföljande omnämnanden: konfigurationsdokument eller dokument

Exempel

Ett DSC-konfigurationsdokument kan vara formaterat som JSON eller YAML.

Definiera variabeln scope i dokumentet som machine.

Resursvillkor

DSC-resurs

DSC-gränssnittet för att hantera inställningarna för en komponent. DSC v3 stöder flera typer av resurser.

Riktlinjer

  • Första omnämnandet: DSC-resurs
  • Efterföljande omnämnanden: resurs
  • Formatera namnen på specifika resurser som kod.

Exempel

Båda använder DSC-resursen Microsoft/OSInfo .

Du kan granska en resurs definition med dsc resource list <resource_name> kommandot .

Kommandobaserad DSC-resurs

En resurs som definieras med ett resursmanifest är en kommandobaserad resurs. DSC använder manifestet för att avgöra hur resursen ska anropas och hur resursinstansens egenskaper ska verifieras.

Riktlinjer

  • Ange alltid termen med bindestrecket.

Exempel

Microsoft.Windows/Registry är en kommandobaserad resurs.

DSC-resursgrupp

En resursgrupp är en kommandobaserad resurs med en resources egenskap som tar en matris med resursinstanser och bearbetar dem. Resursgrupper kan använda särskild hantering för sina kapslade resursinstanser, till exempel ändra användaren som resurserna körs som.

Riktlinjer

  • Ange alltid termen som resursgrupp. Utelämna inte "grupp" från termen .

Exempel

Använd resursgruppen för DSC/ParallelGroup att säkerställa att resurser anropas parallellt.

Kapslad resursinstans

En resursinstans som ingår i resources egenskapen för en resursgrupp eller resursprovider.

Riktlinjer

  • Första omnämnandet: kapslad resursinstans
  • Efterföljande omnämnanden: kapslad instans
  • Om det är tydligt från kontexten att instansen är en kapslad instans kan du utelämna prefixet "kapslad".

Exempel

Lägg till en kapslad resursinstans i instansen DSC/ParallelGroup . Definiera den kapslade instansen type som Microsoft.Windows/Registry.

DSC-resursprovider

En resursprovider är en resursgrupp som möjliggör användning av icke-kommandobaserade resurser med DSC v3. Varje kapslad resursinstans måste vara en resurstyp som providern stöder.

Riktlinjer

  • Första omnämnandet: DSC-resursprovider
  • Efterföljande omnämnanden: provider

Exempel

Om du vill använda PowerShell DSC-resurser i konfigurationsdokumentet lägger du till en instans av DSC/PowerShellGroup resursprovidern och definierar PowerShell-resursinstanserna som kapslade instanser.

PowerShell DSC-resurser

En resurs som implementeras i PowerShell. DSC v3 stöder två typer av PowerShell-resurser.

  • Class-Based – En resurs som definieras som en PowerShell-klass i en modul är en klassbaserad resurs.

    Klassens medlemmar definierar schemat för en klassbaserad resurs. En klassbaserad resurs måste definiera Get()metoderna , Set()och Test() .

  • MOF-baserad – En resurs som definierats med en MOF-fil (.mof), en skriptmodulfil (.psm1) och en valfri modulmanifestfil (.psd1) är en MOF-baserad resurs. MOF-baserade resurser stöds bara via Windows PowerShell.

    MOF-filen är schemat för resursen och definierar resursens egenskaper. Skriptmodulfilen definierar resursens funktioner: Get-TargetResource, Set-TargetResourceoch Test-TargetResource. Dessa funktioner mappas till metoderna Get, Set och Test .

Riktlinjer

  • Första omnämnandet: PowerShell DSC-resurser
  • Efterföljande omnämnanden: PowerShell-resurser eller PSDSC-resurser.
  • När du diskuterar en viss typ av PowerShell-resurs anger du alltid typprefixet, till exempel klassbaserade resurser.
  • PowerShell- och PSDSC-prefixet kan utelämnas när kontexten tydligt eller endast handlar om PowerShell-resurser, t.ex. en självstudie för redigering av en klassbaserad resurs.

Exempel

Om du vill använda PowerShell DSC-resurser i konfigurationsdokumentet lägger du till en instans av DSC/PowerShellGroup resursprovidern och definierar PowerShell-resursinstanserna som kapslade instanser.

När du utvecklar PowerShell-resurser för plattformsoberoende programvara skapar du klassbaserade resurser. MOF-baserade resurser stöds bara via Windows PowerShell.

DSC-resursmanifest

JSON-filen som definierar metadata och implementering av en kommandobaserad resurs.

Riktlinjer

  • Första omnämnandet: DSC-resursmanifest
  • Efterföljande omnämnanden: manifest

Exempel

Varje kommandobaserad resurs måste definiera ett DSC-resursmanifest. Manifestets filnamn måste sluta med .dsc.resource.json.

Namn på DSC-resurstyp

Namnet på en resurs. Namnet på den fullständigt kvalificerade resurstypen använder följande syntax:

`<owner>[.<group>][.<area>]/<name>`

Riktlinjer

  • Första omnämnandet: Namn på DSC-resurstyp
  • Efterföljande omnämnanden: resurstyp eller typnamn.
  • När du diskuterar syntaxen för ett resurstypsnamn anger du alltid termen som fullständigt kvalificerat resurstypnamn.

Exempel

DSC-resurser identifieras unikt med resurstypsnamnet.

Operations

De åtgärder som en resurs kan vidta för den komponent som den hanterar.

  • Get – Hämtar det aktuella tillståndet för en instans av resursen.
  • Set – framtvingar önskat tillstånd för en instans av resursen.
  • Test – Jämför önskat tillstånd för en instans av resursen med dess aktuella tillstånd.

Riktlinjer

  1. Aktivera åtgärderna med versaler.
  2. När du refererar till åtgärden specifikt formaterar du den som fetstil.
  3. När du refererar till åtgärdens -metod som implementerad i en PowerShell-klass formaterar du metoden som code med en tom uppsättning parenteser (()) efter namnet.

Exempel

Implementeringen av Set() metoden i en klassbaserad resurs kan inte använda några return instruktioner.

DSC konstrueras runt en Get-, Test- och Set-process .

Egenskap

En inställning som en resurs kan hantera för en komponent. Resurser har alltid minst en egenskap.

Riktlinjer

  1. Formatera egenskapsnamn som fetstil.
  2. Formatera egenskapsvärden som kod.

Exempel

Värdet för egenskapen Format i det här exemplet är JSON.

Allmänna villkor

Önskad tillståndskonfiguration

Microsofts Desired State Configuration (DSC) är en deklarativ konfigurationsplattform, där tillståndet för en dator beskrivs med ett format som bör vara tydligt för att förstå även om läsaren inte är en ämnesexpert.

Riktlinjer

  • Första omnämnandet: Microsofts Desired State Configuration-plattform (DSC)
  • Efterföljande omnämnanden: DSC-, DSCv3- eller DSC-plattform
  • Ange plattformssuffixet när du refererar till plattformen specifikt i kontexter där termen kan förväxlas med PowerShell DSC eller dsc kommandot .
  • Ange versionssuffixet när du diskuterar DSC i kontexter där termen historiskt också har tillämpats på PowerShell DSC.

Exempel

I Microsofts Desired State Configuration-plattform (DSC) representerar DSC-resurser ett standardiserat gränssnitt för att hantera inställningarna för ett system.

Du kan använda DSC för att visa en lista över tillgängliga resurser med dsc resource list kommandot .

För resurser som inte implementerar teståtgärden kan DSCv3 verifiera en instans tillstånd med ett syntetiskt test.

dsc

DSC-kommandoradsverktyget som anropar resurser och hanterar konfigurationsdokument.

Riktlinjer

  • Ange termen som DSC när du diskuterar kommandoradsverktyget i allmänhet.
  • Ange termen som DSCv3 när du diskuterar kommandoradsverktyget i kontexter där termen historiskt också har tillämpats på PowerShell DSC.
  • Använd kodformatering när du diskuterar körning av kommandot, ett specifikt underkommando eller för att skilja kommandoradsverktyget från den konceptuella plattformen.

Exempel

dsc resource test Använd kommandot för att anropa åtgärden. DSC returnerar data som innehåller:

  • Önskat tillstånd för instansen.
  • Det faktiska tillståndet för instansen.
  • Om instansen är i önskat tillstånd.
  • Listan över egenskaper som inte är i önskat tillstånd.

PowerShell Desired State Configuration

Funktionen Desired State Configuration i PowerShell. Före DSCv3 inkluderade den här termen PowerShell DSC-plattformen, den lokala Configuration Manager och PowerShell-modulen PSDesiredStateConfiguration.

För DSCv3 gäller den här termen för att definiera och använda DSC-resurser som implementeras i PowerShell med modulen PSDesiredStateConfiguration .

Riktlinjer

  • Första omnämnandet: PowerShell-Desired State Configuration
  • Efterföljande omnämnanden: PowerShell DSC eller PSDSC
  • Skilja alltid PowerShell DSC från DSCv3.
  • Ange alltid modulen PSDesiredStateConfiguration efter namn och framhävs starkt när du diskuterar själva PowerShell-modulen.

Exempel

Du kan använda PowerShell DSC-resurser med DSCv3.

Kom igång med att skapa en klassbaserad PowerShell DSC-resurs för att hantera en konfigurationsfil. I den här självstudien får du en funktionell klassbaserad PSDSC-resurs i en modul som du kan använda för vidare utbildning och anpassning.