Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
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/2024/04/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]
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
