dsc 资源列表

2025-07-10

概要

使用可选筛选器检索可用 DSC 资源的列表。

语法

dsc resource list [Options] <RESOURCE_NAME>

描述

该 list 子命令搜索可用的 DSC 资源并返回其信息。 DSC 通过首先在 or PATH 环境变量中DSC_RESOURCE_PATH搜索 .dsc.resource.json 、 .dsc.resource.yml和 dsc.resource.yaml 文件来发现资源。有关 DSC 使用的环境变量的更多信息，请参阅环境变量

如果发现的任何资源是资源适配器，则 list 选项指定匹配的筛选器时调用这些适配器的作。默认情况下，DSC 不会返回任何经过调整的资源。当您使用该 --adapter 选项时，该命令不会返回任何未适应的资源。

DSC 返回发现的资源列表及其实现信息和元数据。如果命令包含参数， RESOURCE_NAME 则 DSC 会在返回已发现资源之前对其进行筛选。和 --description--tags 选项按资源描述和标签筛选结果。筛选器始终在资源发现后应用。

适配的资源缓存

DSC 维护已发现的改编资源的缓存，以实现性能优化。缓存的位置取决于作系统，如下表所示。

操作系统	缓存路径
Linux	`~/.dsc/AdaptedResourcesLookupTable.json`
macOS	`~/.dsc/AdaptedResourcesLookupTable.json`
Windows操作系统	`%LOCALAPPDATA%\dsc\AdaptedResourcesLookupTable.json`

例子

示例 1 - 列出所有未调整的资源

如果没有任何筛选器，该命令将返回每个发现的 DSC 资源，但不会调用 list 适配器资源的作来枚举任何已适应的资源。

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.

示例 2 - 列出特定资源

RESOURCE_NAME当参数不包含通配符时，该命令仅返回具有指定类型名称的资源。

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.

示例 3 - 列出具有匹配类型名称的资源

RESOURCE_NAME当参数包含通配符时，该命令将返回具有匹配类型名称的每个资源。

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.

示例 4 - 列出具有匹配说明的资源

当命令包含 *--description 选项时，结果将包含具有包含指定值的描述的资源。

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.

示例 5 - 列出具有匹配标记的资源

当命令包含选项的 --tags 多个实例时，结果将包含具有任何指定标签的资源。

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.

示例 6 - 列出特定适配器的资源

当命令包含该 --adapter 选项时，DSC 会检查任何已发现的具有匹配名称的资源适配器。如果发现任何内容，则调用 list 适配器的作，并将返回的已适应资源列表添加到已发现的资源列表中。 DSC 将应用在此枚举后使用命令指定的任何进一步筛选器。

dsc resource list --adapter Microsoft.Windows/WindowsPowerShell

下一个命令指定 resource name filter *Windows*，限制返回的资源列表：

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

参数

RESOURCE_NAME

指定要应用于发现的 DSC 资源的类型名称的可选筛选器。筛选器可以包含通配符（*）。筛选器不区分大小写。

指定此参数后，DSC 会筛选结果，以仅包含资源类型名称与筛选器匹配的资源。

例如，指定筛选条件 Microsoft.* 将仅返回 Microsoft 发布的资源。指定筛选条件 *Sql* 将返回名称中包含字符串 Sql 的任何资源，而不管大小写如何。

Type      : string
Mandatory : false

选项

-a、--adapter

指定一个筛选器，用于定义要枚举其改编资源的适配器资源。默认情况下，该命令不会为适配器资源调用 list 命令。指定此选项时，DSC 会查找与筛选器匹配的类型名称的适配器资源。如果发现任何与过滤器匹配的适配器，它会调用这些适配器的 list 命令并返回适应的资源。 DSC 在为命令应用任何其他筛选器之前检索已调整的资源。

使用此选项时，该命令不会返回任何未适应的资源。

如果使用 filter *指定此选项，DSC 会在应用其他过滤器之前调用 list 它找到的每个适配器资源。

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

-d、--description

指定要在资源说明中匹配的字符串。指定此选项后，DSC 会按其说明字符串筛选资源。筛选器不区分大小写，与说明字符串中的任何位置的值匹配。不允许通配符。

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

-t、--tags

指定要筛选的资源标记。指定此选项后，DSC 会筛选资源，并且仅包含具有匹配标记的资源。筛选器不区分大小写。不允许通配符。

可以多次指定此选项来筛选一组标记。结果包括至少具有使用此选项指定的标记之一的资源。

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

-o， --output-format

该 --output-format 选项控制 DSC 对命令返回的数据使用的格式。可用格式包括：

json 以 JSON 行的形式发出数据。
pretty-json 将数据作为 JSON 发出，并带有换行符、缩进和空格以提高可读性。
yaml 以 YAML 格式发送数据。
table-no-truncate 将数据作为摘要表发出，而不将每行截断为当前控制台宽度。

默认输出格式取决于 DSC 是否检测到输出正在重定向或作为变量捕获：

如果未重定向或捕获命令，DSC 会将输出显示为本文档的 “输出 ” 部分中描述的摘要表。
如果命令输出被重定向或捕获，DSC 会将数据作为 json 格式发送到 stdout。

使用此选项时，DSC 将使用指定的格式，而不管命令是重定向还是捕获。

当命令未重定向或捕获时，控制台中的输出将被格式化以提高可读性。当命令未重定向或捕获时，输出包括用于格式化的终端序列。

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

-h、--help

显示当前命令或子命令的帮助。指定此选项时，应用程序将忽略所有其他选项和参数。

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

输出

此命令返回一个格式化数组，其中包含每个资源的对象，其中包括资源的类型、版本、清单设置和其他元数据。有关更多信息，请参阅 dsc resource list 结果架构。

如果未捕获或重定向命令的输出，则默认在控制台中显示为返回资源的摘要表。摘要表包括以列出的顺序显示的下列列：

Type - 资源的完全限定类型名称。
种类 - 资源是、 adaptergroup、 importer还是典型 Resource。有关更多信息，请参阅 DSC 资源类型架构参考。
Version （版本 ） - 资源的语义版本。
Capabilities （功能 ） - 以标志形式显示资源的功能。这些功能按以下顺序显示，如果资源没有特定功能，则使用 a - 而不是相应的字母：
- g 表示资源具有 GET 能力。
- s 表示资源具有 set 能力
- x 表示资源具有 setHandlesExist 能力
- w 表示资源具有 whatIf 能力
- t 表示资源具有 test 能力
- d 表示资源具有 Delete 能力
- e 表示资源具有 export 能力
- r 表示资源具有 resolve 能力
例如，资源 Microsoft.Windows/Registry 具有以下功能： gs--d-，表示它具有 get、 set和 delete 功能。
RequireAdapter - DSC 用于调用返回资源的适配器资源的完全限定类型名称。
描述 - 资源的用途和用途的简短描述。

有关输出数据格式的更多信息，请参阅 --output-format 选项。

反馈

此页面是否有帮助？