Dela via

dsc-resurslista

  • Artikel

Sammanfattning

Returnerar listan över tillgängliga DSC-resurser med ett valfritt filter.

Syntax

dsc resource list [Options] <RESOURCE_NAME>

Beskrivning

list underkommando söker efter tillgängliga DSC-resurser och returnerar deras information. DSC identifierar resurser genom att först söka i miljövariabeln PATH eller DSC_RESOURCE_PATH efter .dsc.resource.json, .dsc.resource.ymloch dsc.resource.yaml filer. Mer information om miljövariabler som DSC använder finns i Miljövariabler

Om någon av de identifierade resurserna är resurskort anropar DSC den list åtgärden för dessa kort om alternativet --adapter anger ett matchande filter. DSC returnerar som standard inte några anpassade resurser.

DSC returnerar listan över identifierade resurser med deras implementeringsinformation och metadata. Om kommandot innehåller argumentet RESOURCE_NAME filtrerar DSC listan över identifierade resurser innan de returneras. Den beskrivningen och taggar alternativ filtrerar resultatet efter resursbeskrivningar och taggar. Filter tillämpas alltid efter resursidentifiering.

Exempel

Exempel 1 – Lista alla icke-anpassade resurser

Utan filter returnerar kommandot varje identifierad DSC-resurs, men anropar inte åtgärden list för nätverkskortresurser för att räkna upp anpassade resurser.

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----

Exempel 2 – Lista en specifik resurs

När argumentet RESOURCE_NAME inte innehåller ett jokertecken returnerar kommandot endast resursen med det angivna typnamnet.

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.

Exempel 3 – Lista resurser med ett matchande typnamn

När argumentet RESOURCE_NAME innehåller ett jokertecken returnerar kommandot varje resurs med ett matchande typnamn.

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.

Exempel 4 – Lista resurser med en matchande beskrivning

När kommandot innehåller alternativet beskrivning innehåller resultatet resurser som har en beskrivning som innehåller det angivna värdet.

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.

Exempel 5 – Lista resurser med matchande taggar

När kommandot innehåller flera instanser av alternativet taggar innehåller resultatet resurser som har någon av de angivna taggarna.

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.

Exempel 6 – Lista resurser för ett specifikt kort

När kommandot innehåller alternativet adapter söker DSC efter identifierade resurskort med ett matchande namn. Om den identifierar någon anropar den sedan åtgärden list för adaptern och lägger till den returnerade listan över anpassade resurser i listan över identifierade resurser. DSC tillämpar ytterligare filter som anges med kommandot efter den här uppräkningen.

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.

Nästa kommando anger resursnamnsfiltret *Windows*, vilket begränsar listan över returnerade resurser:

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.

Argument

RESOURCE_NAME

Anger ett valfritt filter som ska användas för typnamnen för identifierade DSC-resurser. Filtret kan innehålla jokertecken (*). Filtret är inte skiftlägeskänsligt.

När det här argumentet anges filtrerar DSC resultatet så att det endast innehåller resurser där resurstypnamnet matchar filtret.

Om du till exempel anger filtret Microsoft.* returnerar endast de resurser som publicerats av Microsoft. Om du anger filtret *Sql* returneras alla resurser med strängen Sql i namnet, oavsett hölje.

Type:      String
Mandatory: false

Alternativ

-a, --adapter

Anger ett filter för att definiera vilka kortresurser som anpassade resurser ska räknas upp för. Som standard anropar kommandot inte kommandot list för nätverkskortresurser. När du anger det här alternativet söker DSC efter kortresurser med typnamn som matchar filtret. Om det identifieras några kort som matchar filtret anropas kommandot list för dessa kort och returnerar de anpassade resurserna. DSC hämtar anpassade resurser innan andra filter för kommandot tillämpas.

Om du anger det här alternativet med filtret *anropar DSC list för varje nätverksresurs som hittas innan de andra filtren används.

Type:      String
Mandatory: false

-d, --description

Anger en sträng som ska matchas i en resurs beskrivning. När det här alternativet har angetts filtrerar DSC resurserna efter beskrivningssträngarna. Filtret är skiftlägeskänsligt och matchar värdet var som helst i beskrivningssträngen. Jokertecken är inte tillåtna.

Type:      String
Mandatory: false

-t, --tags

Anger en resurstagg att filtrera på. När det här alternativet har angetts filtrerar DSC resurserna och inkluderar endast de med en matchande tagg. Filtret är skiftlägeskänsligt. Jokertecken är inte tillåtna.

Du kan ange det här alternativet mer än en gång för att filtrera på en uppsättning taggar. Resultatet omfattar resurser som har minst en av de taggar som angetts med det här alternativet.

Type:      String
Mandatory: false

-f, --format

Alternativet --format styr konsolens utdataformat för kommandot. Om kommandoutdata omdirigeras eller avbildas som en variabel är utdata alltid en serie JSON-rader som representerar varje returnerad resurs. När det här alternativet inte har angetts visar utdata för kommandot en tabell som representerar en sammanfattning av de returnerade resurserna. Mer information finns i Utdata.

Type:         String
Mandatory:    false
DefaultValue: yaml
ValidValues:  [json, pretty-json, yaml]

-h, --help

Visar hjälpen för det aktuella kommandot eller underkommandot. När du anger det här alternativet ignorerar programmet alla alternativ och argument efter det här alternativet.

Type:      Boolean
Mandatory: false

Utdata

Det här kommandot returnerar ett JSON-objekt för varje resurs som innehåller resursens typ, version, manifestinställningar och andra metadata. Mer information finns i dsc-resurslistans resultatschema.

Om kommandots utdata inte samlas in eller omdirigeras visas det som standard i konsolen som en sammanfattningstabell för de returnerade resurserna. Sammanfattningstabellen innehåller följande kolumner som visas i den angivna ordningen:

  • Typ – Resursens fullständigt kvalificerade typnamn.

  • Kind – om resursen är en Adapter, Groupeller en vanlig Resource. Mer information finns i schemareferens för DSC-resurstyp.

  • Version – Den semantiska versionen av resursen.

  • Caps – En visning av resursens funktioner som flaggor. Funktionerna visas i följande ordning med hjälp av en - i stället för lämplig bokstav om resursen inte har någon specifik funktion:

    • g anger att resursen har funktionen Hämta.
    • s anger att resursen har funktionen Set
    • x anger att resursen har funktionen SetHandlesExist
    • w anger att resursen har funktionen WhatIf
    • t anger att resursen har funktionen Test
    • d anger att resursen har funktionen Ta bort
    • e anger att resursen har funktionen Export
    • r anger att resursen har funktionen Lös

    Den Microsoft.Windows/Registry resursen har till exempel följande funktioner: gs--d-, som anger att den har funktionerna Get, Setoch Delete.

  • RequireAdapter – det fullständigt kvalificerade typnamnet för den nätverkskortresurs som DSC använder för att anropa den returnerade resursen.

  • Description – Den korta beskrivningen av resursens syfte och användning.

Om du vill visa utdataobjekten som JSON- eller YAML-objekt i konsolen använder du alternativet --format.