Compartilhar via

Referência de esquema de resultado da lista de recursos dsc

  • Artigo

Sinopse

A saída do resultado do comando dsc resource list.

Metadados

SchemaDialect: https://json-schema.org/draft/2020-12/schema
SchemaID:      https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/outputs/resource/list.json
Type:          object

Descrição

A saída do comando inclui uma representação de recursos DSC descobertos como uma série delinhas JSON . Esse esquema descreve o objeto JSON retornado para cada recurso.

Propriedades necessárias

Cada recurso na saída sempre inclui estas propriedades:

Propriedades

tipo

Identifica o nome de tipo totalmente qualificado do recurso. Ele é usado para especificar o recurso em documentos de configuração e como o valor do sinalizador --resource ao usar os comandos dsc resource *. Para obter mais informações sobre nomes de tipo de recurso, consulte referência de esquema de nome de tipo totalmente qualificado do Recurso DSC.

Type:     string
Required: true
Pattern:  ^\w+(\.\w+){0,2}\/\w+$

tipo

Identifica se um recurso é um de recursos do adaptador, um recurso de grupo ou nenhum deles. Esse valor é definido no manifesto do recurso ou inferido pelo DSC. Para obter mais informações sobre tipos de recursos, consulte referência de esquema de tipo de recurso DSC.

Type:          string
Required:      true
ValidValues:  [Resource, Adapter, Group]

Versão

Representa a versão atual do recurso como uma cadeia de caracteres semântica (semver) válida. A versão se aplica ao recurso, não ao software que ele gerencia.

Type:     string
Required: true
Pattern:  ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$

Capacidades

Define as operações e comportamentos que o recurso é implementado para dar suporte. Essa propriedade é uma matriz de recursos. Os recursos sempre têm a funcionalidade Get, mas os outros recursos são opcionais e dependem do recurso.

A lista a seguir descreve os recursos disponíveis para um recurso:

  • Get - O recurso dá suporte à recuperação do estado atual de uma instância. Todos os recursos de DSC devem ter essa funcionalidade. Um recurso tem essa funcionalidade quando define o obrigatório obter propriedade em seu manifesto de recurso.

  • Set - O recurso dá suporte à imposição do estado desejado de uma instância. Um recurso tem essa funcionalidade quando define o definir propriedade em seu manifesto de recurso. Recursos sem essa funcionalidade não podem ser usados com o conjunto de recursos dsc ou conjunto de configurações dsc comandos, a menos que estejam em um grupo Microsoft.DSC/Assertion como uma instância aninhada.

  • SetHandlesExist - O recurso dá suporte diretamente à propriedade _exist. Um recurso tem essa funcionalidade quando define a propriedade handlesExist como true na definição da propriedade de comando definida em seu manifesto de recurso.

    Quando um recurso tem essa funcionalidade, a propriedade _exist faz parte do esquema de instância do recurso e o recurso manipula a exclusão de instâncias do recurso em seu comando set.

    Quando um recurso não tem essa funcionalidade, quando o DSC localiza uma instância do recurso com _exist definido como false, ele lida com a chamada da excluir operação para o recurso.

    Se o recurso não tiver essa funcionalidade ou a funcionalidade Delete, o DSC gerará um erro quando uma instância definir _exist como false.

  • WhatIf - O recurso dá suporte ao retorno de informações explícitas sobre como ele modificará o estado quando um usuário chamar conjunto de configurações dsc com a opção --what-if. Um recurso tem essa funcionalidade quando define o método What-if em seu manifesto de recurso.

    Quando um recurso tem essa funcionalidade, o DSC chama o comando definido com seus argumentos quando um usuário executa o comando dsc config set com a opção --what-if.

    Quando um recurso não tem essa funcionalidade, o DSC sintetiza como o recurso será alterado e a instância convertendo o resultado do Test para a instância em um resultado Set. A operação sintética não pode indicar possíveis problemas ou alterações que não podem ser determinadas comparando o resultado da operação de Test com o estado desejado do recurso. Por exemplo, as credenciais usadas para testar um recurso podem ser válidas para essa operação, mas não têm permissões para modificar o estado do sistema. Somente um recurso com essa funcionalidade pode relatar completamente se e como o recurso mudará o estado do sistema.

  • Test - O recurso dá suporte à validação do estado desejado de uma instância em relação ao estado atual da instância. Um recurso tem essa funcionalidade quando define a propriedade test no manifesto do recurso.

    Se um recurso não tiver a funcionalidade Test, o DSC usará um teste sintético para instâncias do recurso. O teste sintético compara cada propriedade para o estado desejado de uma instância em relação ao estado real. O teste sintético usa equivalência estrita e sensível a maiúsculas de minúsculas. Se o estado desejado para uma propriedade e o estado real não forem os mesmos, o DSC marcará a propriedade como fora do estado desejado.

  • Delete - O recurso dá suporte à remoção de uma instância. Um recurso tem essa funcionalidade quando define o excluir propriedade em seu manifesto de recurso. Essa funcionalidade não é mutuamente exclusiva com a propriedade SetHandlesExist. Um recurso pode lidar com a propriedade _exist em operações definidas e ser chamado diretamente com de exclusão de recurso dsc para remover uma instância.

  • Export - O recurso dá suporte à enumeração de todas as instâncias do recurso. Um recurso tem essa funcionalidade quando define a propriedade export em seu manifesto de recurso. Somente recursos com essa funcionalidade são utilizáveis com os comandos de exportação de recursos dsc e comandos de exportação de configuração dsc.

  • Resolve - O recurso dá suporte à resolução de instâncias de recursos aninhadas de uma fonte externa. Um recurso tem essa funcionalidade quando define o resolver propriedade em seu manifesto de recurso. Essa funcionalidade é usada principalmente por recursos do importador.

Type:              array
Required:          true
ItemsMustBeUnique: true
ItemsType:         string
ItemsValidValues: [Get, Set, SetHandlesExist, Test, Delete, Export]

descrição

Define uma sinopse para a finalidade do recurso como uma cadeia de caracteres curta. Se o recurso não tiver uma descrição, essa propriedade será null.

Type:     [string, 'null']
Required: true

caminho

Representa o caminho para o manifesto do recurso no computador. Para recursos adaptados, essa propriedade identifica o caminho para o arquivo que define o recurso.

Type:     string
Required: true

diretório

Representa o caminho para a pasta que contém o manifesto do recurso no computador. Para recursos adaptados, essa propriedade identifica o caminho para a pasta que contém o arquivo que define o recurso.

Type:     string
Required: true

implementedAs

Indica como o recurso DSC foi implementado. Para recursos baseados em comando, esse valor é sempre Command.

autor

Indica o nome da pessoa ou organização que desenvolveu e mantém o Recurso DSC. Se essa propriedade for null, o autor será desconhecido.

Type:     [string, 'null']
Required: true

Propriedades

Define os nomes de propriedade para recursos adaptados. Para recursos não adaptados, essa propriedade é uma matriz vazia.

Type:         array
Required:     true
ItemsType:    string
ItemsPattern: ^\w+$

requireAdapter

Define o nome de tipo totalmente qualificado do Adaptador de Recursos DSC pelo qual esse recurso é disponibilizado. Esse valor é definido apenas para recursos adaptados. Para recursos não adaptados, esse valor é sempre null.

Type:     [string, 'null']
Required: true

manifesto

Representa os valores definidos no manifesto do recurso. Esse valor é null para recursos que não são baseados em comando. Para obter mais informações sobre o valor dessa propriedade, consulte referência de esquema de manifesto do recurso DSC baseado em comando.

Type:     [object, 'null']
Required: true