Udostępnij za pośrednictwem

Schemat właściwości _exist zasobu DSC

  • Artykuł

Streszczenie

Wskazuje, czy wystąpienie powinno istnieć.

Metadane

SchemaDialect: https://json-schema.org/draft/2020-12/schema
SchemaID:      https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/resource/properties/exist.json
Type:          boolean
DefaultValue:  true

Opis

Właściwość _exist wskazuje, że zasób może wymusić, czy wystąpienia istnieją, czy wystąpienie powinno zostać dodane, zaktualizowane, czy usunięte podczas operacji zestawu. Ta właściwość zapewnia współużytkowane semantyki dla zasobów DSC i integrowania narzędzi, ale nie umożliwia dodatkowego wbudowanego przetwarzania za pomocą rozszerzenia DSC.

Zasoby powinny definiować tę właściwość tylko wtedy, gdy ich implementacja jest zgodna z następującym kontraktem zachowania:

  1. Gdy żądany stan parametru _exist to true, zasób oczekuje, że wystąpienie będzie istnieć. Jeśli nie istnieje, zasób tworzy lub dodaje wystąpienie podczas operacji zestawu.

  2. Gdy żądany stan parametru _exist to false, zasób oczekuje, że wystąpienie nie istnieje. Jeśli istnieje, zasób usuwa lub usuwa wystąpienie podczas operacji zestawu.

  3. Gdy operacja get wykonuje zapytania dotyczące wystąpienia, które nie istnieje, zwracany kod JSON zawsze definiuje _exist właściwość jako false.

    Zasób może pominąć_exist właściwość z wyniku JSON, gdy wystąpienie istnieje.

Aby dodać tę właściwość do schematu wystąpienia zasobu, zdefiniuj właściwość przy użyciu następującego fragmentu kodu:

"_exist": {
  "$ref": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/resource/properties/exist.json"
}