Dela via

Egenskapsschema för DSC-resurs _exist

  • Artikel

Synopsis

Anger om en instans ska finnas.

Metadata

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

Description

Egenskapen _exist anger att resursen kan framtvinga om instanser finns, hantera om en instans ska läggas till, uppdateras eller tas bort under en angivna åtgärd. Den här egenskapen tillhandahåller delad semantik för DSC-resurser och integrering av verktyg, men aktiverar inte ytterligare inbyggd bearbetning med DSC.

Resurser bör endast definiera den här egenskapen när implementeringen följer följande beteendekontrakt:

  1. När det önskade tillståndet för _exist är trueförväntar sig resursen att instansen finns. Om den inte finns skapar eller lägger resursen till instansen under den angivna åtgärden.

  2. När det önskade tillståndet för _exist är falseförväntar sig resursen att instansen inte finns. Om den finns tar resursen bort eller tar bort instansen under den angivna åtgärden.

  3. När hämtar åtgärdsfrågor för en instans som inte finns definierar _exist den returnerade JSON alltid egenskapen som false.

    Resursen _existkan utelämna egenskapen från JSON-resultatet när instansen finns.

Om du vill lägga till den här egenskapen i en resurs instansschema definierar du egenskapen med följande kodfragment:

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