Löschen von dsc-Ressourcen

Zusammenfassung

Ruft den Löschvorgang einer Ressource auf.

Syntax

Ohne instance Eigenschaften

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

Instanzeigenschaften aus stdin

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

Instanzeigenschaften aus Eingabeoption

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

Instanzeigenschaften aus der Datei

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

BESCHREIBUNG

Der delete Unterbefehl entfernt eine Ressource instance.

Alle Eigenschaften, die die Ressource benötigt, um zu erkennen, welche instance zu löschen sind, müssen als JSON- oder YAML-Objekt an diesen Befehl übergeben werden. Das Objekt kann von stdin oder mit der --input Option an diesen Befehl übergeben werden. Sie können auch die --path Option verwenden, um das Objekt aus einer JSON- oder YAML-Datei zu lesen.

Dieser Befehl gibt bei erfolgreicher Ausführung keine Ausgabe zurück. Wenn ein Fehler auftritt, wird der Fehler dem Aufrufer auf stderr angezeigt und mit einem Exitcode ungleich 0 beendet.

Beispiele

Beispiel 1: Löschen einer Ressource instance mit Eingabeoption

Wenn eine Ressource einen oder mehrere Eigenschaftswerte benötigt, um den tatsächlichen Zustand des instance zurückzugeben, können die instance Eigenschaften mit der Eingabeoption entweder als JSON oder YAML übergeben werden.

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

Beispiel 2: Löschen von Ressourcen instance mit Eingabe aus stdin

Wenn eine Ressource einen oder mehrere Eigenschaftswerte erfordert, um den tatsächlichen Zustand des instance zurückzugeben, können die instance Eigenschaften entweder als JSON oder YAML über stdin übergeben werden.

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

Beispiel 3: Löschen einer Ressource instance mit Eingaben aus einer YAML-Datei

Wenn eine Ressource einen oder mehrere Eigenschaftswerte benötigt, um den tatsächlichen Zustand des instance zurückzugeben, können die instance Eigenschaften aus einer gespeicherten JSON- oder YAML-Datei abgerufen werden.

cat ./example.delete.yaml

keyPath: HKCU\\DSC\\Example

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

Optionen

-r, --resource

Gibt den vollqualifizierten Typnamen der zu verwendenden DSC-Ressource an, z. B Microsoft.Windows/Registry. .

Die vollqualifizierte Typnamensyntax lautet: <owner>[.<group>][.<area>]/<name>, wobei:

ist owner der autor oder organization für die Ressource.
Und grouparea sind optionale Namenskomponenten, die die Namenserweiterung für eine Ressource ermöglichen.
Gibt name die Von der Ressource verwaltete Komponente an.

Type:      String
Mandatory: true

-i, --input

Gibt ein JSON- oder YAML-Objekt mit den Eigenschaften an, die zum Abrufen einer instance der DSC-Ressource erforderlich sind. DSC überprüft das Objekt anhand des instance Schemas der Ressource. Wenn die Überprüfung fehlschlägt, löst DSC einen Fehler aus.

Diese Option kann nicht mit instance Eigenschaften über stdin oder die --path Option verwendet werden. Wählen Sie aus, ob die instance Eigenschaften über stdin, aus einer Datei mit der --path Option oder mit der Option an den --input Befehl übergeben werden sollen.

DSC ignoriert diese Option, wenn die --all Option angegeben ist.

Type:      String
Mandatory: false

-p, --path

Definiert den Pfad zu einer Textdatei, die als Eingabe für den Befehl gelesen werden soll, anstatt eingaben von stdin oder als Zeichenfolge mit der --input Option zu übergeben. Die angegebene Datei muss JSON oder YAML enthalten, die gültige Eigenschaften für die Ressource darstellt. DSC überprüft das Objekt anhand des instance Schemas der Ressource. Wenn die Überprüfung fehlschlägt oder die angegebene Datei nicht vorhanden ist, löst DSC einen Fehler aus.

Diese Option schließt sich mit der --input Option gegenseitig aus. Wenn Sie diese Option verwenden, ignoriert DSC alle Eingaben von stdin.