Skip to content

Auto Publish – main to live - 2025-09-29 22:00 UTC #379

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
Sep 29, 2025
Merged

Auto Publish – main to live - 2025-09-29 22:00 UTC #379

Show file tree
Hide file tree
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
24 changes: 12 additions & 12 deletions dsc/dsc-1.1/PSDesiredStateConfiguration/About/about_Classes_and_DSC.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ title: about Classes and DSC
---
# about_Classes_and_DSC

## SHORT DESCRIPTION
## Short description

Describes how you can use classes to develop in PowerShell with Desired State
Configuration (DSC).

## LONG DESCRIPTION
## Long description

Starting in Windows PowerShell 5.0, language was added to define classes and
other user-defined types, by using formal syntax and semantics that are
Expand All @@ -22,7 +22,7 @@ developers and IT professionals to embrace Windows PowerShell for a wider
range of use cases, simplify development of PowerShell artifacts such as DSC
resources, and accelerate coverage of management surfaces.

## SUPPORTED SCENARIOS
## Supported scenarios

The following scenarios are supported:

Expand All @@ -34,7 +34,7 @@ The following scenarios are supported:
- Generate and handle exceptions by using formal mechanisms, and at the right
level.

## DEFINE DSC RESOURCES WITH CLASSES
## Define DSC resources with classes

Apart from syntax changes, the major differences between a class-defined DSC
resource and a cmdlet DSC resource provider are the following items:
Expand All @@ -43,7 +43,7 @@ resource and a cmdlet DSC resource provider are the following items:
- A DSCResource subfolder in the module folder is not required.
- A PowerShell module file can contain multiple DSC resource classes.

## CREATE A CLASS-DEFINED DSC RESOURCE PROVIDER
## Create a class-defined DSC resource provider

The following example is a class-defined DSC resource provider that is saved
as a module, MyDSCResource.psm1. You must always include a key property in a
Expand Down Expand Up @@ -246,7 +246,7 @@ class FileResource
}
```

## CREATE A MODULE MANIFEST
## Create a module manifest

After creating the class-defined DSC resource provider, and saving it as a
module, create a module manifest for the module. To make a class-based
Expand Down Expand Up @@ -290,7 +290,7 @@ PowerShellVersion = '5.0'
}
```

## DEPLOY A DSC RESOURCE PROVIDER
## Deploy a DSC resource provider

Deploy the new DSC resource provider by creating a MyDscResource folder in
`$pshome\Modules` or `$env:SystemDrive\ProgramFiles\WindowsPowerShell\Modules`.
Expand All @@ -302,7 +302,7 @@ MyDscResource folder.
From this point, you create and run a configuration script as you would with
any DSC resource.

## CREATE A DSC CONFIGURATION SCRIPT
## Create a DSC configuration script

After saving the class and manifest files in the folder structure as described
earlier, you can create a configuration that uses the new resource. The
Expand Down Expand Up @@ -336,7 +336,7 @@ configuration, in an elevated PowerShell console, run the following:

`PS C:\test> .\MyResource.ps1`

## INHERITANCE IN POWERSHELL CLASSES
## Inheritance in PowerShell classes

### Declare base classes for PowerShell classes

Expand Down Expand Up @@ -467,7 +467,7 @@ $list[0] # return 200
A limitation with class inheritance is that there is no syntax to declare
interfaces in PowerShell.

## DEFINING CUSTOM TYPES IN POWERSHELL
## Defining custom types in PowerShell

Windows PowerShell 5.0 introduced several language elements.

Expand Down Expand Up @@ -694,7 +694,7 @@ $v = bar
$v -eq $d # true
```

## EXAMPLE: CREATE CUSTOM CLASSES
## Example: Create custom classes

The following example creates several new, custom classes to implement an HTML
Dynamic Stylesheet Language (DSL). The example adds helper functions to create
Expand Down Expand Up @@ -825,7 +825,7 @@ function Style
function Html ([HTML] $doc) { return $doc }
```

## SEE ALSO
## See also

