Skip to content

Commit d7b4051

Browse files
Sync reference docs for v.3.1.0 (#354)
1 parent c89f331 commit d7b4051

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

86 files changed

+5169
-655
lines changed

dsc/docs-conceptual/dsc-3.0/changelog.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ in this release, see the [diff on GitHub][compare-v3.1.0].
130130
- Added support for extensions to DSC. You can now use the `dsc extension list` command to
131131
enumerate available extensions. DSC now supports a single extension capability, `discover`, which
132132
returns JSON objects indicating where to find DSC resource manifests that aren't in the `PATH` or
133-
`DSC_PATH`, as with resources installed as Appx packages.
133+
`DSC_RESOURCE_PATH`, as with resources installed as Appx packages.
134134

135135
Now when DSC performs discovery, it recursively discovers extensions and resources on the system.
136136

@@ -586,11 +586,11 @@ Version `3.0.0` is the first generally available release of DSC.
586586
[release-v3.0.0]: https://github.com/PowerShell/DSC/releases/tag/v3.0.0 "Link to the DSC v3.0.0 release on GitHub"
587587

588588
<!-- Reference doc links -->
589-
[cli.option.p]: ./reference/cli/index.md#--progress-format
590-
[cli.resource.export]: ./reference/cli/resource/export.md
591-
[schema.config.resource]: ./reference/schemas/config/resource.md
592-
[schema.definitions.resourceKind]: ./reference/schemas/definitions/resourcekind.md
593-
[schema.metadata]: ./reference/schemas/metadata/Microsoft.DSC/properties.md
589+
[cli.option.p]: /powershell/dsc/reference/cli/?view=dsc-3.0&preserve-view=true#--progress-format
590+
[cli.resource.export]: /powershell/dsc/reference/cli/resource/export?view=dsc-3.0&preserve-view=true
591+
[schema.config.resource]: /powershell/dsc/reference/schemas/config/resource?view=dsc-3.0&preserve-view=true
592+
[schema.definitions.resourceKind]: /powershell/dsc/reference/schemas/definitions/resourcekind?view=dsc-3.0&preserve-view=true
593+
[schema.metadata]: /powershell/dsc/reference/schemas/metadata/microsoft.dsc/properties?view=dsc-3.0&preserve-view=true
594594

595595
<!-- Issue and PR links -->
596596
[#328]: https://github.com/PowerShell/DSC/issues/328

dsc/docs-conceptual/dsc-3.0/reference/cli/config/export.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description: Command line reference for the 'dsc config export' command
3-
ms.date: 03/25/2025
3+
ms.date: 07/03/2025
44
ms.topic: reference
55
title: dsc config export
66
---
@@ -31,6 +31,18 @@ dsc config export [Options] --input <INPUT>
3131
cat <FILE> | dsc config export [Options] --file -
3232
```
3333

34+
### Configuration document from file with parameters from stdin
35+
36+
```sh
37+
cat <PARAMETERS_FILE> | dsc config --parameters-file - export [Options] --file <FILE>
38+
```
39+
40+
### Configuration document from option string with parameters from stdin
41+
42+
```sh
43+
cat <PARAMETERS_FILE> | dsc config --parameters-file - export [Options] --input <INPUT>
44+
```
45+
3446
## Description
3547

3648
The `export` subcommand generates a configuration document that includes every instance of a set of

dsc/docs-conceptual/dsc-3.0/reference/cli/config/get.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description: Command line reference for the 'dsc config get' command
3-
ms.date: 03/25/2025
3+
ms.date: 07/03/2025
44
ms.topic: reference
55
title: dsc config get
66
---
@@ -31,6 +31,18 @@ dsc config get [Options] --input <INPUT>
3131
cat <FILE> | dsc config get [Options] --file -
3232
```
3333

34+
### Configuration document from file with parameters from stdin
35+
36+
```sh
37+
cat <PARAMETERS_FILE> | dsc config --parameters-file - get [Options] --file <FILE>
38+
```
39+
40+
### Configuration document from option string with parameters from stdin
41+
42+
```sh
43+
cat <PARAMETERS_FILE> | dsc config --parameters-file - get [Options] --input <INPUT>
44+
```
45+
3446
## Description
3547

3648
The `get` subcommand returns the actual state of the resource instances in a configuration

dsc/docs-conceptual/dsc-3.0/reference/cli/config/index.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description: Command line reference for the 'dsc config' command
3-
ms.date: 03/25/2025
3+
ms.date: 07/03/2025
44
ms.topic: reference
55
title: dsc config
66
---
@@ -78,6 +78,11 @@ for that parameter.
7878

7979
This option is mutually exclusive with the `--parameters` option.
8080

81+
Starting with DSC version 3.1.0, you can pass the parameters data to a subcommand over stdin. When
82+
you do, you must pass the configuration document as an input string or the path to a file on the
83+
system. You can't pass both the parameters file and the configuration document to a command from
84+
stdin.
85+
8186
For more information about defining parameters in a configuration document, see
8287
[DSC Configuration document parameter schema][06]. For more information about using parameters in
8388
configuration document, see the [parameters function reference][07].

dsc/docs-conceptual/dsc-3.0/reference/cli/config/set.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description: Command line reference for the 'dsc config set' command
3-
ms.date: 03/25/2025
3+
ms.date: 07/03/2025
44
ms.topic: reference
55
title: dsc config set
66
---
@@ -31,6 +31,19 @@ dsc config set [Options] --input <INPUT>
3131
cat <FILE> | dsc config set [Options] --file -
3232
```
3333

34+
### Configuration document from file with parameters from stdin
35+
36+
```sh
37+
cat <PARAMETERS_FILE> | dsc config --parameters-file - set [Options] --file <FILE>
38+
```
39+
40+
### Configuration document from option string with parameters from stdin
41+
42+
```sh
43+
cat <PARAMETERS_FILE> | dsc config --parameters-file - set [Options] --input <INPUT>
44+
```
45+
46+
3447
## Description
3548

3649
The `set` subcommand enforces the desired state of the resource instances in a configuration
@@ -80,22 +93,22 @@ cat ./example.dsc.config.yaml | dsc config set --file -
8093

8194
<a id="example-2"></a>
8295

83-
The command uses the **path** option to enforce the configuration defined in the
96+
The command uses the **file** option to enforce the configuration defined in the
8497
`example.dsc.config.yaml` file.
8598

8699
```sh
87-
dsc config set --path ./example.dsc.config.yaml
100+
dsc config set --file ./example.dsc.config.yaml
88101
```
89102

90103
### Example 3 - Passing a configuration document as a variable
91104

92105
<a id="example-3"></a>
93106

94-
The command uses the **document** option to enforce the configuration stored in the `$desired`
107+
The command uses the **input** option to enforce the configuration stored in the `$desired`
95108
variable.
96109

97110
```sh
98-
dsc config set --document $desired
111+
dsc config set --input $desired
99112
```
100113

101114
## Options

dsc/docs-conceptual/dsc-3.0/reference/cli/config/test.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description: Command line reference for the 'dsc config test' command
3-
ms.date: 03/25/2025
3+
ms.date: 07/03/2025
44
ms.topic: reference
55
title: dsc config test
66
---
@@ -22,7 +22,7 @@ dsc config test [Options] --file <FILE>
2222
### Configuration document from option string
2323

2424
```sh
25-
dsc config test [Options] --document <INPUT>
25+
dsc config test [Options] --input <INPUT>
2626
```
2727

2828
### Configuration document from stdin
@@ -31,6 +31,18 @@ dsc config test [Options] --document <INPUT>
3131
cat <FILE> | dsc config test [Options] --file -
3232
```
3333

34+
### Configuration document from file with parameters from stdin
35+
36+
```sh
37+
cat <PARAMETERS_FILE> | dsc config --parameters-file - test [Options] --file <FILE>
38+
```
39+
40+
### Configuration document from option string with parameters from stdin
41+
42+
```sh
43+
cat <PARAMETERS_FILE> | dsc config --parameters-file - test [Options] --input <INPUT>
44+
```
45+
3446
## Description
3547

3648
The `test` subcommand verifies whether the resource instances in a configuration document are in
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
description: Command line reference for the 'dsc extension' command
3+
ms.date: 03/25/2025
4+
ms.topic: reference
5+
title: dsc extension
6+
---
7+
8+
# dsc extension
9+
10+
## Synopsis
11+
12+
Operations on DSC extensions.
13+
14+
## Syntax
15+
16+
```sh
17+
dsc extension [Options] <COMMAND>
18+
```
19+
20+
## Description
21+
22+
The `dsc extension` command contains a subcommand for listing DSC extensions.
23+
24+
## Commands
25+
26+
### list
27+
28+
The `list` command returns the list of available DSC extensions with an optional filter. For more
29+
information, see [dsc extension list][01].
30+
31+
### help
32+
33+
The `help` command returns help information for this command or a subcommand.
34+
35+
To get the help for a command or subcommand, use the syntax:
36+
37+
```sh
38+
dsc extension help [<SUBCOMMAND>]
39+
```
40+
41+
For example, `dsc extension help` gets the help for this command. `dsc extension help list`
42+
gets the help for the `list` subcommand.
43+
44+
You can also use the [--help](#--help) option on the command or subcommand to display the help
45+
information. For example, `dsc extension --help` or `dsc extension list --help`.
46+
47+
## Options
48+
49+
### -h, --help
50+
51+
<a id="-h"></a>
52+
<a id="--help"></a>
53+
54+
Displays the help for the current command or subcommand. When you specify this option, the
55+
application ignores all other options and arguments.
56+
57+
```yaml
58+
Type : boolean
59+
Mandatory : false
60+
LongSyntax : --help
61+
ShortSyntax : -h
62+
```
63+
64+
[01]: ./list.md

0 commit comments

Comments
 (0)