Udostępnij przez

Lista zasobów dsc

Streszczenie

Pobiera listę dostępnych zasobów DSC z opcjonalnym filtrem.

Składnia

dsc resource list [Options] <RESOURCE_NAME>

Opis

Podpolecenie list wyszukuje dostępne zasoby DSC i zwraca informacje o nich. DSC odnajduje zasoby, najpierw przeszukując zmienną środowiskową PATH or DSC_RESOURCE_PATH dla .dsc.resource.jsonplików , .dsc.resource.ymli dsc.resource.yaml . Aby uzyskać więcej informacji na temat zmiennych środowiskowych używanych przez DSC, zobacz Zmienne środowiskowe

Jeśli którykolwiek z odnalezionych zasobów jest adapterem zasobów, DSC wywołuje operację list dla tych adapterów, jeśli opcja --adapter określa pasujący filtr. Domyślnie usługa DSC nie zwraca żadnych dostosowanych zasobów. W przypadku korzystania z tej --adapter opcji polecenie nie zwraca żadnych niedostosowanych zasobów.

Rozszerzenie DSC zwraca listę odnalezionych zasobów z informacjami o implementacji i metadanymi. Jeśli polecenie zawiera argument, RESOURCE_NAME DSC filtruje listę odnalezionych zasobów przed ich zwróceniem. Opcje --description i --tags filtrują wyniki według opisów zasobów i tagów. Filtry są zawsze stosowane po odnajdaniu zasobów.

Dostosowana pamięć podręczna zasobów

DSC utrzymuje pamięć podręczną odnalezionych dostosowanych zasobów w celu optymalizacji wydajności. Lokalizacja pamięci podręcznej zależy od systemu operacyjnego, jak pokazano w poniższej tabeli.

System operacyjny Ścieżka pamięci podręcznej
Linux ~/.dsc/AdaptedResourcesLookupTable.json
macOS ~/.dsc/AdaptedResourcesLookupTable.json
Windows %LOCALAPPDATA%\dsc\AdaptedResourcesLookupTable.json

Przykłady

Przykład 1 — wyświetlanie listy wszystkich zasobów, które nie są dostosowane

Bez żadnych filtrów polecenie zwraca każdy odnaleziony zasób DSC, ale nie wywołuje list operacji dla zasobów karty w celu wyliczenia dostosowanych zasobów.

dsc resource list

Type                                        Kind      Version  Capabilities  RequireAdapter  Description
--------------------------------------------------------------------------------------------------------------------------------------------------------------
Microsoft.DSC.Debug/Echo                    Resource  1.0.0    gs--t---
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 configu…
Microsoft.DSC/Group                         Group     0.1.0    gs--t---                      All resources in the supplied configuration is treated as a grou…
Microsoft.DSC/Include                       Importer  0.1.0    gs--t---                      Allows including a configuration file with optional parameter fi…
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-w-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 …
Microsoft/OSInfo                            Resource  0.1.0    g-----e-                      Returns information about the operating system.

Przykład 2 — Wyświetlanie listy określonego zasobu

RESOURCE_NAME Jeśli argument nie zawiera symbolu wieloznacznego, polecenie zwraca tylko zasób o określonej nazwie typu.

dsc resource list Microsoft.DSC/Group

Type                 Kind   Version  Capabilities  RequireAdapter  Description
-------------------------------------------------------------------------------------------------------------------------------------
Microsoft.DSC/Group  Group  0.1.0    gs--t---                      All resources in the supplied configuration is treated as a group.

Przykład 3 — Wyświetlanie listy zasobów o pasującej nazwie typu

RESOURCE_NAME Gdy argument zawiera symbol wieloznaczny, polecenie zwraca każdy zasób o pasującej nazwie typu.

