Udostępnij za pośrednictwem

Pobieranie zasobu dsc

  • Artykuł

Streszczenie

Wywołuje operację pobierania zasobu.

Składnia

Bez właściwości wystąpienia

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

Właściwości wystąpienia z klasy stdin

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

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

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

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

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

Opis

Podpolecenia get zwraca bieżący stan wystąpienia zasobu.

Domyślnie to polecenie zwraca jedno wystąpienie z określonego zasobu DSC. Aby zwrócić wiele zasobów, użyj parametru --all , grupy zasobów lub polecenia get konfiguracji dsc .

Wszystkie właściwości wymagane przez zasób do pobierania stanu wystąpienia muszą zostać przekazane do tego polecenia jako obiekt JSON lub YAML. Obiekt można przekazać do tego polecenia z stdin lub z opcją --input . Możesz również użyć --path opcji odczytu obiektu z pliku JSON lub YAML.

Przykłady

Przykład 1 — pobieranie wystąpienia zasobu bez żadnych danych wejściowych

W przypadku zasobów z pojedynczym wystąpieniem, które nie wymagają żadnych wartości właściwości w celu zwrócenia rzeczywistego stanu wystąpienia zasobu, właściwości wystąpienia nie są wymagane.

dsc resource get --resource Microsoft/OSInfo

actualState:
  $id: https://developer.microsoft.com/json-schemas/dsc/os_info/20230303/Microsoft.Dsc.OS_Info.schema.json
  family: Windows
  version: 10.0.22621
  edition: Windows 11 Enterprise
  bitness: '64'

Przykład 2 — pobieranie wystąpienia zasobu z opcją wprowadzania

Jeśli zasób wymaga co najmniej jednej wartości właściwości w celu zwrócenia rzeczywistego stanu wystąpienia, właściwości wystąpienia można przekazać z opcją wejściową jako JSON lub YAML.

dsc resource get --resource Microsoft.Windows/Registry --input '{
    "keyPath": "HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion",
    "valueName": "SystemRoot"
}'

actualState:
  $id: https://developer.microsoft.com/json-schemas/windows/registry/20230303/Microsoft.Windows.Registry.schema.json
  keyPath: HKLM\Software\Microsoft\Windows NT\CurrentVersion
  valueName: SystemRoot
  valueData:
    String: C:\WINDOWS

Przykład 3 — pobieranie wystąpienia zasobu z danymi wejściowymi z usługi stdin

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

'{
    "keyPath": "HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion",
    "valueName": "SystemRoot"
}' | dsc resource get --resource Microsoft.Windows/Registry

actualState:
  $id: https://developer.microsoft.com/json-schemas/windows/registry/20230303/Microsoft.Windows.Registry.schema.json
  keyPath: HKLM\Software\Microsoft\Windows NT\CurrentVersion
  valueName: SystemRoot
  valueData:
    String: C:\WINDOWS

Przykład 4 — pobieranie wystąpienia zasobu z danymi wejściowymi z pliku YAML

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

cat ./example.yaml

keyPath:   HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion
valueName: SystemRoot

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

actualState:
  $id: https://developer.microsoft.com/json-schemas/windows/registry/20230303/Microsoft.Windows.Registry.schema.json
  keyPath: HKLM\Software\Microsoft\Windows NT\CurrentVersion
  valueName: SystemRoot
  valueData:
    String: C:\WINDOWS

Opcje

-a, --all

Określa, że polecenie powinno zwrócić każde wystąpienie określonego zasobu DSC zamiast określonego wystąpienia.

Ta opcja jest prawidłowa tylko wtedy, gdy zasób jest zasobem możliwy do wyeksportowania, który definiuje sekcję eksportu w konfiguracji wejściowej. Jeśli typ zasobu nie jest możliwy do wyeksportowania, rozszerzenie DSC zgłasza błąd.

Po określeniu tej opcji rozszerzenie DSC ignoruje --input opcje i oraz --path wszystkie pliki JSON lub YAML wysyłane do polecenia z narzędzia stdin.

Type:      Boolean
Mandatory: false

-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: <owner>[.<group>][.<area>]/<name>, gdzie:

  • Jest owner to utrzymywanie autora lub organizacji dla zasobu.
  • Elementy group i area są opcjonalnymi składnikami nazw, które umożliwiają tworzenie 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. Rozszerzenie DSC weryfikuje obiekt względem schematu wystąpienia zasobu. Jeśli weryfikacja nie powiedzie się, rozszerzenie DSC zgłosi błąd.

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

Rozszerzenie DSC ignoruje tę opcję po określeniu --all opcji.

Type:      String
Mandatory: false

-p, --path

Definiuje ścieżkę do pliku tekstowego do odczytu jako dane wejściowe dla polecenia zamiast potokowania danych wejściowych ze stdin lub przekazywania go jako ciągu z opcją --input . Określony plik musi zawierać kod JSON lub YAML, który reprezentuje prawidłowe właściwości zasobu. Rozszerzenie DSC weryfikuje obiekt względem schematu wystąpienia zasobu. Jeśli walidacja zakończy się niepowodzeniem lub jeśli określony plik nie istnieje, rozszerzenie DSC zgłosi błąd.

Ta opcja wyklucza się wzajemnie z opcją --input . Jeśli używasz tej opcji, DSC ignoruje wszystkie dane wejściowe ze stdin.

Rozszerzenie DSC ignoruje tę opcję po określeniu --all opcji.

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 danymi JSON.

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

-h, --help

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

Type:      Boolean
Mandatory: false

Dane wyjściowe

Domyślnie to polecenie zwraca dane wyjściowe JSON, które zawierają rzeczywisty stan wystąpienia. Po określeniu --all opcji polecenie zwraca dane wyjściowe JSON dla każdego wystąpienia jako linie JSON.

Aby uzyskać więcej informacji na temat struktury wyjściowego kodu JSON, zobacz dsc resource get result schema (Pobieranie schematu wyników zasobu dsc).