Skip to content

Value Resource

Synopsis

Manages JSON values at specific JSONPath locations within JSON files. Supports setting, reading, and removing values of any JSON type (string, number, boolean, null, object, or array). Parent paths are created recursively when they don't exist.

Type

OpenDsc.Json/Value

Capabilities

  • Get
  • Set
  • Delete

Properties

path

Absolute file path to the JSON document.

Type: string
Required: Yes
Access: Read/Write
Default value: None

jsonPath

JSONPath expression to locate the value. Must start with $.

Type: string
Required: Yes
Access: Read/Write
Default value: None

value

JSON value to set. Can be a string, number, boolean, null, object, or array.

Type: any
Required: No
Access: Read/Write
Default value: None

_exist

Whether the value should exist.

Type: bool
Required: No
Access: Read/Write
Default value: true

Examples

Example 1 — Get a value

$resourceInput = @'
path: /opt/myapp/config.json
jsonPath: '$.logging.level'
'@

dsc resource get -r OpenDsc.Json/Value --input $resourceInput

resource_input=$(cat <<'EOF'
path: /opt/myapp/config.json
jsonPath: '$.logging.level'
EOF
)

dsc resource get -r OpenDsc.Json/Value --input "$resource_input"

Example 2 — Set a string value

$resourceInput = @'
path: /opt/myapp/config.json
jsonPath: '$.logging.level'
value: Warning
'@

dsc resource set -r OpenDsc.Json/Value --input $resourceInput

resource_input=$(cat <<'EOF'
path: /opt/myapp/config.json
jsonPath: '$.logging.level'
value: Warning
EOF
)

dsc resource set -r OpenDsc.Json/Value --input "$resource_input"

Example 3 — Set an object value

$resourceInput = @'
path: /opt/myapp/config.json
jsonPath: '$.database'
value:
  host: localhost
  port: 5432
  name: appdb
'@

dsc resource set -r OpenDsc.Json/Value --input $resourceInput

resource_input=$(cat <<'EOF'
path: /opt/myapp/config.json
jsonPath: '$.database'
value:
  host: localhost
  port: 5432
  name: appdb
EOF
)

dsc resource set -r OpenDsc.Json/Value --input "$resource_input"

Example 4 — Delete a value

$resourceInput = @'
path: /opt/myapp/config.json
jsonPath: '$.deprecated.setting'
'@

dsc resource delete -r OpenDsc.Json/Value --input $resourceInput

resource_input=$(cat <<'EOF'
path: /opt/myapp/config.json
jsonPath: '$.deprecated.setting'
EOF
)

dsc resource delete -r OpenDsc.Json/Value --input "$resource_input"

Example 5 — Configuration document

$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
resources:
  - name: Set application log level
    type: OpenDsc.Json/Value
    properties:
      path: /opt/myapp/config.json
      jsonPath: $.logging.level
      value: Warning

  - name: Set connection string
    type: OpenDsc.Json/Value
    properties:
      path: /opt/myapp/config.json
      jsonPath: $.connectionStrings.default
      value: "Host=db.example.com;Database=app;Username=appuser"

Exit codes

Code Description
0 Success
1 Error
2 Invalid JSON
3 JSON file not found
4 Invalid argument
5 IO error