exclusão de recursos dsc

Artigo
05/11/2024

Sinopse

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

Syntax

Sem propriedades de instância

dsc resource delete [Options] --resource <RESOURCE>

Propriedades da instância do stdin

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

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

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

Propriedades da instância do arquivo

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

Descrição

O delete subcomando remove uma instância de recurso.

Todas as propriedades que o recurso requer para discernir qual instância excluir deve ser passada para esse comando como um objeto JSON ou YAML. O objeto pode ser passado para esse comando de stdin ou com a opção --input . Você também pode usar a opção --path para ler o objeto de um arquivo JSON ou YAML.

Esse comando não retorna nenhuma saída quando bem-sucedido. Se encontrar um erro, ele mostrará o erro para o chamador no stderr e sairá com um código de saída diferente de zero.

Exemplos

Exemplo 1 – excluir instância de recurso com a opção de entrada

Se um recurso exigir um ou mais valores de propriedade para retornar o estado real da instância, as propriedades da instância poderão ser passadas com a opção de entrada como JSON ou YAML.

dsc resource delete --resource Microsoft.Windows/Registry --input '{
    "keyPath": "HKCU\\DSC\\Example"
}'

Exemplo 2 – excluir instância de recurso com entrada de stdin

Se um recurso exigir um ou mais valores de propriedade para retornar o estado real da instância, as propriedades da instância poderão ser passadas por stdin como JSON ou YAML.

'{
    "keyPath": "HKCU\\DSC\\Example"
}' | dsc resource delete --resource Microsoft.Windows/Registry

Exemplo 3 – excluir instância de recurso com entrada de um arquivo YAML

Se um recurso exigir um ou mais valores de propriedade para retornar o estado real da instância, as propriedades da instância poderão ser recuperadas de um arquivo JSON ou YAML salvo.

cat ./example.delete.yaml

keyPath: HKCU\\DSC\\Example

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

Opções

-r, --resource

Especifica o nome de tipo totalmente qualificado do recurso DSC a ser usado, como Microsoft.Windows/Registry.

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

O owner é o autor ou organização que mantém o recurso.
Os group e area são componentes de nome opcionais que habilitam o espaçamento de nomes para um recurso.
O name identifica o componente que o recurso gerencia.

Type:      String
Mandatory: true

-i, --input

Especifica um objeto JSON ou YAML com as propriedades necessárias para recuperar uma instância do recurso DSC. O DSC valida o objeto em relação ao esquema de instância do recurso. Se a validação falhar, o DSC gerará um erro.

Essa opção não pode ser usada com propriedades de instância sobre stdin ou a opção --path . Escolha se deseja passar as propriedades da instância para o comando sobre stdin, de um arquivo com a opção --path ou com a opção --input .

O DSC ignora essa opção quando a opção --all é especificada.

Type:      String
Mandatory: false

-p, --path

Define o caminho para um arquivo de texto a ser lido como entrada para o comando em vez de canalizar a entrada de stdin ou passá-la como uma cadeia de caracteres com a opção --input . O arquivo especificado deve 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 arquivo especificado não existir, o DSC gerará um erro.

Essa opção é mutuamente exclusiva com a opção --input . Quando você usa essa opção, o DSC ignora qualquer entrada de stdin.