dsc-erőforráslista
Áttekintés
A választható szűrővel rendelkező elérhető DSC-erőforrások listáját adja vissza.
Szintaxis
dsc resource list [Options] <RESOURCE_NAME>
Leírás
A list
alparancs megkeresi az elérhető DSC-erőforrásokat, és visszaadja az adataikat. A DSC először a .dsc.resource.json
, .dsc.resource.yml
és dsc.resource.yaml
fájlok PATH
vagy DSC_RESOURCE_PATH
környezeti változójának keresésével deríti fel az erőforrásokat. További információ a DSC által használt környezeti változókról: Környezeti változók
Ha a felderített erőforrások egyike erőforrás-adapter, a DSC meghívja az list
műveletet ezekhez az adapterekhez, ha a --adapter beállítás egyező szűrőt ad meg. Alapértelmezés szerint a DSC nem ad vissza adaptált erőforrásokat.
A DSC a felderített erőforrások listáját adja vissza azok implementálási adataival és metaadataival. Ha a parancs tartalmazza a RESOURCE_NAME
argumentumot, a DSC szűri a felderített erőforrások listáját, mielőtt visszaküldené őket. A leírási és címkék beállítások az erőforrások leírása és címkéi alapján szűrik az eredményeket. A szűrők mindig az erőforrás-felderítés után lesznek alkalmazva.
Példák
1. példa – Az összes nem adaptált erőforrás listázása
Szűrők nélkül a parancs minden felderített DSC-erőforrást visszaad, de nem hívja meg az adaptererőforrások list
műveletét az adaptált erőforrások számbavételéhez.
dsc resource list
Type Kind Version Caps RequireAdapter Description
--------------------------------------------------------------------------------------------------------------------------------------------------------------------
Microsoft.DSC.Transitional/RunCommandOnSet Resource 0.1.0 gs------ Takes a single-command line to execute on DSC set operation
Microsoft.DSC/Assertion Group 0.1.0 gs--t--- `test` will be invoked for all resources in the supplied configuration.
Microsoft.DSC/Group Group 0.1.0 gs--t--- All resources in the supplied configuration is treated as a group.
Microsoft.DSC/Include Import 0.1.0 -------r Allows including a configuration file contents into current configuration.
Microsoft.DSC/Parallel Group 0.1.0 gs--t--- All resources in the supplied configuration run concurrently.
Microsoft.DSC/PowerShell Adapter 0.1.0 gs--t-e- Resource adapter to classic DSC Powershell resources.
Microsoft.Windows/RebootPending Resource 0.1.0 g------- Returns info about pending reboot.
Microsoft.Windows/Registry Resource 0.1.0 gs---d-- Manage Windows Registry keys and values
Microsoft.Windows/WMI Adapter 0.1.0 g------- Resource adapter to WMI resources.
Microsoft.Windows/WindowsPowerShell Adapter 0.1.0 gs--t--- Resource adapter to classic DSC Powershell resources in Windows PowerShell.
Microsoft/OSInfo Resource 0.1.0 g-----e- Returns information about the operating system.
Microsoft/Process Resource 0.1.0 gs--t-e- Returns information about running processes.
Test/Delete Resource 0.1.0 g----d--
Test/Echo Resource 0.1.0 gs--t---
Test/Exist Resource 0.1.0 gsx-----
Test/ExitCode Resource 0.1.0 g-------
Test/Sleep Resource 0.1.0 gs--t---
Test/TestGroup Adapter 0.1.0 g-------
Test/Trace Resource 0.1.0 gs--t---
Test/WhatIf Resource 0.1.0 gs-w----
2. példa – Adott erőforrás listázása
Ha a RESOURCE_NAME
argumentum nem tartalmaz helyettesítő karaktert, a parancs csak a megadott típusnévvel rendelkező erőforrást adja vissza.
dsc resource list Microsoft.DSC/Group
Type Kind Version Caps RequireAdapter Description
---------------------------------------------------------------------------------------------------------------------------------
Microsoft.DSC/Group Group 0.1.0 gs--t--- All resources in the supplied configuration is treated as a group.
3. példa – Egyező típusnévvel rendelkező erőforrások listázása
Ha a RESOURCE_NAME
argumentum helyettesítő karaktert tartalmaz, a parancs minden erőforrást egyező típusnévvel ad vissza.
dsc resource list Microsoft.DSC/*
Type Kind Version Caps RequireAdapter Description
------------------------------------------------------------------------------------------------------------------------------------------------
Microsoft.DSC/Assertion Group 0.1.0 gs--t--- `test` will be invoked for all resources in the supplied configuration.
Microsoft.DSC/Group Group 0.1.0 gs--t--- All resources in the supplied configuration is treated as a group.
Microsoft.DSC/Include Import 0.1.0 -------r Allows including a configuration file contents into current configuration.
Microsoft.DSC/Parallel Group 0.1.0 gs--t--- All resources in the supplied configuration run concurrently.
Microsoft.DSC/PowerShell Adapter 0.1.0 gs--t-e- Resource adapter to classic DSC Powershell resources.
4. példa – Erőforrások listázása egyező leírással
Ha a parancs tartalmazza a leírási beállítást, az eredmények olyan erőforrásokat tartalmaznak, amelyek a megadott értéket tartalmazó leírással rendelkeznek.
dsc resource list --description 'supplied configuration'
Type Kind Version Caps RequireAdapter Description
------------------------------------------------------------------------------------------------------------------------------------------
Microsoft.DSC/Assertion Group 0.1.0 gs--t--- `test` will be invoked for all resources in the supplied configuration.
Microsoft.DSC/Group Group 0.1.0 gs--t--- All resources in the supplied configuration is treated as a group.
Microsoft.DSC/Parallel Group 0.1.0 gs--t--- All resources in the supplied configuration run concurrently.
5. példa – Erőforrások listázása egyező címkékkel
Ha a parancs a címkék több példányát is tartalmazza beállítás, az eredmények közé tartoznak a megadott címkéket tartalmazó erőforrások.
dsc resource list --tags Windows --tags Linux
Type Kind Version Caps RequireAdapter Description
------------------------------------------------------------------------------------------------------------------------
Microsoft.Windows/Registry Resource 0.1.0 gs---d-- Manage Windows Registry keys and values
Microsoft/OSInfo Resource 0.1.0 g-----e- Returns information about the operating system.
6. példa – Erőforrások listázása egy adott adapterhez
Ha a parancs tartalmazza az adapter beállítást, a DSC ellenőrzi a felderített, egyező nevű erőforrás-adaptereket. Ha észleli valamelyiket, meghívja az adapter list
műveletét, és hozzáadja az adaptált erőforrások visszaadott listáját a felderített erőforráslistához. A DSC az enumerálás után a paranccsal megadott további szűrőket alkalmazza.
dsc resource list --adapter Microsoft.Windows/WindowsPowerShell
Type Kind Version Caps RequireAdapter Description
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------
PSDesiredStateConfiguration/Archive Resource 1.1 gs--t--- Microsoft.Windows/WindowsPowerShell
PSDesiredStateConfiguration/Environment Resource 1.1 gs--t--- Microsoft.Windows/WindowsPowerShell
PSDesiredStateConfiguration/File Resource 1.0.0 gs--t--- Microsoft.Windows/WindowsPowerShell
PSDesiredStateConfiguration/Group Resource 1.1 gs--t--- Microsoft.Windows/WindowsPowerShell
PSDesiredStateConfiguration/GroupSet Resource 1.1 gs--t--- Microsoft.Windows/WindowsPowerShell
PSDesiredStateConfiguration/Log Resource 1.1 gs--t--- Microsoft.Windows/WindowsPowerShell
PSDesiredStateConfiguration/Package Resource 1.1 gs--t--- Microsoft.Windows/WindowsPowerShell
PSDesiredStateConfiguration/ProcessSet Resource 1.1 gs--t--- Microsoft.Windows/WindowsPowerShell
PSDesiredStateConfiguration/Registry Resource 1.1 gs--t--- Microsoft.Windows/WindowsPowerShell
PSDesiredStateConfiguration/Script Resource 1.1 gs--t--- Microsoft.Windows/WindowsPowerShell
PSDesiredStateConfiguration/Service Resource 1.1 gs--t--- Microsoft.Windows/WindowsPowerShell
PSDesiredStateConfiguration/ServiceSet Resource 1.1 gs--t--- Microsoft.Windows/WindowsPowerShell
PSDesiredStateConfiguration/SignatureValidation Resource 1.0.0 gs--t--- Microsoft.Windows/WindowsPowerShell
PSDesiredStateConfiguration/User Resource 1.1 gs--t--- Microsoft.Windows/WindowsPowerShell
PSDesiredStateConfiguration/WaitForAll Resource 1.1 gs--t--- Microsoft.Windows/WindowsPowerShell
PSDesiredStateConfiguration/WaitForAny Resource 1.1 gs--t--- Microsoft.Windows/WindowsPowerShell
PSDesiredStateConfiguration/WaitForSome Resource 1.1 gs--t--- Microsoft.Windows/WindowsPowerShell
PSDesiredStateConfiguration/WindowsFeature Resource 1.1 gs--t--- Microsoft.Windows/WindowsPowerShell
PSDesiredStateConfiguration/WindowsFeatureSet Resource 1.1 gs--t--- Microsoft.Windows/WindowsPowerShell
PSDesiredStateConfiguration/WindowsOptionalFeature Resource 1.1 gs--t--- Microsoft.Windows/WindowsPowerShell
PSDesiredStateConfiguration/WindowsOptionalFeatureSet Resource 1.1 gs--t--- Microsoft.Windows/WindowsPowerShell
PSDesiredStateConfiguration/WindowsPackageCab Resource 1.1 gs--t--- Microsoft.Windows/WindowsPowerShell
PSDesiredStateConfiguration/WindowsProcess Resource 1.1 gs--t--- Microsoft.Windows/WindowsPowerShell
PSDscResources/Archive Resource 2.12.0.0 gs--t--- Microsoft.Windows/WindowsPowerShell This module contains the standard DSC resources.
PSDscResources/Environment Resource 2.12.0.0 gs--t--- Microsoft.Windows/WindowsPowerShell This module contains the standard DSC resources.
PSDscResources/Group Resource 2.12.0.0 gs--t--- Microsoft.Windows/WindowsPowerShell This module contains the standard DSC resources.
PSDscResources/MsiPackage Resource 2.12.0.0 gs--t--- Microsoft.Windows/WindowsPowerShell This module contains the standard DSC resources.
PSDscResources/Registry Resource 2.12.0.0 gs--t--- Microsoft.Windows/WindowsPowerShell This module contains the standard DSC resources.
PSDscResources/Script Resource 2.12.0.0 gs--t--- Microsoft.Windows/WindowsPowerShell This module contains the standard DSC resources.
PSDscResources/Service Resource 2.12.0.0 gs--t--- Microsoft.Windows/WindowsPowerShell This module contains the standard DSC resources.
PSDscResources/User Resource 2.12.0.0 gs--t--- Microsoft.Windows/WindowsPowerShell This module contains the standard DSC resources.
PSDscResources/WindowsFeature Resource 2.12.0.0 gs--t--- Microsoft.Windows/WindowsPowerShell This module contains the standard DSC resources.
PSDscResources/WindowsOptionalFeature Resource 2.12.0.0 gs--t--- Microsoft.Windows/WindowsPowerShell This module contains the standard DSC resources.
PSDscResources/WindowsPackageCab Resource 2.12.0.0 gs--t--- Microsoft.Windows/WindowsPowerShell This module contains the standard DSC resources.
PSDscResources/WindowsProcess Resource 2.12.0.0 gs--t--- Microsoft.Windows/WindowsPowerShell This module contains the standard DSC resources.
Ez a következő parancs megadja az erőforrásnév szűrőt *Windows*
, amely korlátozza a visszaadott erőforrások listáját:
dsc resource list --adapter Microsoft.Windows/WindowsPowerShell *Windows*
Type Kind Version Caps RequireAdapter Description
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------
PSDesiredStateConfiguration/WindowsFeature Resource 1.1 gs--t--- Microsoft.Windows/WindowsPowerShell
PSDesiredStateConfiguration/WindowsFeatureSet Resource 1.1 gs--t--- Microsoft.Windows/WindowsPowerShell
PSDesiredStateConfiguration/WindowsOptionalFeature Resource 1.1 gs--t--- Microsoft.Windows/WindowsPowerShell
PSDesiredStateConfiguration/WindowsOptionalFeatureSet Resource 1.1 gs--t--- Microsoft.Windows/WindowsPowerShell
PSDesiredStateConfiguration/WindowsPackageCab Resource 1.1 gs--t--- Microsoft.Windows/WindowsPowerShell
PSDesiredStateConfiguration/WindowsProcess Resource 1.1 gs--t--- Microsoft.Windows/WindowsPowerShell
PSDscResources/WindowsFeature Resource 2.12.0.0 gs--t--- Microsoft.Windows/WindowsPowerShell This module contains the standard DSC resources.
PSDscResources/WindowsOptionalFeature Resource 2.12.0.0 gs--t--- Microsoft.Windows/WindowsPowerShell This module contains the standard DSC resources.
PSDscResources/WindowsPackageCab Resource 2.12.0.0 gs--t--- Microsoft.Windows/WindowsPowerShell This module contains the standard DSC resources.
PSDscResources/WindowsProcess Resource 2.12.0.0 gs--t--- Microsoft.Windows/WindowsPowerShell This module contains the standard DSC resources.
Érvek
RESOURCE_NAME
A felderített DSC-erőforrások típusneveit nem kötelező szűrőként megadni. A szűrő tartalmazhat helyettesítő karaktereket (*
). A szűrő nem érzékeny a kis- és nagybetűkre.
Ha ez az argumentum meg van adva, a DSC úgy szűri az eredményeket, hogy csak azokat az erőforrásokat tartalmazza, amelyek erőforrástípusának neve megegyezik a szűrővel.
A szűrő Microsoft.*
megadása például csak a Microsoft által közzétett erőforrásokat adja vissza.
A szűrő *Sql*
megadása minden olyan erőforrást ad vissza, amelynek nevében a sztring Sql
, függetlenül a burkolattól.
Type: String
Mandatory: false
Beállítások
-a, --adapter
Egy szűrőt ad meg, amely meghatározza, hogy mely adaptererőforrások számbavételéhez használjon adaptált erőforrásokat. Alapértelmezés szerint a parancs nem hívja meg az adaptererőforrások list
parancsát. A beállítás megadásakor a DSC olyan adapter-erőforrásokat keres, amelyek típusnevei megegyeznek a szűrővel. Ha észleli a szűrőnek megfelelő adaptereket, meghívja az list
parancsot ezekhez az adapterekhez, és visszaadja az adaptált erőforrásokat. A DSC lekéri az adaptált erőforrásokat, mielőtt bármilyen más szűrőt alkalmaz a parancshoz.
Ha ezt a beállítást a *
szűrővel adja meg, a DSC a többi szűrő alkalmazása előtt meghívja list
minden olyan adapter-erőforráshoz, amit talál.
Type: String
Mandatory: false
-d, --description
Egy erőforrás leírásában egyező sztringet ad meg. Ha ez a beállítás meg van adva, a DSC a leírási sztringek alapján szűri az erőforrásokat. A szűrő nem érzékeny a kis- és nagybetűkre, és a leírási sztringben bárhol megegyezik az értékkel. A helyettesítő karakterek használata nem engedélyezett.
Type: String
Mandatory: false
-t, --tags
Megadja a szűrni kívánt erőforráscímkét. Ha ez a beállítás meg van adva, a DSC szűri az erőforrásokat, és csak a megfelelő címkével rendelkezőket tartalmazza. A szűrő nem érzékeny a kis- és nagybetűkre. A helyettesítő karakterek használata nem engedélyezett.
Ezt a beállítást többször is megadhatja, ha címkékre szeretne szűrni. Az eredmények közé tartoznak azok az erőforrások, amelyek rendelkeznek az ezzel a beállítással megadott címkék legalább egyikével.
Type: String
Mandatory: false
-f, --format
A --format
beállítás szabályozza a parancs konzolkimeneti formátumát. Ha a parancs kimenete átirányítva vagy rögzítve van változóként, a kimenet mindig az egyes visszaadott erőforrásokat képviselő JSON-sorok sorozata. Ha ez a beállítás nincs megadva, a parancs kimenete egy, a visszaadott erőforrások összegzését megjelenítő táblát jelenít meg. További információ: Kimeneti.
Type: String
Mandatory: false
DefaultValue: yaml
ValidValues: [json, pretty-json, yaml]
-h, --help
Megjeleníti az aktuális parancs vagy alparancs súgóját. A beállítás megadásakor az alkalmazás figyelmen kívül hagyja az összes beállítást és argumentumot.
Type: Boolean
Mandatory: false
Hozam
Ez a parancs egy JSON-objektumot ad vissza minden erőforráshoz, amely tartalmazza az erőforrás típusát, verzióját, jegyzékbeállításait és egyéb metaadatait. További információ: dsc erőforráslista eredményséma.
Ha a parancs kimenete nincs rögzítve vagy átirányítva, alapértelmezés szerint a konzolon a visszaadott erőforrások összefoglaló táblázataként jelenik meg. Az összefoglaló táblázat a következő oszlopokat tartalmazza, a felsorolt sorrendben megjelenítve:
Típus – Az erőforrás teljes típusneve.
Kind – Az erőforrás
Adapter
,Group
vagy tipikusResource
. További információ: DSC-erőforrástípus sémahivatkozása.Verzió – Az erőforrás szemantikai verziója.
Caps – Az erőforrás képességeinek megjelenítése jelzőként. A képességek a következő sorrendben jelennek meg, a megfelelő betű helyett egy
-
használatával, ha az erőforrás nem rendelkezik adott képességgel:g
azt jelzi, hogy az erőforrás rendelkezik a Get képesség.s
azt jelzi, hogy az erőforrás rendelkezik a Beállítás funkcióvalx
azt jelzi, hogy az erőforrás rendelkezik SetHandlesExist képességgelw
azt jelzi, hogy az erőforrás rendelkezik WhatIf-képességgelt
azt jelzi, hogy az erőforrás rendelkezik a tesztelési képességgeld
azt jelzi, hogy az erőforrás rendelkezik a Törlés funkcióvale
azt jelzi, hogy az erőforrás rendelkezik Exportálási képességgelr
azt jelzi, hogy az erőforrás rendelkezik a Feloldás funkcióval
Az
Microsoft.Windows/Registry
erőforrás például a következő képességekkel rendelkezik:gs--d-
, amely azt jelzi, hogy rendelkezik aGet
,Set
ésDelete
képességekkel.RequireAdapter – Annak az adaptererőforrásnak a teljes típusneve, amelyet a DSC a visszaadott erőforrás meghívásához használ.
Leírás – Az erőforrás céljának és használatának rövid leírása.
A kimeneti objektumok JSON- vagy YAML-objektumként való megjelenítéséhez használja a --format lehetőséget.