Usuwanie zasobów dsc

Streszczenie

Wywołuje operację usuwania zasobu.

Składnia

Bez właściwości wystąpienia

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

Właściwości wystąpienia z narzędzia stdin

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

Właściwości wystąpienia z opcji wejściowej

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

Właściwości wystąpienia z pliku

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

Opis

Podpolecenia delete usuwa wystąpienie zasobu.

Wszelkie właściwości wymagane przez zasób do rozpoznawania, które wystąpienie do usunięcia musi zostać przekazane do tego polecenia jako obiekt JSON lub YAML. Obiekt można przekazać do tego polecenia z narzędzia stdin lub z opcją --input . Możesz również użyć --path opcji odczytu obiektu z pliku JSON lub YAML.

To polecenie nie zwraca żadnych danych wyjściowych po pomyślnym zakończeniu. Jeśli wystąpi błąd, powoduje wyświetlenie błędu wywołującego w stderr i kończy działanie z kodem zakończenia bez zera.

Przykłady

Przykład 1 — usuwanie wystąpienia zasobu z opcją wprowadzania

Jeśli zasób wymaga co najmniej jednej wartości właściwości, aby zwrócić rzeczywisty stan wystąpienia, właściwości wystąpienia można przekazać z opcją wprowadzania jako kod JSON lub YAML.

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

Przykład 2 — usuwanie wystąpienia zasobu z danymi wejściowymi z narzędzia stdin

Jeśli zasób wymaga co najmniej jednej wartości właściwości, aby zwrócić rzeczywisty stan wystąpienia, właściwości wystąpienia można przekazać za pomocą stdin jako JSON lub YAML.

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

Przykład 3 — usuwanie wystąpienia zasobu z danymi wejściowymi z pliku YAML

Jeśli zasób wymaga co najmniej jednej wartości właściwości, aby zwrócić rzeczywisty stan wystąpienia, właściwości wystąpienia można pobrać z zapisanego pliku JSON lub YAML.

cat ./example.delete.yaml

keyPath: HKCU\\DSC\\Example

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

Opcje

-r, --resource

Określa w pełni kwalifikowaną nazwę typu zasobu DSC do użycia, na przykład Microsoft.Windows/Registry.

W pełni kwalifikowana składnia nazwy typu to: , gdzie: <owner>[.<group>][.<area>]/<name>

Jest owner to utrzymanie autora lub organizacji dla zasobu.
Składniki group i area są opcjonalnymi składnikami nazw, które umożliwiają określanie nazw dla zasobu.
Element name identyfikuje składnik zarządzany przez zasób.

Type:      String
Mandatory: true

-i, --input

Określa obiekt JSON lub YAML z właściwościami wymaganymi do pobierania wystąpienia zasobu DSC. DsC weryfikuje obiekt względem schematu wystąpienia zasobu. Jeśli walidacja zakończy się niepowodzeniem, usługa DSC zgłosi błąd.

Tej opcji nie można używać z właściwościami wystąpienia za pośrednictwem narzędzia stdin lub --path opcji. Wybierz, czy przekazać właściwości wystąpienia do polecenia za pośrednictwem narzędzia stdin, z pliku z --path opcją lub z opcją --input .

DsC ignoruje tę opcję, gdy zostanie określona --all opcja.

Type:      String
Mandatory: false

-p, --path

Definiuje ścieżkę do pliku tekstowego do odczytu jako danych wejściowych polecenia zamiast potokowania danych wejściowych z narzędzia stdin lub przekazując go jako ciąg z opcją --input . Określony plik musi zawierać kod JSON lub YAML, który reprezentuje prawidłowe właściwości zasobu. DsC weryfikuje obiekt względem schematu wystąpienia zasobu. Jeśli walidacja zakończy się niepowodzeniem lub jeśli określony plik nie istnieje, usługa DSC zgłasza błąd.

Ta opcja wyklucza się wzajemnie z opcją --input . W przypadku korzystania z tej opcji dsC ignoruje wszelkie dane wejściowe z narzędzia stdin.