[about_DesiredStateConfiguration](/powershell/module/Microsoft.PowerShell.Core/About/about_desiredstateconfiguration)

Expand Down
24 changes: 12 additions & 12 deletions dsc/dsc-2.0/PSDesiredStateConfiguration/About/about_Classes_and_DSC.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ title: about Classes and DSC
---
# about_Classes_and_DSC

## SHORT DESCRIPTION
## Short description

Describes how you can use classes to develop in PowerShell with Desired State
Configuration (DSC).

## LONG DESCRIPTION
## Long description

Starting in Windows PowerShell 5.0, language was added to define classes and
other user-defined types, by using formal syntax and semantics that are
Expand All @@ -22,7 +22,7 @@ developers and IT professionals to embrace PowerShell for a wider
range of use cases, simplify development of PowerShell artifacts such as DSC
resources, and accelerate coverage of management surfaces.

## SUPPORTED SCENARIOS
## Supported scenarios

The following scenarios are supported:

Expand All @@ -34,7 +34,7 @@ The following scenarios are supported:
- Generate and handle exceptions by using formal mechanisms, and at the right
level.

## DEFINE DSC RESOURCES WITH CLASSES
## Define DSC resources with classes

Apart from syntax changes, the major differences between a class-defined DSC
resource and a cmdlet DSC resource provider are the following items:
Expand All @@ -43,7 +43,7 @@ resource and a cmdlet DSC resource provider are the following items:
- A DSCResource subfolder in the module folder is not required.
- A PowerShell module file can contain multiple DSC resource classes.

## CREATE A CLASS-DEFINED DSC RESOURCE PROVIDER
## Create a class-defined DSC resource provider

The following example is a class-defined DSC resource provider that is saved
as a module, MyDSCResource.psm1. You must always include a key property in a
Expand Down Expand Up @@ -246,7 +246,7 @@ class FileResource
}
```

## CREATE A MODULE MANIFEST
## Create a module manifest

After creating the class-defined DSC resource provider, and saving it as a
module, create a module manifest for the module. To make a class-based
Expand Down Expand Up @@ -290,7 +290,7 @@ PowerShellVersion = '5.0'
}
```

## DEPLOY A DSC RESOURCE PROVIDER
## Deploy a DSC resource provider

Deploy the new DSC resource provider by creating a MyDscResource folder in
`$pshome\Modules` or `$env:SystemDrive\ProgramFiles\WindowsPowerShell\Modules`.
Expand All @@ -302,7 +302,7 @@ MyDscResource folder.
From this point, you create and run a configuration script as you would with
any DSC resource.

## CREATE A DSC CONFIGURATION SCRIPT
## Create a DSC configuration script

After saving the class and manifest files in the folder structure as described
earlier, you can create a configuration that uses the new resource. The
Expand Down Expand Up @@ -336,7 +336,7 @@ configuration, in an elevated PowerShell console, run the following:

`PS C:\test> .\MyResource.ps1`

## INHERITANCE IN POWERSHELL CLASSES
## Inheritance in PowerShell classes

### Declare base classes for PowerShell classes

Expand Down Expand Up @@ -467,7 +467,7 @@ $list[0] # return 200
A limitation with class inheritance is that there is no syntax to declare
interfaces in PowerShell.

## DEFINING CUSTOM TYPES IN POWERSHELL
## Defining custom types in PowerShell

Windows PowerShell 5.0 introduced several language elements.

Expand Down Expand Up @@ -694,7 +694,7 @@ $v = bar
$v -eq $d # true
```

## EXAMPLE: CREATE CUSTOM CLASSES
## Example: Create custom classes

The following example creates several new, custom classes to implement an HTML
Dynamic Stylesheet Language (DSL). The example adds helper functions to create
Expand Down Expand Up @@ -825,7 +825,7 @@ function Style
function Html ([HTML] $doc) { return $doc }
```

## SEE ALSO
## See also

[about_Enum](/powershell/module/Microsoft.PowerShell.Core/About/about_Enum)

Expand Down
Loading