Udostępnij za pośrednictwem

Dokumentacja schematu wyników pobierania zasobu dsc

  • Artykuł

Streszczenie

Wynik danych wyjściowych polecenia dsc resource get .

Metadane

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

Opis

Opisuje zwracane dane dla wystąpienia zasobu DSC z dsc resource get polecenia . Zwracane dane to pojedynczy obiekt opisujący rzeczywisty stan wystąpienia niegnieżdżonego lub tablicę obiektów opisujących rzeczywisty stan zagnieżdżonych wystąpień dla zasobu grupy lub karty.

DsC zwraca prostą odpowiedź get , gdy wystąpienie nie jest zasobem grupy, zasobem karty ani zagnieżdżonym wewnątrz grupy lub zasobu karty.

Gdy pobrane wystąpienie jest przeznaczone dla zasobu grupy, zasobu karty lub zagnieżdżonego wewnątrz zasobu grupy lub karty sieciowej, dsC zwraca pełny wynik get, który zawiera również typ zasobu i nazwę wystąpienia.

Prosta odpowiedź get

Opisuje zwracane dane dla pojedynczego wystąpienia zasobu DSC z dsc resource get polecenia . Te dane są zwracane w przypadku wystąpień, które nie są grupowane, zasoby karty ani zagnieżdżone wewnątrz grupy lub zasobu karty.

Wymagane właściwości

Dane wyjściowe zawsze zawierają następujące właściwości:

Właściwości

actualState

Właściwość actualState zawsze zawiera stan wystąpienia zwróconego, gdy dsC wywołuje operację pobierania zasobu. DsC weryfikuje wartość tej właściwości względem schematu wystąpienia zasobu.

Type:     object
Required: true

Pełny wynik pobierania

Opisuje zwracane dane dla pełnego wyniku get operacji dla wystąpienia zasobu. Te dane są zwracane:

  • Dla każdego wystąpienia w dokumencie konfiguracji podczas korzystania z dsc config get polecenia .
  • W przypadku wystąpień zagnieżdżonych zasobu grupy lub karty podczas korzystania z dsc resource get polecenia .

Wymagane właściwości

Właściwości

metadane

Definiuje metadane DSC zwracane dla operacji konfiguracji. Właściwości w ramach Microsoft.DSC właściwości opisują kontekst operacji.

  • duration definiuje czas trwania operacji DSC względem dokumentu konfiguracji lub wystąpienia zasobu jako ciąg zgodnie z formatem zdefiniowanym w ISO8601 ABNF dla duration. Na przykład PT0.611216S reprezentuje czas trwania około 0.61 sekund.
Type:     object
Required: true

typ

Właściwość type identyfikuje zasób DSC wystąpienia przy użyciu w pełni kwalifikowanej nazwy typu. Aby uzyskać więcej informacji na temat nazw typów, zobacz Dokumentacja schematu w pełni kwalifikowanej nazwy typu zasobu DSC.

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

name

Właściwość name identyfikuje wystąpienie według krótkiej, unikatowej, czytelnej dla człowieka nazwy.

Type:     string
Required: true

result

Właściwość result zawiera rzeczywisty stan zasobu. Ta wartość jest następująca:

  • Prosta odpowiedź na żądanie dla wystąpienia
  • Tablica pełnych obiektów wynikowych dla każdego zagnieżdżonego wystąpienia, jeśli zasób jest zasobem grupy lub karty.
Type: [object, array]
Required: true