Skip to content

11/6/2025 PM Publish #384

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 6, 2025
Merged

11/6/2025 PM Publish #384

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 16 additions & 16 deletions dsc/docs-conceptual/dsc-2.0/how-tos/resources/authoring/class-based.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,13 @@ For more information about DSC Resources, see [DSC Resources][1].
## Folder structure for a class Resource

To implement a DSC Resource with a PowerShell class, create the following folder structure. The
class is defined in `MyDscResource.psm1` and the module manifest is defined in `MyDscResource.psd1`.
class is defined in `NewFile.psm1` and the module manifest is defined in `NewFile.psd1`.

```text
$env:ProgramFiles\WindowsPowerShell\Modules (folder)
|- MyDscResource (folder)
MyDscResource.psm1
MyDscResource.psd1
|- NewFile (folder)
NewFile.psm1
NewFile.psd1
```

## Create the class
Expand Down Expand Up @@ -61,7 +61,7 @@ follows.
[string] $content

[DscProperty(NotConfigurable)]
[MyDscResourceReason[]] $Reasons
[NewFileReason[]] $Reasons
```

Notice that the properties are modified by attributes. The meaning of the attributes is as follows:
Expand Down Expand Up @@ -90,7 +90,7 @@ If you would like to include a new type with defined properties that you can use
DSC Resource, create a class with property types as described before.

```powershell
class MyDscResourceReason {
class NewFileReason {
[DscProperty()]
[string] $Code

Expand All @@ -100,7 +100,7 @@ class MyDscResourceReason {
```

> [!NOTE]
> The `MyDscResourceReason` class is declared here with the module's name as a prefix. While you can
> The `NewFileReason` class is declared here with the module's name as a prefix. While you can
> give embedded classes any name, if two or more modules define a class with the same name and are
> both used in a configuration, PowerShell raises an exception.
>
Expand Down Expand Up @@ -134,10 +134,10 @@ function Get-File {
[String]$content
)

$fileContent = [MyDscResourceReason]::new()
$fileContent = [NewFileReason]::new()
$fileContent.code = 'file:file:content'

$filePresent = [MyDscResourceReason]::new()
$filePresent = [NewFileReason]::new()
$filePresent.code = 'file:file:path'

$ensureReturn = 'Absent'
Expand Down Expand Up @@ -309,7 +309,7 @@ enum ensure {
errors raised when multiple modules with DSC Resources define the
Reasons property for reporting when they're out-of-state.
#>
class MyDscResourceReason {
class NewFileReason {
[DscProperty()]
[string] $Code

Expand All @@ -332,10 +332,10 @@ function Get-File {
[String]$content
)

$fileContent = [MyDscResourceReason]::new()
$fileContent = [NewFileReason]::new()
$fileContent.code = 'file:file:content'

$filePresent = [MyDscResourceReason]::new()
$filePresent = [NewFileReason]::new()
$filePresent.code = 'file:file:path'

$ensureReturn = 'Absent'
Expand Down Expand Up @@ -502,7 +502,7 @@ class NewFile {
about the Resource when it is present.
#>
[DscProperty(NotConfigurable)]
[MyDscResourceReason[]] $Reasons
[NewFileReason[]] $Reasons

<#
This method is equivalent of the Get-TargetResource script function.
Expand Down Expand Up @@ -628,9 +628,9 @@ A module can define multiple class-based DSC Resources. You need to declare all

```text
$env:ProgramFiles\PowerShell\Modules (folder)
|- MyDscResource (folder)
|- MyDscResource.psm1
MyDscResource.psd1
|- NewFile (folder)
|- NewFile.psm1
NewFile.psd1
```

## See Also
Expand Down
Loading