ta bort dsc-resurs

Artikel
05/11/2024

Synopsis

Anropar borttagningsåtgärden för en resurs.

Syntax

Utan instansegenskaper

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

Instansegenskaper från stdin

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

Instansegenskaper från indataalternativet

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

Instansegenskaper från fil

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

Description

Underkommandot delete tar bort en resursinstans.

Alla egenskaper som resursen kräver för att kunna urskilja vilken instans som ska tas bort måste skickas till det här kommandot som ett JSON- eller YAML-objekt. Objektet kan skickas till det här kommandot från stdin eller med --input alternativet . Du kan också använda --path alternativet för att läsa objektet från en JSON- eller YAML-fil.

Det här kommandot returnerar inga utdata när det lyckas. Om ett fel uppstår visas felet för anroparen på stderr och avslutas med en slutkod som inte är noll.

Exempel

Exempel 1 – Ta bort resursinstans med indataalternativ

Om en resurs kräver ett eller flera egenskapsvärden för att returnera det faktiska tillståndet för instansen kan instansegenskaperna skickas med indataalternativet som antingen JSON eller YAML.

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

Exempel 2 – Ta bort resursinstans med indata från stdin

Om en resurs kräver ett eller flera egenskapsvärden för att returnera det faktiska tillståndet för instansen kan instansegenskaperna skickas över stdin som antingen JSON eller YAML.

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

Exempel 3 – Ta bort resursinstans med indata från en YAML-fil

Om en resurs kräver ett eller flera egenskapsvärden för att returnera det faktiska tillståndet för instansen kan instansegenskaperna hämtas från en sparad JSON- eller YAML-fil.

cat ./example.delete.yaml

keyPath: HKCU\\DSC\\Example

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

Alternativ

-r, --resource

Anger det fullständigt kvalificerade typnamnet för den DSC-resurs som ska användas, till exempel Microsoft.Windows/Registry.

Den fullständigt kvalificerade typnamnsyntaxen är: <owner>[.<group>][.<area>]/<name>, där:

owner är den underhållna författaren eller organisationen för resursen.
group och area är valfria namnkomponenter som möjliggör namnavstånd för en resurs.
name Identifierar komponenten som resursen hanterar.

Type:      String
Mandatory: true

-i, --input

Anger ett JSON- eller YAML-objekt med de egenskaper som behövs för att hämta en instans av DSC-resursen. DSC validerar objektet mot resursens instansschema. Om verifieringen misslyckas genererar DSC ett fel.

Det här alternativet kan inte användas med instansegenskaper över stdin eller alternativet --path . Välj om du vill skicka instansegenskaperna till kommandot över stdin, från en fil med --path alternativet eller med --input alternativet .

DSC ignorerar det här alternativet när alternativet --all anges.

Type:      String
Mandatory: false

-p, --path

Definierar sökvägen till en textfil som ska läsas som indata för kommandot i stället för att skicka indata från stdin eller skicka den som en sträng med --input alternativet . Den angivna filen måste innehålla JSON eller YAML som representerar giltiga egenskaper för resursen. DSC validerar objektet mot resursens instansschema. Om verifieringen misslyckas, eller om den angivna filen inte finns, genererar DSC ett fel.

Det här alternativet utesluter ömsesidigt med --input alternativet . När du använder det här alternativet ignorerar DSC alla indata från stdin.