Nota
O acesso a esta página requer autorização. Podes tentar iniciar sessão ou mudar de diretório.
O acesso a esta página requer autorização. Podes tentar mudar de diretório.
Sinopse
Recupera a lista de recursos DSC disponíveis com um filtro opcional.
Sintaxe
dsc resource list [Options] <RESOURCE_NAME>
Descrição
O list subcomando procura Recursos DSC disponíveis e retorna suas informações. O DSC descobre recursos pesquisando primeiro a variável ou PATH de DSC_RESOURCE_PATH ambiente para .dsc.resource.json, .dsc.resource.ymle dsc.resource.yaml arquivos. Para obter mais informações sobre as variáveis de ambiente usadas pelo DSC, consulte Variáveis de ambiente
Se qualquer um dos recursos descobertos forem adaptadores de recursos, o DSC chamará a list operação para esses adaptadores se a opção --adapter especificar um filtro correspondente. Por padrão, o DSC não retorna nenhum recurso adaptado. Quando você usa a --adapter opção, o comando não retorna nenhum recurso não adaptado.
O DSC retorna a lista de recursos descobertos com suas informações de implementação e metadados. Se o comando incluir o RESOURCE_NAME argumento, o DSC filtrará a lista de recursos descobertos antes de retorná-los. As --description opções e --tags filtram os resultados pelas descrições e tags de recursos. Os filtros são sempre aplicados após a descoberta de recursos.
Cache de recursos adaptado
O DSC mantém um cache de recursos adaptados descobertos para otimização de desempenho. O local do cache depende do sistema operacional, conforme mostrado na tabela a seguir.
| Sistema operativo | Caminho do cache |
|---|---|
| Aplicações Linux | ~/.dsc/AdaptedResourcesLookupTable.json |
| macOS | ~/.dsc/AdaptedResourcesLookupTable.json |
| Mac OS | %LOCALAPPDATA%\dsc\AdaptedResourcesLookupTable.json |
Exemplos
Exemplo 1 - Listar todos os recursos não adaptados
Sem filtros, o comando retorna todos os recursos DSC descobertos, mas não chama a list operação para recursos do adaptador para enumerar quaisquer 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.
Exemplo 2 - Listar um recurso específico
Quando o RESOURCE_NAME argumento não inclui um curinga, o comando retorna apenas o recurso com o nome do 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.
Exemplo 3 - Listar recursos com um nome de tipo correspondente
Quando o RESOURCE_NAME argumento inclui um curinga, o comando retorna todos os recursos com um nome de tipo correspondente.
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.
Exemplo 4 - Listar recursos com uma descrição correspondente
Quando o comando inclui a opção *--description , os resultados incluem recursos que têm uma descrição contendo o 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.
Exemplo 5 - Listar recursos com tags correspondentes
Quando o comando inclui várias instâncias da --tags opção, os resultados incluem recursos que têm qualquer uma das tags 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.
Exemplo 6 - Listar recursos para um adaptador específico
Quando o comando inclui a opção, o --adapter DSC verifica se há adaptadores de recursos descobertos com um nome correspondente. Se ele descobrir algum, ele chamará a list operação para o adaptador e adicionará a lista retornada de recursos adaptados à lista de recursos descobertos. O DSC aplica quaisquer outros filtros especificados com o comando após essa enumeração.
dsc resource list --adapter Microsoft.Windows/WindowsPowerShell
Este próximo comando especifica o filtro *Windows*de nome de recurso, limitando a lista de recursos retornados:
dsc resource list --adapter Microsoft.Windows/WindowsPowerShell *Windows*
Argumentos
RESOURCE_NAME
Especifica um filtro opcional a ser aplicado para os nomes de tipo dos 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.
A especificação do filtro *Sql* retorna qualquer recurso com a cadeia de caracteres Sql em seu nome, independentemente do invólucro.
Type : string
Mandatory : false
Opções
-a, --adaptador
Especifica um filtro para definir para quais recursos do adaptador enumerar recursos adaptados. Por padrão, o comando não chama o comando para recursos do list adaptador. Quando você especifica essa opção, o DSC procura recursos do adaptador com nomes de tipo que correspondam ao filtro. Se ele descobrir quaisquer adaptadores correspondentes ao filtro, ele chamará o list comando para esses adaptadores e retornará os recursos adaptados. O DSC recupera recursos adaptados antes de aplicar quaisquer outros filtros para o comando.
Quando você usa essa opção, o comando não retorna nenhum recurso não adaptado.
Se você especificar essa opção com o filtro *, o DSC chamará list cada recurso do adaptador encontrado antes de aplicar os outros filtros.
Type : string
Mandatory : false
LongSyntax : --adapter <ADAPTER_NAME>
ShortSyntax : -a <ADAPTER_NAME>
-d, --descrição
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
LongSyntax : --description <DESCRIPTION>
ShortSyntax : -d <DESCRIPTION>
-t, --tags
Especifica uma tag de recurso para filtrar. Quando essa opção é especificada, o DSC filtra os recursos e inclui apenas aqueles com uma tag 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 um conjunto de tags. Os resultados incluem recursos que têm pelo menos uma das tags especificadas com essa opção.
Type : string
Mandatory : false
LongSyntax : --tags <TAGS>
ShortSyntax : -t <TAGS>
-o, --formato de saída
A --output-format opção controla qual formato o DSC usa para os dados retornados pelo comando. Os formatos disponíveis são:
-
jsonpara emitir os dados como uma linha JSON. -
pretty-jsonpara emitir os dados como JSON com novas linhas, recuo e espaços para legibilidade. -
yamlpara emitir os dados como YAML. -
table-no-truncatepara emitir os dados como uma tabela de resumo sem truncar cada linha para a largura atual do console.
O formato de saída padrão depende se o DSC deteta que a saída está sendo redirecionada ou capturada como uma variável:
- Se o comando não estiver sendo redirecionado ou capturado, o DSC exibirá a saída como uma tabela de resumo descrita na seção Saída deste documento.
- Se a saída do comando for redirecionada ou capturada, o DSC emitirá os dados como o
jsonformato para stdout.
Quando você usa essa opção, o DSC usa o formato especificado, independentemente de o comando estar sendo redirecionado ou capturado.
Quando o comando não é redirecionado ou capturado, a saída no console é formatada para melhorar a legibilidade. Quando o comando não é redirecionado ou capturado, a saída inclui sequências de terminal para formatação.
Type : string
Mandatory : false
ValidValues : [json, pretty-json, yaml, table-no-truncate]
LongSyntax : --output-format <OUTPUT_FORMAT>
ShortSyntax : -o <OUTPUT_FORMAT>
-h, --ajuda
Exibe a ajuda para o comando ou subcomando atual. Quando você especifica essa opção, o aplicativo ignora todas as outras opções e argumentos.
Type : boolean
Mandatory : false
LongSyntax : --help
ShortSyntax : -h
Realização
Este comando retorna uma matriz formatada contendo um objeto 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:
Type - O nome de tipo totalmente qualificado do recurso.
Tipo - Se o recurso é um
adapter,group,importer, ou típicoResource. Para obter mais informações, consulte DSC Resource kind schema reference.Versão - A versão semântica do recurso.
Capacidades - Uma exibição das capacidades do recurso como sinalizadores. Os recursos são exibidos na seguinte ordem, usando uma
-letra em vez da letra apropriada se o recurso não tiver um recurso específico:-
gindica que o recurso tem a capacidade get. -
sindica que o recurso tem a capacidade definida -
xindica que o recurso tem o recurso setHandlesExist -
windica que o recurso tem a capacidade whatIf -
tindica que o recurso tem a capacidade de teste -
dindica que o recurso tem a capacidade de exclusão -
eindica que o recurso tem a capacidade de exportação -
rindica que o recurso tem a capacidade de resolução
Por exemplo, o
Microsoft.Windows/Registryrecurso tem os seguintes recursos:gs--d-, indicando que tem oget,setedeletecapacidades.-
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 utilização do recurso.
Para obter mais informações sobre a formatação dos dados de saída, consulte a opção --output-format.
Colabore connosco no GitHub
A fonte deste conteúdo pode ser encontrada no GitHub, onde também pode criar e rever issues e pull requests. Para mais informações, consulte o nosso guia para colaboradores.
