Settings resource

November 7, 2025 · View on GitHub

The Settings resource manages WinGet Studio application settings including theme and telemetry preferences. This resource is available through the WinGet Studio CLI.

Type

Microsoft.WinGetStudio/Settings

Supported operations

OperationSupportedDescription
get✅Retrieve current settings
set✅Configure settings to desired state
test✅Test whether settings match desired state
export✅Export current settings (identical to get)
schema✅Display JSON schema for the resource
manifest✅Display resource manifest

Properties

settings

The settings object contains WinGet Studio configuration properties.

PropertyTypeRequiredDescription
themestringNoUI theme: Default, Light, or Dark
telemetry.disablebooleanNoWhen true, disables telemetry events

Examples

Get operation

Retrieve the current WinGet Studio settings:

wingetstudio dsc get --resource settings

Output:

{
  "settings": {
    "theme": "Default",
    "telemetry": {
      "disable": false
    }
  }
}

Set operation

Configure WinGet Studio with desired settings:

wingetstudio dsc set --resource settings --input '{
  "settings": {
    "theme": "Dark",
    "telemetry": {
      "disable": true
    }
  }
}'

Output:

{
  "settings": {
    "theme": "Dark",
    "telemetry": {
      "disable": true
    }
  }
}

The output shows the settings after applying the desired state.

Test operation

Test whether current settings match desired state:

wingetstudio dsc test --resource settings --input '{
  "settings": {
    "theme": "Dark",
    "telemetry": {
      "disable": false
    }
  }
}'

Output:

{
  "settings": {
    "theme": "Dark",
    "telemetry": {
      "disable": true
    }
  },
  "_inDesiredState": false
}

The _inDesiredState property indicates whether the current state matches the input. In this example, it's false because the current telemetry setting differs from the desired state.

Export operation

Export current settings (output is identical to get operation):

wingetstudio dsc export --resource settings

Output:

{
  "settings": {
    "theme": "Default",
    "telemetry": {
      "disable": false
    }
  }
}

Schema operation

Display the JSON schema for the Settings resource:

wingetstudio dsc schema --resource settings

Returns the complete JSON schema defining the resource's properties, types, and constraints.

Manifest operation

Display the resource manifest:

wingetstudio dsc manifest --resource settings

Returns the DSC resource manifest including version, kind, adapter, and supported operations.

Configuration file usage

You can use the Settings resource in WinGet Configuration files:

Microsoft DSC 3.x format

# configuration.dsc.yaml
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2023/08/config/document.json
resources:
  - name: Configure WinGet Studio
    type: Microsoft.WinGetStudio/Settings
    properties:
      settings:
        theme: Dark
        telemetry:
          disable: true

Apply the configuration:

dsc config set --path configuration.dsc.yaml

Theme options

The theme property controls the WinGet Studio UI appearance:

  • Default: Automatically matches the current Windows theme
  • Light: Light theme with bright background
  • Dark: Dark theme with dark background

Telemetry control

The telemetry.disable property controls ETW event logging:

  • false (default): WinGet Studio writes telemetry events
  • true: Disables all telemetry event writing

For more information about data collection, see:

See also