zestaw zasobów dsc

Streszczenie

Wywołuje operację zestawu zasobu.

Składnia

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

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

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

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

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

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

Opis

Podpolecenia set wymusza żądany stan wystąpienia zasobu i zwraca stan końcowy.

To polecenie ustawia jedno wystąpienie określonego zasobu DSC. Aby ustawić wiele zasobów, użyj grupy zasobów lub polecenia dsc config set .

Żądany stan wystąpienia do ustawienia musi zostać przekazany do tego polecenia jako obiekt JSON lub YAML. Właściwości obiektu muszą być prawidłowymi właściwościami zasobu. Właściwości wystąpienia można przekazać do tego polecenia z narzędzia stdin jako ciąg z --input opcją lub z zapisanego pliku z opcją --path .

To podpolecenia można wywołać tylko dla zasobów DSC opartych na poleceniach, które definiują sekcję set manifestu zasobu. Jeśli to polecenie jest wywoływane dla zasobu, który nie definiuje operacji zestawu, dsC zgłasza błąd.

Ważne

Polecenie dsc resource set zawsze wywołuje operację set zasobu. Zasoby mogą, ale nie są wymagane, implementują logikę, która wstępnie testuje wystąpienie dla set operacji.

Różni się to od sposobu działania zestawu konfiguracji dsc, gdzie dsC zawsze testuje wystąpienie, syntetycznie lub przez wywołanie test operacji dla zasobu i wywołuje set tylko dla wystąpienia, jeśli nie jest w żądanym stanie.

Zasoby oparte na poleceniach wskazują, czy implementują wstępnie test dla set operacji, definiując właściwość set.implementsPretest w manifeście zasobu. Jeśli ta właściwość jest zdefiniowana jako true, wskazuje, że zasób implementuje wstępnie test. Jeśli set.implementsPretest ustawiono wartość false lub jest niezdefiniowana, manifest wskazuje, że zasób nie implementuje wstępnego testu.

Jeśli zasób wskazuje, że implementuje wstępnie test, użytkownicy powinni oczekiwać, że zasób modyfikuje tylko wystąpienie podczas set operacji, jeśli test wstępny pokazuje, że wystąpienie nie jest w żądanym stanie.

Jeśli zasób nie implementuje wstępnego testu, użytkownicy powinni oczekiwać, że zasób zawsze modyfikuje wystąpienie podczas set operacji.

W przypadku zasobów, które nie implementują wstępnego testu dla set operacji, firma Microsoft zaleca zawsze wywoływanie dsc resource test wystąpienia w celu sprawdzenia, czy jest on w żądanym stanie przed wywołaniem dsc resource setpolecenia . Może to pomóc uniknąć przypadkowych błędów spowodowanych przez zasoby, które nie implementują w pełni idempotentnego set polecenia.

Przykłady

Przykład 1 — ustawianie zasobu z właściwościami z narzędzia stdin

Polecenie zapewnia, że Example klucz istnieje w bieżącej gałęzi użytkownika. Określa właściwości wystąpienia zasobu jako dane JSON i przekazuje je z narzędzia stdin.

'{
    "keyPath": "HKCU\\Example",
    "_exist": true
}' | dsc resource set --resource Microsoft.Windows/Registry

Przykład 2 — ustawianie zasobu z opcją wprowadzania

Polecenie zapewnia, że Example klucz istnieje w bieżącej gałęzi użytkownika. Określa właściwości wystąpienia zasobu jako kod JSON i przekazuje je z opcją wprowadzania .

dsc resource set --resource Microsoft.Windows/Registry --input '{
    "keyPath": "HKCU\\Example",
    "_exist": true
}'

Przykład 3 — ustawianie zasobu z właściwościami z pliku YAML

Polecenie zapewnia, że Example klucz istnieje w bieżącej gałęzi użytkownika. Określa ścieżkę do pliku yaml definiującego właściwości wystąpienia zasobu z opcją ścieżki .

cat ./example.yaml

keyPath: HKCU\\Example
_exist:  true

dsc resource set --resource Microsoft.Windows/Registry --path ./example.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 definiującymi żądany stan 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 .

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.

Type:      String
Mandatory: false

-f, --format

Opcja --format steruje formatem danych wyjściowych konsoli dla polecenia. Jeśli dane wyjściowe polecenia są przekierowywane lub przechwytywane jako zmienna, dane wyjściowe są zawsze JSON.

Type:         String
Mandatory:    false
DefaultValue: yaml
ValidValues:  [json, pretty-json, yaml]

-h, --help

Wyświetla pomoc dotyczącą bieżącego polecenia lub podpolecenia. Po określeniu tej opcji aplikacja ignoruje wszystkie opcje i argumenty po tym.

Type:      Boolean
Mandatory: false

Dane wyjściowe

To polecenie zwraca dane wyjściowe JSON, które zawierają rzeczywisty stan wystąpienia przed i po operacji zestawu oraz listę właściwości zmodyfikowanych przez operację zestawu. Aby uzyskać więcej informacji, zobacz dsc resource set result schema (Schemat wyników zestawu zasobów dsc).