Nota:
El acceso a esta página requiere autorización. Puede intentar iniciar sesión o cambiar directorios.
El acceso a esta página requiere autorización. Puede intentar cambiar los directorios.
Sinopsis
Recupera la lista de recursos de DSC disponibles con un filtro opcional.
Sintaxis
dsc resource list [Options] <RESOURCE_NAME>
Descripción
El list subcomando busca los recursos de DSC disponibles y devuelve su información. DSC detecta los recursos buscando primero en la variable de PATH entorno o DSC_RESOURCE_PATH los .dsc.resource.jsonarchivos , .dsc.resource.ymly dsc.resource.yaml . Para obtener más información sobre las variables de entorno que utiliza DSC, consulte Variables de entorno
Si alguno de los recursos detectados son adaptadores de recursos, DSC llama a la list operación para esos adaptadores si la opción --adapter especifica un filtro coincidente. De forma predeterminada, DSC no devuelve ningún recurso adaptado. Cuando se utiliza la --adapter opción, el comando no devuelve ningún recurso no adaptado.
DSC devuelve la lista de recursos detectados con su información de implementación y metadatos. Si el comando incluye el RESOURCE_NAME argumento, DSC filtra la lista de recursos detectados antes de devolverlos. Las --description opciones y --tags filtran los resultados por las descripciones y etiquetas de los recursos. Los filtros siempre se aplican después de la detección de recursos.
Caché de recursos adaptada
DSC mantiene una caché de los recursos adaptados detectados para la optimización del rendimiento. La ubicación de la caché depende del sistema operativo, como se muestra en la tabla siguiente.
| Sistema operativo | Ruta de acceso de caché |
|---|---|
| Linux | ~/.dsc/AdaptedResourcesLookupTable.json |
| macOS | ~/.dsc/AdaptedResourcesLookupTable.json |
| Windows | %LOCALAPPDATA%\dsc\AdaptedResourcesLookupTable.json |
Ejemplos
Ejemplo 1: Enumeración de todos los recursos no adaptados
Sin ningún filtro, el comando devuelve todos los recursos de DSC detectados, pero no llama a la operación de los recursos del adaptador para enumerar los list recursos adaptados.
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.
Ejemplo 2: Enumeración de un recurso específico
Cuando el RESOURCE_NAME argumento no incluye un carácter comodín, el comando devuelve solo el recurso con el nombre de tipo especificado.
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.
Ejemplo 3: Enumeración de recursos con un nombre de tipo coincidente
Cuando el RESOURCE_NAME argumento incluye un carácter comodín, el comando devuelve todos los recursos con un nombre de tipo coincidente.
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.
Ejemplo 4: Enumeración de recursos con una descripción coincidente
Cuando el comando incluye la opción *--description , los resultados incluyen recursos que tienen una descripción que contiene el valor especificado.
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.
Ejemplo 5: Enumeración de recursos con etiquetas coincidentes
Cuando el comando incluye varias instancias de la --tags opción, los resultados incluyen recursos que tienen alguna de las etiquetas especificadas.
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.
Ejemplo 6: Enumeración de recursos para un adaptador específico
Cuando el comando incluye la --adapter opción, DSC comprueba si hay adaptadores de recursos detectados con un nombre coincidente. Si detecta alguno, llama a la list operación del adaptador y agrega la lista devuelta de recursos adaptados a la lista de recursos detectados. DSC aplica los filtros adicionales especificados con el comando después de esta enumeración.
dsc resource list --adapter Microsoft.Windows/WindowsPowerShell
El siguiente comando especifica el filtro *Windows*de nombre de recurso, limitando la lista de recursos devueltos:
dsc resource list --adapter Microsoft.Windows/WindowsPowerShell *Windows*
Argumentos
RESOURCE_NAME
Especifica un filtro opcional que se va a aplicar a los nombres de tipo de recursos de DSC detectados. El filtro puede incluir comodines (*). El filtro no distingue mayúsculas de minúsculas.
Cuando se especifica este argumento, DSC filtra los resultados para incluir solo los recursos en los que el nombre del tipo de recurso coincide con el filtro.
Por ejemplo, si se especifica el filtro Microsoft.* , solo se devuelven los recursos publicados por Microsoft.
Al especificar el filtro *Sql* , se devuelve cualquier recurso con la cadena Sql en su nombre, independientemente de las mayúsculas y minúsculas.
Type : string
Mandatory : false
Opciones
-a, --adaptador
Especifica un filtro para definir los recursos del adaptador para los que se van a enumerar los recursos adaptados. De forma predeterminada, el comando no llama al comando para los list recursos del adaptador. Al especificar esta opción, DSC busca recursos de adaptador con nombres de tipo que coincidan con el filtro. Si detecta algún adaptador que coincida con el filtro, llama al list comando para esos adaptadores y devuelve los recursos adaptados. DSC recupera recursos adaptados antes de aplicar cualquier otro filtro para el comando.
Cuando se utiliza esta opción, el comando no devuelve ningún recurso no adaptado.
Si especifica esta opción con el filtro *, DSC llama list a todos los recursos de adaptador que encuentra antes de aplicar los demás filtros.
Type : string
Mandatory : false
LongSyntax : --adapter <ADAPTER_NAME>
ShortSyntax : -a <ADAPTER_NAME>
-d, --descripción
Especifica una cadena que debe coincidir en la descripción de un recurso. Cuando se especifica esta opción, DSC filtra los recursos por sus cadenas de descripción. El filtro no distingue mayúsculas de minúsculas y coincide con el valor en cualquier parte de la cadena de descripción. No se permiten caracteres comodín.
Type : string
Mandatory : false
LongSyntax : --description <DESCRIPTION>
ShortSyntax : -d <DESCRIPTION>
-t, --etiquetas
Especifica una etiqueta de recurso en la que filtrar. Cuando se especifica esta opción, DSC filtra los recursos y solo los incluye con una etiqueta coincidente. El filtro no distingue mayúsculas de minúsculas. No se permiten caracteres comodín.
Puede especificar esta opción más de una vez para filtrar por un conjunto de etiquetas. Los resultados incluyen recursos que tienen al menos una de las etiquetas especificadas con esta opción.
Type : string
Mandatory : false
LongSyntax : --tags <TAGS>
ShortSyntax : -t <TAGS>
-o, --formato-de-salida
La --output-format opción controla el formato que DSC utiliza para los datos que devuelve el comando. Los formatos disponibles son:
-
jsonpara emitir los datos como una línea JSON. -
pretty-jsonpara emitir los datos como JSON con saltos de línea, sangría y espacios para facilitar la lectura. -
yamlpara emitir los datos como YAML. -
table-no-truncatepara emitir los datos como una tabla de resumen sin truncar cada línea al ancho de consola actual.
El formato de salida predeterminado depende de si DSC detecta que la salida se está redirigiendo o capturando como una variable:
- Si el comando no se redirige ni se captura, DSC muestra la salida como una tabla de resumen descrita en la sección Salida de este documento.
- Si la salida del comando se redirige o se captura, DSC emite los datos como el
jsonformato a stdout.
Cuando se utiliza esta opción, DSC utiliza el formato especificado independientemente de si el comando se está redirigiendo o capturando.
Cuando el comando no se redirige ni se captura, la salida de la consola se formatea para mejorar la legibilidad. Cuando el comando no se redirige ni se captura, la salida incluye secuencias de terminal para formatear.
Type : string
Mandatory : false
ValidValues : [json, pretty-json, yaml, table-no-truncate]
LongSyntax : --output-format <OUTPUT_FORMAT>
ShortSyntax : -o <OUTPUT_FORMAT>
-h, --ayuda
Muestra la ayuda para el comando o subcomando actual. Cuando se especifica esta opción, la aplicación ignora todas las demás opciones y argumentos.
Type : boolean
Mandatory : false
LongSyntax : --help
ShortSyntax : -h
Salida
Este comando devuelve una matriz con formato que contiene un objeto para cada recurso que incluye el tipo del recurso, la versión, la configuración del manifiesto y otros metadatos. Para obtener más información, consulte Esquema de resultados de la lista de recursos dsc.
Si la salida del comando no se captura o redirige, se muestra en la consola de forma predeterminada como una tabla de resumen para los recursos devueltos. La tabla de resumen incluye las columnas siguientes, que se muestran en el orden indicado:
Tipo : el nombre de tipo completo del recurso.
Tipo : si el recurso es un
adapter,group,importero unResourcearchivo . Para obtener más información, consulte Referencia del esquema de tipo de recurso DSC.Versión : la versión semántica del recurso.
Capacidades : una visualización de las capacidades del recurso como marcas. Las funcionalidades se muestran en el siguiente orden, utilizando una
-letra en lugar de la adecuada si el recurso no tiene una capacidad específica:-
gIndica que el recurso tiene la capacidad get. -
sIndica que el recurso tiene la capacidad establecida -
xindica que el recurso tiene la funcionalidad setHandlesExist -
windica que el recurso tiene la capacidad whatIf -
tIndica que el recurso tiene la capacidad de prueba -
dIndica que el recurso tiene la capacidad de eliminación -
eIndica que el recurso tiene la capacidad de exportación -
rIndica que el recurso tiene la capacidad de resolución
Por ejemplo, el
Microsoft.Windows/Registryrecurso tiene las siguientes capacidades:gs--d-, lo que indica que tiene lasgetcapacidades ,setydelete.-
RequireAdapter : el nombre de tipo completo del recurso de adaptador que DSC usa para invocar el recurso devuelto.
Descripción : la breve descripción del propósito y el uso del recurso.
Para obtener más información sobre el formato de los datos de salida, consulte la opción --output-format.
Colaborar con nosotros en GitHub
El origen de este contenido se puede encontrar en GitHub, donde también puede crear y revisar problemas y solicitudes de incorporación de cambios. Para más información, consulte nuestra guía para colaboradores.
