Seznam prostředků dsc
Synopse
Vrátí seznam dostupných prostředků DSC s volitelným filtrem.
Syntax
dsc resource list [Options] <RESOURCE_NAME>
Description
Podpříkaz list vyhledá dostupné prostředky DSC a vrátí jejich informace. DSC zjišťuje prostředky tak, že nejprve vyhledá PATH v proměnné .dsc.resource.jsonprostředí nebo DSC_RESOURCE_PATH soubory , .dsc.resource.ymladsc.resource.yaml. Další informace o proměnných prostředí, které DSC používá, najdete v tématu Proměnné prostředí.
Pokud jsou některé ze zjištěných prostředků poskytovateli prostředků, DSC pak zavolá zprostředkovatele a vypíše také jejich prostředky.
DSC vrátí seznam zjištěných prostředků s informacemi o implementaci a metadaty. Pokud příkaz obsahuje RESOURCE_NAME argument, DSC před vrácením vyfiltruje seznam zjištěných prostředků. Možnosti popisů a značek filtrují výsledky podle popisů a značek prostředků.
Příklady
Příklad 1 – Výpis všech prostředků
Bez jakýchkoli filtrů vrátí příkaz všechny zjištěné prostředky DSC.
dsc resource list
Type Version Methods Requires Description
----------------------------------------------------------------------------------------------------------------------------------------------------
DSC.PackageManagement/Brew 0.1.0 get, set, export DSC resource to manage Homebrew packages
DSC/AssertionGroup 0.1.0 get, set, test `test` will be invoked for all resources in the supplied configuration.
DSC/Group 0.1.0 get, set, test All resources in the supplied configuration is treated as a group.
DSC/ParallelGroup 0.1.0 get, set, test All resources in the supplied configuration run concurrently.
DSC/PowerShellGroup 0.1.0 get, set, test, export Resource provider to classic DSC Powershell resources.
Microsoft.Windows/Registry 0.1.0 get, set, test Registry configuration provider for the Windows Registry
Microsoft/OSInfo 0.1.0 get, export Returns information about the operating system.
Microsoft/Process 0.1.0 get, set, test, export Returns information about running processes.
Test/Echo 0.1.0 get, set, test
Test/Sleep 0.1.0 get, set, test
Test/TestGroup 0.1.0 get
Test/TestResource1 1.0.0 get Test/TestGroup This is a test resource.
Test/TestResource2 1.0.1 get Test/TestGroup This is a test resource.
Příklad 2 – Výpis konkrétního prostředku
RESOURCE_NAME Pokud argument neobsahuje zástupný znak, příkaz vrátí pouze prostředek se zadaným názvem typu.
dsc resource list DSC/Group
Type Version Methods Requires Description
----------------------------------------------------------------------------------------------------------------
DSC/Group 0.1.0 get, set, test All resources in the supplied configuration is treated as a group.
Příklad 3 – Výpis prostředků s odpovídajícím názvem typu
RESOURCE_NAME Pokud argument obsahuje zástupný znak, příkaz vrátí každý prostředek s odpovídajícím názvem typu.
dsc resource list DSC/*
Type Version Methods Requires Description
---------------------------------------------------------------------------------------------------------------------------------------
DSC/AssertionGroup 0.1.0 get, set, test `test` will be invoked for all resources in the supplied configuration.
DSC/Group 0.1.0 get, set, test All resources in the supplied configuration is treated as a group.
DSC/ParallelGroup 0.1.0 get, set, test All resources in the supplied configuration run concurrently.
DSC/PowerShellGroup 0.1.0 get, set, test, export Resource provider to classic DSC Powershell resources.
Příklad 4 – Výpis prostředků s odpovídajícím popisem
Pokud příkaz obsahuje možnost popis , výsledky zahrnují prostředky, které mají popis obsahující zadanou hodnotu.
dsc resource list --description 'supplied configuration'
Type Version Methods Requires Description
------------------------------------------------------------------------------------------------------------------------------
DSC/AssertionGroup 0.1.0 get, set, test `test` will be invoked for all resources in the supplied configuration.
DSC/Group 0.1.0 get, set, test All resources in the supplied configuration is treated as a group.
DSC/ParallelGroup 0.1.0 get, set, test All resources in the supplied configuration run concurrently.
Příklad 5 – Výpis prostředků s odpovídajícími značkami
Pokud příkaz obsahuje více instancí možnosti značek , výsledky zahrnují prostředky, které mají některou ze zadaných značek.
dsc resource list --tags Windows --tags Linux
Type Version Methods Requires Description
-----------------------------------------------------------------------------------------------------------------------
Microsoft.Windows/Registry 0.1.0 get, set, test Registry configuration provider for the Windows Registry
Microsoft/OSInfo 0.1.0 get, export Returns information about the operating system.
Argumenty
RESOURCE_NAME
Určuje volitelný filtr, který se má použít pro názvy typů zjištěných prostředků DSC. Filtr může obsahovat zástupné cardy (*). Ve filtru se nerozlišuje velká a malá písmena.
Po zadání tohoto argumentu služba DSC vyfiltruje výsledky tak, aby zahrnovaly pouze prostředky, u kterých název typu prostředku odpovídá filtru.
Například zadání filtru Microsoft.* vrátí pouze prostředky publikované Microsoftem.
Zadání filtru *Sql* vrátí všechny prostředky s řetězcem Sql v názvu bez ohledu na velikost písmen.
Type: String
Mandatory: false
Možnosti
-d, --description
Určuje řetězec, který se má shodovat v popisu prostředku. Když je tato možnost zadána, DSC filtruje prostředky podle jejich popisných řetězců. Filtr nerozlišuje velká a malá písmena a odpovídá hodnotě kdekoli v řetězci popisu. Zástupné cardy nejsou povolené.
Type: String
Mandatory: false
-t, --tags
Určuje značku prostředku, podle které se má filtrovat. Když je tato možnost zadaná, DSC vyfiltruje prostředky a zahrne pouze ty, které mají odpovídající značku. Filtr nerozlišuje velká a malá písmena. Zástupné cardy nejsou povolené.
Pokud chcete filtrovat sadu značek, můžete tuto možnost zadat vícekrát. Výsledky zahrnují prostředky, které mají alespoň jednu ze značek zadaných pomocí této možnosti.
Type: String
Mandatory: false
-f, --format
Možnost --format řídí formát výstupu konzoly pro příkaz. Pokud je výstup příkazu přesměrovaný nebo zachycený jako proměnná, je výstupem vždy řada řádků JSON představující každý vrácený prostředek. Pokud tato možnost není zadaná, zobrazí se ve výstupu příkazu tabulka představující souhrn vrácených prostředků. Další informace najdete v tématu Výstup.
Type: String
Mandatory: false
DefaultValue: yaml
ValidValues: [json, pretty-json, yaml]
-h, --help
Zobrazí nápovědu k aktuálnímu příkazu nebo dílčímu příkazu. Když zadáte tuto možnost, aplikace ignoruje všechny možnosti a argumenty za touto možností.
Type: Boolean
Mandatory: false
Výstup
Tento příkaz vrátí objekt JSON pro každý prostředek, který zahrnuje typ prostředku, jeho verzi, nastavení manifestu a další metadata. Další informace najdete v tématu Schéma výsledků seznamu prostředků dsc.
Pokud se výstup příkazu nezachytí nebo přesměruje, zobrazí se ve výchozím nastavení v konzole jako souhrnná tabulka vrácených prostředků. Souhrnná tabulka obsahuje následující sloupce zobrazené v uvedeném pořadí:
- Type – plně kvalifikovaný název typu prostředku.
- Version – sémantická verze prostředku.
- Metody – čárkami oddělený seznam implementovaných metod pro prostředek. Platné metody jsou
get,set,testaexport. Prostředky, které se neimplementujítest, se spoléhají na funkce syntetického testování DSC. - Vyžaduje – Plně kvalifikovaný název typu prostředku poskytovatele, který DSC používá k vyvolání vráceného prostředku.
- Popis – krátký popis účelu a použití zdroje.
Pokud chcete v konzole zobrazit výstupní objekty jako objekty JSON nebo YAML, použijte možnost --format .
Váš názor
Připravujeme: V průběhu roku 2024 budeme postupně vyřazovat problémy z GitHub coby mechanismus zpětné vazby pro obsah a nahrazovat ho novým systémem zpětné vazby. Další informace naleznete v tématu: https://aka.ms/ContentUserFeedback.
Odeslat a zobrazit názory pro