Dokumentacja schematu wyników listy zasobów dsc

Streszczenie

Wynik danych wyjściowych polecenia dsc resource list.

Metadane

SchemaDialect: https://json-schema.org/draft/2020-12/schema
SchemaID:      https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/outputs/resource/list.json
Type:          object

Opis

Dane wyjściowe polecenia dsc resource list zawierają reprezentację odnalezionych zasobów DSC jako serii wierszy JSON. W tym schemacie opisano obiekt JSON zwracany dla każdego zasobu.

Wymagane właściwości

Każdy zasób w danych wyjściowych zawsze zawiera następujące właściwości:

• typ
• wersji
• ścieżka
• katalogu
• implementowane
• autora
• właściwości
• requireAdapter
• manifestu

Właściwości

typ

Identyfikuje w pełni kwalifikowaną nazwę typu zasobu. Służy do określania zasobu w dokumentach konfiguracji oraz jako wartości flagi --resource podczas używania poleceń dsc resource *. Aby uzyskać więcej informacji na temat nazw typów zasobów, zobacz dokumentacja schematu nazwy w pełni kwalifikowanego typu zasobu DSC.

Type:     string
Required: true
Pattern:  ^\w+(\.\w+){0,2}\/\w+$

rodzaj

Określa, czy zasób jest zasobem karty , zasobem grupy , czy też nie. Ta wartość jest zdefiniowana w manifeście zasobu lub wnioskowana przez DSC. Aby uzyskać więcej informacji na temat rodzajów zasobów, zobacz dokumentacja schematu typu zasobów DSC.

Type:          string
Required:      true
ValidValues:  [Resource, Adapter, Group]

Wersja

Reprezentuje bieżącą wersję zasobu jako prawidłowy ciąg semantyczny (semver). Wersja ma zastosowanie do zasobu, a nie oprogramowania, którymi zarządza.

Type:     string
Required: true
Pattern:  ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$

Możliwości

Definiuje operacje i zachowania, które zasób jest implementowany do obsługi. Ta właściwość jest tablicą możliwości. Zasoby zawsze mają Get możliwości, ale inne możliwości są opcjonalne i zależą od zasobu.

Na poniższej liście opisano dostępne możliwości zasobu:

• Get — zasób obsługuje pobieranie bieżącego stanu wystąpienia. Wszystkie zasoby DSC muszą mieć tę możliwość. Zasób ma tę możliwość podczas definiowania obowiązkowego pobierania właściwości w manifeście zasobu.

• Set — zasób obsługuje wymuszanie żądanego stanu wystąpienia. Zasób ma tę możliwość podczas definiowania właściwości w manifeście zasobu. Zasobów bez tej możliwości nie można używać z zestawem zasobów dsc lub zestawem konfiguracji dsc dsc poleceniami, chyba że są w grupie Microsoft.DSC/Assertion jako zagnieżdżone wystąpienie.

• SetHandlesExist — zasób obsługuje bezpośrednio właściwość _exist. Zasób ma tę możliwość, gdy definiuje właściwość obsługuje Exist jako true w definicji właściwości polecenia ustawić właściwości polecenia w manifeście zasobu.

  Gdy zasób ma tę możliwość, właściwość _exist jest częścią schematu wystąpienia zasobu, a zasób obsługuje usuwanie wystąpień zasobu w jego set polecenia.

  Jeśli zasób nie ma tej możliwości, gdy dsC znajdzie wystąpienie zasobu z _exist ustawionym na false, obsługuje wywołanie operacji usuwania dla zasobu.

  Jeśli zasób nie ma tej możliwości lub Delete możliwości, rozszerzenie DSC zgłasza błąd, gdy wystąpienie definiuje _exist jako false.

• WhatIf — zasób obsługuje zwracanie jawnych informacji o sposobie modyfikowania stanu, gdy użytkownik wywołuje zestaw konfiguracji dsc dsc z opcją --what-if. Zasób ma tę możliwość podczas definiowania metody analizy co-jeżeli w manifeście zasobu.

  Gdy zasób ma tę możliwość, rozszerzenie DSC wywołuje zdefiniowane polecenie z argumentami, gdy użytkownik wykonuje dsc config set polecenie z opcją --what-if.

  Gdy zasób nie ma tej możliwości, rozszerzenie DSC syntetyzuje sposób zmiany zasobu i wystąpienia, konwertując wynik Test dla wystąpienia na wynik Set. Operacja syntetyczna nie może wskazywać potencjalnych problemów lub zmian, których nie można określić, porównując wynik operacji Test z żądanym stanem zasobu. Na przykład poświadczenia używane do testowania zasobu mogą być prawidłowe dla tej operacji, ale nie mają uprawnień do faktycznego modyfikowania stanu systemu. Tylko zasób z tą funkcją może w pełni zgłosić, czy i jak zasób zmieni stan systemu.

