lista de recursos do dsc
Sinopse
Retorna a lista de recursos DSC disponíveis com um filtro opcional.
Sintaxe
dsc resource list [Options] <RESOURCE_NAME>
Descrição
O list subcomando pesquisa recursos DSC disponíveis e retorna suas informações. O DSC descobre os recursos pesquisando primeiro a variável de ambiente PATH ou DSC_RESOURCE_PATH para arquivos .dsc.resource.json, .dsc.resource.ymle dsc.resource.yaml. Para obter mais informações sobre as variáveis de ambiente usadas pelo DSC, consulte Variáveis de ambiente
Se algum dos recursos descobertos for adaptadores de recursos, o DSC chamará a operação de list para esses adaptadores se a opção --adapter especificar um filtro correspondente. Por padrão, o DSC não retorna nenhum recurso adaptado.
O DSC retorna a lista de recursos descobertos com suas informações de implementação e metadados. Se o comando incluir o argumento RESOURCE_NAME, o DSC filtrará a lista de recursos descobertos antes de retorná-los. A descrição e marcas opções filtram os resultados pelas descrições e marcas do recurso. Os filtros são sempre aplicados após a descoberta de recursos.
Exemplos
Exemplo 1 – Listar todos os recursos não adaptados
Sem filtros, o comando retorna todos os recursos de DSC descobertos, mas não chama a operação list para os recursos do adaptador enumerar os recursos adaptados.
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----
Exemplo 2 - Listar um recurso específico
Quando o argumento RESOURCE_NAME não inclui um curinga, o comando retorna apenas o recurso com o nome de tipo especificado.
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.
Exemplo 3 – Listar recursos com um nome de tipo correspondente
Quando o argumento RESOURCE_NAME inclui um curinga, o comando retorna todos os recursos com um nome de tipo correspondente.
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.
Exemplo 4 – Listar recursos com uma descrição correspondente
Quando o comando inclui a descrição opção, os resultados incluem recursos que têm uma descrição contendo o valor especificado.
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.
Exemplo 5 – Listar recursos com marcas correspondentes
Quando o comando inclui várias instâncias da opção marcas, os resultados incluem recursos que têm qualquer uma das marcas especificadas.
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.
Exemplo 6 – Listar recursos para um adaptador específico
Quando o comando inclui a opção do adaptador list para o adaptador e adicionará a lista retornada de recursos adaptados à lista de recursos descobertos. O DSC aplica todos os filtros adicionais especificados com o comando após essa enumeração.
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.
Este próximo comando especifica o filtro de nome do recurso *Windows*, limitando a lista de recursos retornados:
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.
Argumentos
RESOURCE_NAME
Especifica um filtro opcional a ser aplicado aos nomes de tipo de recursos DSC descobertos. O filtro pode incluir curingas (*). O filtro não diferencia maiúsculas de minúsculas.
Quando esse argumento é especificado, o DSC filtra os resultados para incluir apenas recursos em que o nome do tipo de recurso corresponde ao filtro.
Por exemplo, especificar o filtro Microsoft.* retorna apenas os recursos publicados pela Microsoft.
Especificar o filtro *Sql* retorna qualquer recurso com a cadeia de caracteres Sql em seu nome, independentemente da caixa.
Type: String
Mandatory: false
Opções
-a, --adapter
Especifica um filtro para o qual definir os recursos do adaptador para os quais enumerar recursos adaptados. Por padrão, o comando não chama o comando list para recursos do adaptador. Quando você especifica essa opção, o DSC procura recursos do adaptador com nomes de tipo que correspondem ao filtro. Se descobrir qualquer adaptador que corresponda ao filtro, ele chamará o comando list para esses adaptadores e retornará os recursos adaptados. O DSC recupera recursos adaptados antes de aplicar outros filtros para o comando.
Se você especificar essa opção com o filtro *, o DSC chamará list para cada recurso do adaptador encontrado antes de aplicar os outros filtros.
Type: String
Mandatory: false
-d, --description
Especifica uma cadeia de caracteres a ser correspondida na descrição de um recurso. Quando essa opção é especificada, o DSC filtra os recursos por suas cadeias de caracteres de descrição. O filtro não diferencia maiúsculas de minúsculas e corresponde ao valor em qualquer lugar na cadeia de caracteres de descrição. Curingas não são permitidos.
Type: String
Mandatory: false
-t, --tags
Especifica uma marca de recurso na qual filtrar. Quando essa opção é especificada, o DSC filtra os recursos e inclui apenas aqueles com uma marca correspondente. O filtro não diferencia maiúsculas de minúsculas. Curingas não são permitidos.
Você pode especificar essa opção mais de uma vez para filtrar em um conjunto de marcas. Os resultados incluem recursos que têm pelo menos uma das marcas especificadas com essa opção.
Type: String
Mandatory: false
-f, --format
A opção --format controla o formato de saída do console para o comando. Se a saída do comando for redirecionada ou capturada como uma variável, a saída será sempre uma série de linhas JSON que representam cada recurso retornado. Quando essa opção não é especificada, a saída para o comando mostra uma tabela que representa um resumo dos recursos retornados. Para obter mais informações, consulte Saída.
Type: String
Mandatory: false
DefaultValue: yaml
ValidValues: [json, pretty-json, yaml]
-h, --help
Exibe a ajuda para o comando ou subcomando atual. Quando você especifica essa opção, o aplicativo ignora todas as opções e argumentos após esta.
Type: Boolean
Mandatory: false
Saída
Esse comando retorna um objeto JSON para cada recurso que inclui o tipo, a versão, as configurações de manifesto e outros metadados do recurso. Para obter mais informações, consulte esquema de resultados da lista de recursos dsc.
Se a saída do comando não for capturada ou redirecionada, ela será exibida no console por padrão como uma tabela de resumo para os recursos retornados. A tabela de resumo inclui as seguintes colunas, exibidas na ordem listada:
Tipo – o nome de tipo totalmente qualificado do recurso.
Tipo – se o recurso é um
Adapter,GroupouResourcetípico. Para obter mais informações, consulte referência de esquema de tipo de recurso DSC.versão – a versão semântica do recurso.
Caps – Uma exibição dos recursos de do recurso como sinalizadores. Os recursos são exibidos na seguinte ordem, usando uma
-em vez da letra apropriada se o recurso não tiver uma funcionalidade específica:indica que o recurso tem ade recursos get do . sindica que o recurso tem a funcionalidade Setxindica que o recurso tem a funcionalidade SetHandlesExistwindica que o recurso tem a funcionalidade whatIftindica que o recurso tem a funcionalidade de teste dedindica que o recurso tem o recurso de exclusão deeindica que o recurso tem o recurso de exportação derindica que o recurso tem a funcionalidade resolver
Por exemplo, o recurso
Microsoft.Windows/Registrytem os seguintes recursos:gs--d-, indicando que ele tem os recursosGet,SeteDelete.RequireAdapter – o nome de tipo totalmente qualificado do recurso do adaptador que o DSC usa para invocar o recurso retornado.
Descrição – a breve descrição da finalidade e do uso do recurso.
Para exibir os objetos de saída como objetos JSON ou YAML no console, use a opção --format.
