Partilhar via

conjunto de recursos dsc

Sinopse

Invoca a operação de conjunto 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 set subcomando impõe o estado pretendido de uma instância de recurso e devolve o estado final.

Este subcomando define uma instância de um Recurso DSC específico. Para definir vários recursos, utilize um grupo de recursos ou o comando dsc config set .

O estado pretendido da instância a definir 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 .

Este subcomando só pode ser invocado para Recursos DSC baseados em comandos que definem a set secção do respetivo manifesto de recursos. Se este subcomando for chamado para um recurso que não defina uma operação definida, o DSC gera um erro.

Importante

O dsc resource set comando invoca sempre a set operação para o recurso. Os recursos podem, mas não são necessários, implementar lógica que pré-teste uma instância para a set operação.

Isto é diferente de como funciona o conjunto de configuração dsc , em que o DSC testa sempre uma instância, seja sinteticamente ou invocando a test operação para o recurso, e invoca apenas set para uma instância se não estiver no estado pretendido.

Os recursos baseados em comandos indicam se implementam o pré-teste para a set operação ao definir a propriedade set.implementsPretest no respetivo manifesto de recursos. Se essa propriedade for definida como true, indica que o recurso implementa o pré-teste. Se set.implementsPretest estiver definido como false ou estiver indefinido, o manifesto indica que o recurso não implementa o pré-teste.

Se um recurso indicar que implementa o pré-teste, os utilizadores deverão esperar que o recurso modifique apenas uma instância durante uma set operação se o pré-teste mostrar que a instância não está no estado pretendido.

Se um recurso não implementar o pré-teste, os utilizadores deverão esperar que o recurso modifique sempre uma instância durante uma set operação.

Para recursos que não implementam o pré-teste da operação, a set Microsoft recomenda que chame dsc resource test sempre uma instância para ver se está no estado pretendido antes de invocar dsc resource set. Isto pode ajudar a evitar erros acidentais causados por recursos que não implementam um comando totalmente idempotente set .

Exemplos

Exemplo 1 - Definir um recurso com propriedades de stdin

O comando garante que 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 set --resource Microsoft.Windows/Registry

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

O comando garante que 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 set --resource Microsoft.Windows/Registry --input '{
    "keyPath": "HKCU\\Example",
    "_exist": true
}'

Exemplo 3 - Definir um recurso com propriedades de um ficheiro YAML

O comando garante que 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 .

cat ./example.yaml

keyPath: HKCU\\Example
_exist:  true

dsc resource set --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 real da instância antes e depois da operação do conjunto e a lista de propriedades que a operação do conjunto modificou. Para obter mais informações, veja dsc resource set result schema (Esquema de resultados do conjunto de recursos dsc).

  • Last updated on