dsc resource list Microsoft.DSC/*

Type                      Kind      Version  Capabilities  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     Importer  0.1.0    gs--t---                      Allows including a configuration file with optional parameter file.
Microsoft.DSC/PowerShell  Adapter   0.1.0    gs--t-e-                      Resource adapter to classic DSC Powershell resources.

Przykład 4 — wyświetlanie listy zasobów z pasującym opisem

Jeśli polecenie zawiera opcję *--description , wyniki zawierają zasoby, które mają opis zawierający określoną wartość.

dsc resource list --description 'supplied configuration'

Type                     Kind   Version  Capabilities  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.

Przykład 5 — Wyświetlanie listy zasobów z pasującymi tagami

Jeśli polecenie zawiera wiele wystąpień --tags opcji, wyniki obejmują zasoby, które mają dowolny z określonych tagów.

dsc resource list --tags Windows --tags Linux

Type                        Kind      Version  Capabilities  RequireAdapter  Description
----------------------------------------------------------------------------------------------------------------------------
Microsoft.Windows/Registry  Resource  0.1.0    gs-w-d--                      Manage Windows Registry keys and values
Microsoft/OSInfo            Resource  0.1.0    g-----e-                      Returns information about the operating system.

Przykład 6 — Wyświetlanie listy zasobów dla określonej karty

Gdy polecenie zawiera tę --adapter opcję, konfiguracja DSC sprawdza, czy nie ma żadnych odnalezionych kart zasobów o pasującej nazwie. Jeśli odnajdzie jakieś, wywołuje operację list dla karty i dodaje zwróconą listę dostosowanych zasobów do odnalezionej listy zasobów. Rozszerzenie DSC stosuje wszelkie dalsze filtry określone za pomocą polecenia po tym wyliczeniem.

dsc resource list --adapter Microsoft.Windows/WindowsPowerShell

To następne polecenie określa filtr *Windows*nazw zasobów , ograniczając listę zwracanych zasobów:

dsc resource list --adapter Microsoft.Windows/WindowsPowerShell *Windows*

Argumenty

RESOURCE_NAME

Określa opcjonalny filtr do zastosowania dla nazw typów odnalezionych zasobów DSC. Filtr może zawierać symbole wieloznaczne (*). Filtr nie uwzględnia wielkości liter.

Po określeniu tego argumentu rozszerzenie DSC filtruje wyniki tak, aby zawierały tylko zasoby, w których nazwa typu zasobu jest zgodna z filtrem.

Na przykład określenie filtru Microsoft.* zwraca tylko zasoby opublikowane przez firmę Microsoft. Określenie filtru *Sql* powoduje zwrócenie dowolnego zasobu z ciągiem Sql w nazwie, niezależnie od wielkości liter.

Type      : string
Mandatory : false

Opcje

-a, --adapter

Określa filtr do zdefiniowania zasobów adaptera do wyliczania dostosowanych zasobów. Domyślnie polecenie nie wywołuje list polecenia dla zasobów karty. Po określeniu tej opcji dsC szuka zasobów adaptera z nazwami typów pasujących do filtru. Jeśli wykryje jakiekolwiek karty pasujące do filtru, wywołuje list polecenie dla tych adapterów i zwraca dostosowane zasoby. Rozszerzenie DSC pobiera dostosowane zasoby przed zastosowaniem innych filtrów dla polecenia .

W przypadku korzystania z tej opcji polecenie nie zwraca żadnych niedostosowanych zasobów.

Jeśli określisz tę opcję za pomocą filtru *, DSC wywołuje list każdy znaleziony zasób karty przed zastosowaniem innych filtrów.

Type        : string
Mandatory   : false
LongSyntax  : --adapter <ADAPTER_NAME>
ShortSyntax : -a <ADAPTER_NAME>

-d, --opis

Określa ciąg, który ma być zgodny z opisem zasobu. Po określeniu tej opcji rozszerzenie DSC filtruje zasoby według ich ciągów opisu. Filtr jest niewrażliwy na wielkość liter i pasuje do wartości w dowolnym miejscu w ciągu opisu. Symbole wieloznaczne nie są dozwolone.

Type        : string
Mandatory   : false
LongSyntax  : --description <DESCRIPTION>
ShortSyntax : -d <DESCRIPTION>

-t, --tags

Określa tag zasobu do filtrowania. Po określeniu tej opcji rozszerzenie DSC filtruje zasoby i uwzględnia tylko te z pasującym tagiem. Filtr jest niewrażliwy na wielkość liter. Symbole wieloznaczne nie są dozwolone.

Tę opcję można określić więcej niż raz, aby filtrować zestaw tagów. Wyniki obejmują zasoby, które mają co najmniej jeden z tagów określonych za pomocą tej opcji.

Type        : string
Mandatory   : false
LongSyntax  : --tags <TAGS>
ShortSyntax : -t <TAGS>

-o, --format-wyjściowy

Opcja --output-format określa, który format DSC jest używany dla danych zwracanych przez polecenie. Dostępne formaty to:

  • json , aby wyemitować dane jako wiersz JSON.
  • pretty-json , aby wyemitować dane w formacie JSON ze znakami nowej linii, wcięciami i spacjami w celu zapewnienia czytelności.
  • yaml , aby wyemitować dane jako YAML.
  • table-no-truncate , aby wyemitować dane jako tabelę podsumowania bez obcinania każdego wiersza do bieżącej szerokości konsoli.

Domyślny format danych wyjściowych zależy od tego, czy DSC wykryje, że dane wyjściowe są przekierowywane, czy przechwytywane jako zmienna:

  • Jeśli polecenie nie jest przekierowywane ani przechwytywane, DSC wyświetla dane wyjściowe jako tabelę podsumowania opisaną w sekcji Dane wyjściowe tego dokumentu.
  • Jeśli dane wyjściowe polecenia są przekierowywane lub przechwytywane, DSC emituje dane jako json format do stdout.

W przypadku korzystania z tej opcji DSC używa określonego formatu niezależnie od tego, czy polecenie jest przekierowywane, czy przechwytywane.

Gdy polecenie nie jest przekierowywane ani przechwytywane, dane wyjściowe w konsoli są formatowane w celu zwiększenia czytelności. Gdy polecenie nie jest przekierowywane ani przechwytywane, dane wyjściowe zawierają sekwencje terminali do formatowania.

Type        : string
Mandatory   : false
ValidValues : [json, pretty-json, yaml, table-no-truncate]
LongSyntax  : --output-format <OUTPUT_FORMAT>
ShortSyntax : -o <OUTPUT_FORMAT>

-h, --help (pomoc)

Wyświetla pomoc dla bieżącego polecenia lub podpolecenia. Po określeniu tej opcji aplikacja ignoruje wszystkie inne opcje i argumenty.

Type        : boolean
Mandatory   : false
LongSyntax  : --help
ShortSyntax : -h

Wyjście

To polecenie zwraca sformatowaną tablicę zawierającą obiekt dla każdego zasobu, który zawiera typ zasobu, wersję, ustawienia manifestu i inne metadane. Aby uzyskać więcej informacji, zobacz schemat wyników listy zasobów dsc.

Jeśli dane wyjściowe polecenia nie są przechwytywane ani przekierowywane, są domyślnie wyświetlane w konsoli jako tabela podsumowania zwróconych zasobów. Tabela podsumowania zawiera następujące kolumny wyświetlane w podanej kolejności:

Aby uzyskać więcej informacji na temat formatowania danych wyjściowych, zobacz opcję --output-format .

  • Last updated on