teste de recursos dsc

Sinopse

Invoca a operação de teste de um recurso.

Syntax

Propriedades da instância do stdin

<instance-properties> | dsc resource set [Options] --resource <RESOURCE>

Propriedades da instância da opção de entrada

dsc resource set --input '<instance-properties>' --resource <RESOURCE>

Propriedades da instância do ficheiro

dsc resource set --path <instance-properties-filepath> --resource <RESOURCE>

Description

O test subcomando valida o estado real de uma instância de recurso relativamente a um estado pretendido.

Este subcomando testa uma instância de um Recurso DSC específico. Para testar vários recursos, utilize um grupo de recursos ou o comando de teste de configuração dsc .

O estado pretendido da instância a testar tem de ser transmitido para este comando como um objeto JSON ou YAML. As propriedades do objeto têm de ser propriedades válidas para o recurso. As propriedades da instância podem ser transmitidas para este comando a partir de stdin, como uma cadeia com a opção --input ou a partir de um ficheiro guardado com a opção --path .

Se este comando for invocado para um Recurso DSC baseado em comandos que não defina a sua própria operação de teste, o DSC efetua um teste sintético. O teste sintético compara cada propriedade para o estado pretendido de uma instância com o estado real. O teste sintético utiliza equivalência estrita e sensível às maiúsculas e minúsculas. Se o estado pretendido para uma propriedade e o estado real não forem os mesmos, o DSC marca a propriedade como fora do estado pretendido.

Este comando valida apenas as propriedades da instância em duas condições:

1. Quando a propriedade é explicitamente incluída na entrada de estado pretendida.
2. Quando a propriedade tem um valor predefinido e não está explicitamente incluída na entrada de estado pretendida.

Exemplos

Exemplo 1 – Testar um recurso com propriedades de stdin

O comando testa se a Example chave existe no hive do utilizador atual. Especifica as propriedades da instância de recurso como JSON e transmite-as a partir de stdin.

'{
    "keyPath": "HKCU\\Example",
    "_exist": true
}' | dsc resource test --resource Microsoft.Windows/Registry

Exemplo 2 - Testar um recurso com a opção de entrada

O comando testa se a Example chave existe no hive do utilizador atual. Especifica as propriedades da instância de recurso como JSON e transmite-as com a opção de entrada .

dsc resource test --resource Microsoft.Windows/Registry --input '{
    "keyPath": "HKCU\\Example",
    "_exist": true
}'

Exemplo 3 – Testar um recurso com propriedades de um ficheiro YAML

O comando testa se a Example chave existe no hive do utilizador atual. Especifica o caminho para um ficheiro YAML que define as propriedades da instância de recurso com a opção caminho .

keyPath: HKCU\\Example
_exist:  true

dsc resource test --resource Microsoft.Windows/Registry --path ./example.yaml

Opções

-r, --resource

Especifica o nome do tipo completamente qualificado do Recurso do DSC a utilizar, como Microsoft.Windows/Registry.

A sintaxe do nome do tipo completamente qualificado é: <owner>[.<group>][.<area>]/<name>, em que:

• É owner o autor ou organização de manutenção do recurso.
• Os group e area são componentes de nomes opcionais que permitem o espaçamento de nomes para um recurso.
• O name identifica o componente que o recurso gere.

Type:      String
Mandatory: true

-i, --input

Especifica um objeto JSON ou YAML com as propriedades que definem o estado pretendido de uma instância de Recurso do DSC. O DSC valida o objeto em relação ao esquema de instância do recurso. Se a validação falhar, o DSC gera um erro.

Esta opção não pode ser utilizada com as propriedades da instância através de stdin ou da opção --path . Escolha se quer transmitir as propriedades da instância para o comando por stdin, a partir de um ficheiro com a opção --path ou com a opção --input .

Type:      String
Mandatory: false

-p, --path

Define o caminho para um ficheiro de texto para ler como entrada para o comando em vez de encaminhar a entrada de stdin ou transmiti-lo como uma cadeia com a opção --input . O ficheiro especificado tem de conter JSON ou YAML que represente propriedades válidas para o recurso. O DSC valida o objeto em relação ao esquema de instância do recurso. Se a validação falhar ou se o ficheiro especificado não existir, o DSC gera um erro.

Esta opção é mutuamente exclusiva com a opção --input . Quando utiliza esta opção, o DSC ignora qualquer entrada de stdin.

Type:      String
Mandatory: false

-f, --format

A --format opção controla o formato de saída da consola do comando. Se a saída do comando for redirecionada ou capturada como uma variável, o resultado será sempre JSON.

Type:         String
Mandatory:    false
DefaultValue: yaml
ValidValues:  [json, pretty-json, yaml]

-h, --help

Apresenta a ajuda para o comando ou subcomando atual. Quando especifica esta opção, a aplicação ignora todas as opções e argumentos após esta.

Type:      Boolean
Mandatory: false

Saída

Este comando devolve a saída JSON que inclui o estado pretendido da instância, o estado real, a lista de propriedades que estão fora do estado pretendido e um valor booleano que indica se a instância está no estado pretendido. Para obter mais informações, veja dsc resource test result result schema (Esquema de resultados do teste de recursos dsc).