• Test — zasób obsługuje weryfikowanie żądanego stanu wystąpienia względem bieżącego stanu wystąpienia. Zasób ma tę możliwość podczas definiowania właściwości test w manifeście zasobu.

  Jeśli zasób nie ma możliwości Test, dsC używa syntetycznego testu dla wystąpień zasobu. Test syntetyczny porównuje każdą właściwość dla żądanego stanu wystąpienia względem rzeczywistego stanu. Test syntetyczny używa ścisłej równoważności z uwzględnieniem wielkości liter. Jeśli żądany stan właściwości i rzeczywisty stan nie są takie same, rozszerzenie DSC oznacza właściwość jako w żądanym stanie.

• Delete — zasób obsługuje usuwanie wystąpienia. Zasób ma tę możliwość podczas definiowania właściwości usuwania w manifeście zasobu. Ta funkcja nie wyklucza się wzajemnie z właściwością SetHandlesExist. Zasób może obsługiwać właściwość _exist w operacjach zestawu i być wywoływany bezpośrednio za pomocą usuwania zasobów dsc w celu usunięcia wystąpienia.

• Export — zasób obsługuje wyliczanie każdego wystąpienia zasobu. Zasób ma tę możliwość podczas definiowania właściwości eksportu w manifeście zasobu. Tylko zasoby z tą funkcją mogą być używane z eksportowania zasobów dsc i polecenia eksportowania konfiguracji dsc.

• Resolve — zasób obsługuje rozpoznawanie zagnieżdżonych wystąpień zasobów z zewnętrznego źródła. Zasób ma tę możliwość podczas definiowania rozpoznawania właściwości w manifeście zasobu. Ta funkcja jest używana głównie przez zasoby importera .

Type:              array
Required:          true
ItemsMustBeUnique: true
ItemsType:         string
ItemsValidValues: [Get, Set, SetHandlesExist, Test, Delete, Export]

opis

Definiuje składnię celu zasobu jako krótki ciąg. Jeśli zasób nie ma opisu, ta właściwość jest null.

Type:     [string, 'null']
Required: true

ścieżka

Reprezentuje ścieżkę do manifestu zasobu na maszynie. W przypadku zasobów dostosowanych ta właściwość identyfikuje ścieżkę do pliku, który zamiast tego definiuje zasób.

Type:     string
Required: true

katalog

Reprezentuje ścieżkę do folderu zawierającego manifest zasobu na maszynie. W przypadku zasobów dostosowanych ta właściwość identyfikuje ścieżkę do folderu zawierającego plik, który zamiast tego definiuje zasób.

Type:     string
Required: true

implementowane As

Wskazuje sposób implementacji zasobu DSC. W przypadku zasobów opartych na poleceniach ta wartość jest zawsze Command.

autor

Wskazuje nazwę osoby lub organizacji, która opracowała i utrzymuje zasób DSC. Jeśli ta właściwość jest null, autor jest nieznany.

Type:     [string, 'null']
Required: true

Właściwości

Definiuje nazwy właściwości dostosowanych zasobów. W przypadku zasobów niezaadaptanych ta właściwość jest pustą tablicą.

Type:         array
Required:     true
ItemsType:    string
ItemsPattern: ^\w+$

requireAdapter

Definiuje w pełni kwalifikowaną nazwę typu adaptera zasobów DSC, za pośrednictwem którego ten zasób jest udostępniany. Ta wartość jest definiowana tylko dla zasobów dostosowanych. W przypadku zasobów, które nie są dostosowane, ta wartość jest zawsze null.

Type:     [string, 'null']
Required: true

manifest

Reprezentuje wartości zdefiniowane w manifeście zasobu. Ta wartość jest null dla zasobów, które nie są oparte na poleceniach. Aby uzyskać więcej informacji na temat wartości tej właściwości, zobacz dokumentacja schematu manifestu zasobu DSC oparta na poleceniach.

Type:     [object, 'null']
Required: true