From 088b98c00ee4fc169721eefec7b5559a41bf8b85 Mon Sep 17 00:00:00 2001 From: "G.Reijn" Date: Fri, 14 Nov 2025 13:40:50 +0100 Subject: [PATCH] Remove obsolete _rebootRequested property and its documentation from DSC resource schemas --- .../resource/manifest/schema/embedded.md | 18 ------- .../schemas/resource/properties/overview.md | 9 ---- .../resource/properties/rebootRequested.md | 50 ------------------- 3 files changed, 77 deletions(-) delete mode 100644 docs/reference/schemas/resource/properties/rebootRequested.md diff --git a/docs/reference/schemas/resource/manifest/schema/embedded.md b/docs/reference/schemas/resource/manifest/schema/embedded.md index f49617b69..156a4f20f 100644 --- a/docs/reference/schemas/resource/manifest/schema/embedded.md +++ b/docs/reference/schemas/resource/manifest/schema/embedded.md @@ -94,7 +94,6 @@ in the embedded schema, the schema _must_ define the property as a reference. - [_exist](#_exist) - [_inDesiredState](#_indesiredstate) - [_purge](#_purge) -- [_rebootRequested](#_rebootrequested) #### _exist @@ -145,24 +144,7 @@ If defined, this property must be a reference to the schema for the canonical pr For more information, see [DSC Resource _purge property schema][04]. -#### _rebootRequested - -The read-only `_rebootRequested` property indicates whether a resource instance requires a reboot -after a set operation. To use DSC's built-in reboot notification processing, resources must define -this property in their manifest. - -If defined, this property must be a reference to the schema for the canonical property: - -```json -"_rebootRequested": { - "$ref": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/resource/properties/rebootRequested.json" -} -``` - -For more information, see [DSC Resource _rebootRequested property schema][05] - [01]: ../../properties/ensure.md [02]: ../test.md [03]: ../../properties/inDesiredState.md [04]: ../../properties/purge.md -[05]: ../../properties/rebootRequested.md diff --git a/docs/reference/schemas/resource/properties/overview.md b/docs/reference/schemas/resource/properties/overview.md index 948e5efce..aad231983 100644 --- a/docs/reference/schemas/resource/properties/overview.md +++ b/docs/reference/schemas/resource/properties/overview.md @@ -38,17 +38,8 @@ DSC. For more information, see [DSC Resource _purge property schema][05]. -## _rebootRequested - -The read-only `_rebootRequested` property indicates whether a resource instance requires a reboot -after a set operation. To use DSC's built-in reboot notification processing, resources must define -this property in their manifest. - -For more information, see [DSC Resource _rebootRequested property schema][06]. - [01]: exist.md [02]: ../manifest/test.md [03]: ../manifest/root.md [04]: inDesiredState.md [05]: purge.md -[06]: rebootRequested.md diff --git a/docs/reference/schemas/resource/properties/rebootRequested.md b/docs/reference/schemas/resource/properties/rebootRequested.md deleted file mode 100644 index a7c0e3a45..000000000 --- a/docs/reference/schemas/resource/properties/rebootRequested.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -description: JSON schema reference for the '_rebootRequested' canonical DSC Resource property. -ms.date: 07/03/2025 -ms.topic: reference -title: DSC Resource _rebootRequested property schema ---- - -# DSC Resource _rebootRequested property schema - -## Synopsis - -Indicates whether an instance is in the desired state. - -## Metadata - -```yaml -SchemaDialect: https://json-schema.org/draft/2020-12/schema -SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/resource/properties/rebootRequested.json -Type: [boolean, 'null'] -ReadOnly: true -``` - -## Description - -The `_rebootRequested` canonical property indicates whether a resource instance requires a reboot -after a set operation. - -If the resource determines during a set operation that the node needs to reboot before the state -change takes full effect, it should return the instance's data with the `_rebootRequested` property -set to `true`. If a resource returns an instance from the set operation with the `_rebootRequested` -property set to `true`, DSC generates a reboot notification. - -If the resource returns an instance from the set operation without the `_rebootRequested` property -defined, or if the property value is `false`, DSC doesn't generate a reboot notification. - -Resources must define this property to use DSC's built-in reboot request notifications. - -This property is read-only. The resource returns instances with this property, but the desired -state can't include it. - -To add this property to a resource's instance schema, define the property with the following -snippet: - -```json -"_rebootRequested": { - "$ref": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/resource/properties/rebootRequested.json" -} -``` - -