Skip to content

message.md

Latest commit

 

History

History
75 lines (52 loc) · 1.42 KB

message.md

File metadata and controls

75 lines (52 loc) · 1.42 KB
description JSON schema reference for a structured message returned from a 'dsc config' command.
ms.date 07/03/2025
ms.topic reference
title Structured message schema reference

Structured message schema reference

Synopsis

A message emitted by a DSC Resource with associated metadata.

Metadata

SchemaDialect: https://json-schema.org/draft/2020-12/schema
SchemaID:      https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/definitions/message.json
Type:          object

Description

Required properties

Every message must be an object that defines these properties:

Properties

name

Identifies the instance by its short, unique, human-readable name as defined in the configuration document.

Type:     string
Required: true

type

Identifies the instance's DSC Resource by its fully qualified type name. For more information about type names, see DSC Resource fully qualified type name schema reference.

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

message

The actual content of the message as emitted by the DSC Resource.

Type:     string
Required: true

level

Indicates the severity of the message.

Type:         string
Required:     true
Valid Values: [error, warning, information]