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ů adaptéry prostředků, DSC zavolá list operaci pro tyto adaptéry, pokud možnost --adapter určuje odpovídající filtr. DSC ve výchozím nastavení nevrací žádné přizpůsobené 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ů. Filtry se vždy použijí po zjišťování prostředků.
Příklady
Příklad 1 – Výpis všech neuzpůsobených prostředků
Bez filtrů vrátí příkaz všechny zjištěné prostředky DSC, ale nevolá list operaci pro prostředky adaptéru, aby se vyčíslily přizpůsobené prostředky.
dsc resource list
Type Kind Version Caps RequireAdapter Description
------------------------------------------------------------------------------------------------------------------------------------------------------------------
DSC.PackageManagement/Brew Resource 0.1.0 gs---e DSC resource to manage Homebrew packages
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/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/WindowsPowerShell Adapter 0.1.0 gs-t-- Resource adapter to classic DSC Powershell resources in Windows PowerShell.
Microsoft.Windows/WMI Adapter 0.1.0 g----- Resource adapter to WMI resources.
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/Sleep Resource 0.1.0 gs-t--
Test/TestGroup Adapter 0.1.0 g-----
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 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.
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 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/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.
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 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.
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 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.
Příklad 6 – Výpis prostředků pro konkrétní adaptér
Pokud příkaz obsahuje možnost adaptéru , DSC zkontroluje všechny zjištěné adaptéry prostředků s odpovídajícím názvem. Pokud nějaké zjistí, zavolá list operaci adaptéru a přidá vrácený seznam přizpůsobených prostředků do seznamu zjištěných prostředků. DSC použije všechny další filtry zadané příkazem po tomto výčtu.
dsc resource list --adapter Microsoft.DSC/PowerShell
Type Kind Version Caps RequireAdapter Description
------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
PSDscResources/Archive Resource 2.12.0.0 gs-t-- Microsoft.DSC/PowerShell This module contains the standard DSC resources.
PSDscResources/Environment Resource 2.12.0.0 gs-t-- Microsoft.DSC/PowerShell This module contains the standard DSC resources.
PSDscResources/Group Resource 2.12.0.0 gs-t-- Microsoft.DSC/PowerShell This module contains the standard DSC resources.
PSDscResources/MsiPackage Resource 2.12.0.0 gs-t-- Microsoft.DSC/PowerShell This module contains the standard DSC resources.
PSDscResources/Registry Resource 2.12.0.0 gs-t-- Microsoft.DSC/PowerShell This module contains the standard DSC resources.
PSDscResources/Script Resource 2.12.0.0 gs-t-- Microsoft.DSC/PowerShell This module contains the standard DSC resources.
PSDscResources/Service Resource 2.12.0.0 gs-t-- Microsoft.DSC/PowerShell This module contains the standard DSC resources.
PSDscResources/User Resource 2.12.0.0 gs-t-- Microsoft.DSC/PowerShell This module contains the standard DSC resources.
PSDscResources/WindowsFeature Resource 2.12.0.0 gs-t-- Microsoft.DSC/PowerShell This module contains the standard DSC resources.
PSDscResources/WindowsOptionalFeature Resource 2.12.0.0 gs-t-- Microsoft.DSC/PowerShell This module contains the standard DSC resources.
PSDscResources/WindowsPackageCab Resource 2.12.0.0 gs-t-- Microsoft.DSC/PowerShell This module contains the standard DSC resources.
PSDscResources/WindowsProcess Resource 2.12.0.0 gs-t-- Microsoft.DSC/PowerShell This module contains the standard DSC resources.
Tento další příkaz určuje filtr *Windows*názvů prostředků , který omezuje seznam vrácených prostředků:
dsc resource list --adapter Microsoft.DSC/PowerShell *Windows*
Type Kind Version Caps RequireAdapter Description
------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
PSDscResources/WindowsFeature Resource 2.12.0.0 gs-t-- Microsoft.DSC/PowerShell This module contains the standard DSC resources.
PSDscResources/WindowsOptionalFeature Resource 2.12.0.0 gs-t-- Microsoft.DSC/PowerShell This module contains the standard DSC resources.
PSDscResources/WindowsPackageCab Resource 2.12.0.0 gs-t-- Microsoft.DSC/PowerShell This module contains the standard DSC resources.
PSDscResources/WindowsProcess Resource 2.12.0.0 gs-t-- Microsoft.DSC/PowerShell This module contains the standard DSC resources.
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
-a, --adapter
Určuje filtr, který definuje, pro které prostředky adaptéru se mají vytvořit výčet přizpůsobených prostředků. Ve výchozím nastavení příkaz nevolá příkaz pro prostředky adaptéru list . Když zadáte tuto možnost, DSC vyhledá prostředky adaptéru s názvy typů, které odpovídají filtru. Pokud zjistí nějaké adaptéry odpovídající filtru, zavolá list příkaz pro tyto adaptéry a vrátí přizpůsobené prostředky. DSC načte přizpůsobené prostředky před použitím jakýchkoli jiných filtrů pro příkaz.
Pokud tuto možnost zadáte pomocí filtru *, DSC zavolá list každý prostředek adaptéru, který najde, před použitím ostatních filtrů.
Type: String
Mandatory: false
-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.
Druh – určuje, jestli se jedná o
Adapterprostředek ,Groupnebo typickýResource. Další informace najdete v tématu Referenční informace ke schématu typu prostředku DSC.Version – sémantická verze prostředku.
Caps – zobrazení možností prostředku jako příznaků. Možnosti se zobrazují v následujícím pořadí a
-místo příslušného písmena, pokud prostředek nemá konkrétní schopnost:goznačuje, že prostředek má funkci Získat.soznačuje, že prostředek má funkci Nastavit.xoznačuje, že prostředek má funkci SetHandlesExist.toznačuje, že prostředek má funkci Test.doznačuje, že prostředek má možnost Odstranit.eoznačuje, že prostředek má možnost Exportovat.
Prostředek má například
Microsoft.Windows/Registrynásledující možnosti:gs--d-, označující, že máGetmožnosti ,SetaDelete.RequireAdapter – plně kvalifikovaný název typu prostředku adaptéru, 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