diff --git a/CHANGELOG.md b/CHANGELOG.md index 366658eeb..ea39e8ca9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -121,7 +121,7 @@ changes since the last release, see the [diff on GitHub][unreleased]. - Added support for extensions to DSC. You can now use the `dsc extension list` command to enumerate available extensions. DSC now supports a single extension capability, `discover`, which returns JSON objects indicating where to find DSC resource manifests that aren't in the `PATH` or - `DSC_PATH`, as with resources installed as Appx packages. + `DSC_RESOURCE_PATH`, as with resources installed as Appx packages. Now when DSC performs discovery, it recursively discovers extensions and resources on the system. @@ -135,7 +135,7 @@ changes since the last release, see the [diff on GitHub][unreleased]. - [#760][#760] - [#762][#762] -- Addes support for passing parameters to the `dsc config` commands from stdin. You can pass +- Adds support for passing parameters to the `dsc config` commands from stdin. You can pass _either_ the configuration document or parameters file contents to the command from stdin, but not both. This enables securely passing sensitive parameters to DSC without writing them to a file or defining them as an environment variable. diff --git a/docs/reference/cli/config/export.md b/docs/reference/cli/config/export.md index 57546c0c3..cd19a1c7b 100644 --- a/docs/reference/cli/config/export.md +++ b/docs/reference/cli/config/export.md @@ -31,6 +31,18 @@ dsc config export [Options] --input cat | dsc config export [Options] --file - ``` +### Configuration document from file with parameters from stdin + +```sh +cat | dsc config --parameters-file - export [Options] --file +``` + +### Configuration document from option string with parameters from stdin + +```sh +cat | dsc config --parameters-file - export [Options] --input +``` + ## Description The `export` subcommand generates a configuration document that includes every instance of a set of diff --git a/docs/reference/cli/config/get.md b/docs/reference/cli/config/get.md index 3694d36de..3e6181f9a 100644 --- a/docs/reference/cli/config/get.md +++ b/docs/reference/cli/config/get.md @@ -31,6 +31,18 @@ dsc config get [Options] --input cat | dsc config get [Options] --file - ``` +### Configuration document from file with parameters from stdin + +```sh +cat | dsc config --parameters-file - get [Options] --file +``` + +### Configuration document from option string with parameters from stdin + +```sh +cat | dsc config --parameters-file - get [Options] --input +``` + ## Description The `get` subcommand returns the actual state of the resource instances in a configuration diff --git a/docs/reference/cli/config/index.md b/docs/reference/cli/config/index.md index ceb9475e1..0c72b60ed 100644 --- a/docs/reference/cli/config/index.md +++ b/docs/reference/cli/config/index.md @@ -78,6 +78,11 @@ for that parameter. This option is mutually exclusive with the `--parameters` option. +Starting with DSC version 3.1.0, you can pass the parameters data to a subcommand over stdin. When +you do, you must pass the configuration document as an input string or the path to a file on the +system. You can't pass both the parameters file and the configuration document to a command from +stdin. + For more information about defining parameters in a configuration document, see [DSC Configuration document parameter schema][06]. For more information about using parameters in configuration document, see the [parameters function reference][07]. diff --git a/docs/reference/cli/config/set.md b/docs/reference/cli/config/set.md index 54f272fc6..6774e076a 100644 --- a/docs/reference/cli/config/set.md +++ b/docs/reference/cli/config/set.md @@ -31,6 +31,19 @@ dsc config set [Options] --input cat | dsc config set [Options] --file - ``` +### Configuration document from file with parameters from stdin + +```sh +cat | dsc config --parameters-file - set [Options] --file +``` + +### Configuration document from option string with parameters from stdin + +```sh +cat | dsc config --parameters-file - set [Options] --input +``` + + ## Description The `set` subcommand enforces the desired state of the resource instances in a configuration diff --git a/docs/reference/cli/config/test.md b/docs/reference/cli/config/test.md index ea3216bbb..1e98f49dc 100644 --- a/docs/reference/cli/config/test.md +++ b/docs/reference/cli/config/test.md @@ -31,6 +31,18 @@ dsc config test [Options] --input cat | dsc config test [Options] --file - ``` +### Configuration document from file with parameters from stdin + +```sh +cat | dsc config --parameters-file - test [Options] --file +``` + +### Configuration document from option string with parameters from stdin + +```sh +cat | dsc config --parameters-file - test [Options] --input +``` + ## Description The `test` subcommand verifies whether the resource instances in a configuration document are in diff --git a/docs/reference/cli/extension/index.md b/docs/reference/cli/extension/index.md new file mode 100644 index 000000000..63c8f5cb0 --- /dev/null +++ b/docs/reference/cli/extension/index.md @@ -0,0 +1,64 @@ +--- +description: Command line reference for the 'dsc extension' command +ms.date: 03/25/2025 +ms.topic: reference +title: dsc extension +--- + +# dsc extension + +## Synopsis + +Operations on DSC extensions. + +## Syntax + +```sh +dsc extension [Options] +``` + +## Description + +The `dsc extension` command contains a subcommand for listing DSC extensions. + +## Commands + +### list + +The `list` command returns the list of available DSC extensions with an optional filter. For more +information, see [dsc extension list][01]. + +### help + +The `help` command returns help information for this command or a subcommand. + +To get the help for a command or subcommand, use the syntax: + +```sh +dsc extension help [] +``` + +For example, `dsc extension help` gets the help for this command. `dsc extension help list` +gets the help for the `list` subcommand. + +You can also use the [--help](#--help) option on the command or subcommand to display the help +information. For example, `dsc extension --help` or `dsc extension list --help`. + +## Options + +### -h, --help + + + + +Displays the help for the current command or subcommand. When you specify this option, the +application ignores all other options and arguments. + +```yaml +Type : boolean +Mandatory : false +LongSyntax : --help +ShortSyntax : -h +``` + +[01]: ./list.md diff --git a/docs/reference/cli/extension/list.md b/docs/reference/cli/extension/list.md new file mode 100644 index 000000000..bc136d95a --- /dev/null +++ b/docs/reference/cli/extension/list.md @@ -0,0 +1,180 @@ +--- +description: Command line reference for the 'dsc extension list' command +ms.date: 03/25/2025 +ms.topic: reference +title: dsc extension list +--- + +# dsc extension list + +## Synopsis + +Retrieves the list of available DSC extensions with an optional filter. + +## Syntax + +```sh +dsc extension list [Options] +``` + +## Description + +The `list` subcommand searches for available DSC extensions and returns their information. DSC +discovers extensions by first searching the `PATH` or `DSC_RESOURCE_PATH` environment variable for +`.dsc.extension.json`, `.dsc.extension.yml`, and `dsc.extension.yaml` files. For more information +about the environment variables DSC uses, see [Environment variables][01] + +DSC returns the list of discovered extensions with their implementation information and metadata. If +the command includes the `EXTENSION_NAME` argument, DSC filters the list of discovered extensions +before returning them. Filters are always applied after extension discovery. + +## Examples + +### Example 1 - List all extensions + +Without any filters, the command returns every discovered DSC extension. + +```sh +dsc extension list +``` + +```Output +Type Version Capabilities Description +---------------------------------------------------------------------------------------------------------- +Microsoft.Windows.Appx/Discover 0.1.0 d Discovers DSC resources packaged as Appx packages. +``` + +### Example 2 - List a specific extension + +When the `EXTENSION_NAME` argument doesn't include a wildcard, the command returns only the extension +with the specified type name. + +```sh +dsc extension list Microsoft.Windows.Appx/Discover +``` + +```Output +Type Version Capabilities Description +---------------------------------------------------------------------------------------------------------- +Microsoft.Windows.Appx/Discover 0.1.0 d Discovers DSC resources packaged as Appx packages. +``` + +### Example 3 - List extensions with a matching type name + +When the `EXTENSION_NAME` argument includes a wildcard, the command returns every extension with a +matching type name. + +```sh +dsc extension list Microsoft* +``` + +```Output +Type Version Capabilities Description +---------------------------------------------------------------------------------------------------------- +Microsoft.Windows.Appx/Discover 0.1.0 d Discovers DSC resources packaged as Appx packages. +``` + +## Arguments + +### EXTENSION_NAME + +Specifies an optional filter to apply for the type names of discovered DSC extensions. The filter +can include wildcards (`*`). The filter isn't case-sensitive. + +When this argument is specified, DSC filters the results to include only extensions where the +extension type name matches the filter. + +For example, specifying the filter `Microsoft.*` returns only the extensions published by +Microsoft. Specifying the filter `*Windows*` returns any extension with the string `Windows` in its +name, regardless of the casing. + +```yaml +Type : string +Mandatory : false +``` + +## Options + +### -o, --output-format + + + + +The `--output-format` option controls which format DSC uses for the data the command returns. The +available formats are: + +- `json` to emit the data as a [JSON Line][02]. +- `pretty-json` to emit the data as JSON with newlines, indentation, and spaces for readability. +- `yaml` to emit the data as YAML. +- `table-no-truncate` to emit the data as a summary table without truncating each line to the + current console width. + +The default output format depends on whether DSC detects that the output is being redirected or +captured as a variable: + +- If the command isn't being redirected or captured, DSC displays the output as a summary table + described in the [Output](#output) section of this document. +- If the command output is redirected or captured, DSC emits the data as the `json` format to + stdout. + +When you use this option, DSC uses the specified format regardless of whether the command is being +redirected or captured. + +When the command isn't redirected or captured, the output in the console is formatted for improved +readability. When the command isn't redirected or captured, the output includes terminal sequences +for formatting. + +```yaml +Type : string +Mandatory : false +ValidValues : [json, pretty-json, yaml, table-no-truncate] +LongSyntax : --output-format +ShortSyntax : -o +``` + +### -h, --help + + + + +Displays the help for the current command or subcommand. When you specify this option, the +application ignores all other options and arguments. + +```yaml +Type : boolean +Mandatory : false +LongSyntax : --help +ShortSyntax : -h +``` + +## Output + +This command returns a formatted array containing an object for each extension that includes the +extension's type, version, manifest settings, and other metadata. For more information, see +[dsc extension list result schema][03]. + +If the output of the command isn't captured or redirected, it displays in the console by default as +a summary table for the returned extensions. The summary table includes the following columns, +displayed in the listed order: + +- **Type** - The fully qualified type name of the extension. +- **Version** - The semantic version of the extension. +- **Capabilities** - A display of the extension's [capabilities][04] as flags. The capabilities are + displayed in the following order, using a `-` instead of the appropriate letter if the extension + doesn't have a specific capability: + + - `d` indicates that the extension has the [discover capability][05]. + + For example, the `icrosoft.Windows.Appx/Discover` extension has the following capabilities: `d`, + indicating it has the `discover` capability. +- **Description** - The short description of the extension's purpose and usage. + +For more information about the formatting of the output data, see the +[--output-format option](#--output-format). + + +[01]: ../index.md#environment-variables +[02]: https://jsonlines.org/ +[03]: ../../schemas/outputs/extension/list.md +[04]: ../../schemas/outputs/extension/list.md#capabilities +[05]: ../../schemas/outputs/extension/list.md#capability-discover diff --git a/docs/reference/cli/resource/export.md b/docs/reference/cli/resource/export.md index 977977943..628f89c50 100644 --- a/docs/reference/cli/resource/export.md +++ b/docs/reference/cli/resource/export.md @@ -13,15 +13,40 @@ Generates a configuration document that defines the existing instances of a spec ## Syntax +### Without instance properties + ```sh dsc resource export [Options] --resource ``` +### Instance properties from input option + +```sh +dsc resource export --input --resource +``` + +### Instance properties from file + +```sh +dsc resource export --file --resource +``` + +### Instance properties from stdin + +```sh +cat | dsc resource get [Options] --resource --file - +``` + ## Description The `export` subcommand generates a configuration document that includes every instance of a specific resource. The resource must be specified with the `--resource` option. +Starting with DSC 3.1.0, You can use the `--input` or `--file` option to specify a resource +instance to use as a filter for the exported resources. When you do, the specified instance is +passed to the resource for use in filtering. The implementation for filtering depends on each +resource, not DSC itself. + Only specify exportable resources with a resource manifest that defines the [export][01] section in the input configuration. If the specified resource type isn't exportable, DSC raises an error. @@ -48,6 +73,48 @@ LongSyntax : --resource ShortSyntax : -r ``` +### -i, --input + + + + +Specifies the resource instance to use as a filter for exported resource instances. + +The instance must be a string containing a JSON or YAML object. DSC validates the object against +the resource's instance schema. If the validation fails, DSC raises an error. + +This option is mutually exclusive with the `--file` option. + +```yaml +Type : string +Mandatory : false +LongSyntax : --input +ShortSyntax : -i +``` + +### -f, --file + + + + +Defines the path to a file defining the resource instance to use as a filter for exported resource +instances. + +The specified file must contain a JSON or YAML object that represents valid properties for the +resource. DSC validates the object against the resource's instance schema. If the validation fails, +or if the specified file doesn't exist, DSC raises an error. + +You can also use this option to pass an instance from stdin, as shown in [Example 3](#example-3). + +This option is mutually exclusive with the `--input` option. + +```yaml +Type : string +Mandatory : false +LongSyntax : --file +ShortSyntax : -f +``` + ### -o, --output-format diff --git a/docs/reference/cli/resource/get.md b/docs/reference/cli/resource/get.md index 17e6ea7b2..f43a49e00 100644 --- a/docs/reference/cli/resource/get.md +++ b/docs/reference/cli/resource/get.md @@ -237,6 +237,11 @@ available formats are: - `pretty-json` to emit the data as JSON with newlines, indentation, and spaces for readability. - `yaml` to emit the data as YAML. When you use the `--all` option, each instance is returned as a YAML document with the `---` document separator between each returned instance. +- `json-array` to emit the data as a single milti-line JSON array containing each object. This + option is only valid with the [--all option](#--all). +- `pass-through` to return the data from the resource directly without wrapping it in a DSC result. + When you use this output option, the emitted JSON Line adheres to the resource's instance schema, + not the DSC get result schema. The default output format depends on whether DSC detects that the output is being redirected or captured as a variable: @@ -256,7 +261,7 @@ for formatting. ```yaml Type : string Mandatory : false -ValidValues : [json, pretty-json, yaml] +ValidValues : [json, pretty-json, yaml, json-array, pass-through] LongSyntax : --output-format ShortSyntax : -o ``` @@ -280,7 +285,8 @@ ShortSyntax : -h By default, this command returns a formatted data object that includes the actual state of the instance. When the `--all` option is specified, the command returns the formatted data for each -instance. +instance. When you specify the `pass-through` output format option, the emitted data is the +unmodified output from the resource, not a DSC resource get result. For more information about the structure of the output JSON, see [dsc resource get result schema][04]. diff --git a/docs/reference/cli/resource/list.md b/docs/reference/cli/resource/list.md index 8fd6244fd..684a37acb 100644 --- a/docs/reference/cli/resource/list.md +++ b/docs/reference/cli/resource/list.md @@ -245,6 +245,8 @@ available formats are: - `json` to emit the data as a [JSON Line][02]. - `pretty-json` to emit the data as JSON with newlines, indentation, and spaces for readability. - `yaml` to emit the data as YAML. +- `table-no-truncate` to emit the data as a summary table without truncating each line to the + current console width. The default output format depends on whether DSC detects that the output is being redirected or captured as a variable: @@ -264,7 +266,7 @@ for formatting. ```yaml Type : string Mandatory : false -ValidValues : [json, pretty-json, yaml] +ValidValues : [json, pretty-json, yaml, table-no-truncate] LongSyntax : --output-format ShortSyntax : -o ``` diff --git a/docs/reference/resources/Microsoft/Windows/Registry/index.md b/docs/reference/resources/Microsoft/Windows/Registry/index.md index 092aa6974..00ea6ee21 100644 --- a/docs/reference/resources/Microsoft/Windows/Registry/index.md +++ b/docs/reference/resources/Microsoft/Windows/Registry/index.md @@ -167,7 +167,7 @@ The default value for this property when not specified for an instance is `true`
Expand for valueData property metadata ```yaml -Type : object +Type : [object, 'null'] IsRequired : false IsKey : false IsReadOnly : false @@ -179,10 +179,14 @@ MaximumPropertyCount : 1
-Defines the data for the registry value. If specified, this property must be an object with a -single property. The property name defines the data type. The property value defines the data -value. When the instance defines this property, the `valueName` property must also be defined. An -instance that defines `valueData` without `valueName` is invalid. +Defines the data for the registry value. If you specify the `valueName`property without +`valueData`, the resource sets the value to `RZ_NONE`. + +When the instance defines this property, the `valueName` property must also be defined. An instance +that defines `valueData` without `valueName` is invalid. + +If specified, this property must be an object with a single property. The property name defines the +data type. The property value defines the data value. `valueData` has the following properties: @@ -195,8 +199,7 @@ instance that defines `valueData` without `valueName` is invalid. - [DWord](#dword-valuedata) - Defines the value as a 32-bit unsigned integer (`REG_DWORD`). - [QWord](#qword-valuedata) - Defines the value as a 64-bit unsigned integer (`REG_QWORD`). -For more information on registry value data types, see -[Registry value types][09]. +For more information on registry value data types, see [Registry value types][09]. #### String valueData diff --git a/docs/reference/schemas/config/document.md b/docs/reference/schemas/config/document.md index eb378dba8..c41774aae 100644 --- a/docs/reference/schemas/config/document.md +++ b/docs/reference/schemas/config/document.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for a Desired State Configuration document. -ms.date: 02/28/2025 +ms.date: 07/03/2025 ms.topic: reference title: DSC Configuration document schema reference --- @@ -15,7 +15,7 @@ The YAML or JSON file that defines a DSC Configuration. ```yaml SchemaDialect: https://json-schema.org/draft/2020-12/schema -SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/config/document.json +SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/config/document.json Type: object ``` @@ -104,18 +104,42 @@ ValidValues: [ https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/config/document.json https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/config/document.json https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/config/document.vscode.json + https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/config/document.json + https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/bundled/config/document.json + https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/bundled/config/document.vscode.json + https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/config/document.json + https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/bundled/config/document.json + https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/bundled/config/document.vscode.json https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/config/document.json https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/config/document.json https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/config/document.vscode.json + https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/config/document.json + https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/bundled/config/document.json + https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/bundled/config/document.vscode.json + https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/config/document.json + https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/bundled/config/document.json + https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/bundled/config/document.vscode.json https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/config/document.json https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/config/document.json https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/config/document.vscode.json https://aka.ms/dsc/schemas/v3/config/document.json https://aka.ms/dsc/schemas/v3/bundled/config/document.json https://aka.ms/dsc/schemas/v3/bundled/config/document.vscode.json + https://aka.ms/dsc/schemas/v3.1/config/document.json + https://aka.ms/dsc/schemas/v3.1/bundled/config/document.json + https://aka.ms/dsc/schemas/v3.1/bundled/config/document.vscode.json + https://aka.ms/dsc/schemas/v3.1.0/config/document.json + https://aka.ms/dsc/schemas/v3.1.0/bundled/config/document.json + https://aka.ms/dsc/schemas/v3.1.0/bundled/config/document.vscode.json https://aka.ms/dsc/schemas/v3.0/config/document.json https://aka.ms/dsc/schemas/v3.0/bundled/config/document.json https://aka.ms/dsc/schemas/v3.0/bundled/config/document.vscode.json + https://aka.ms/dsc/schemas/v3.0.2/config/document.json + https://aka.ms/dsc/schemas/v3.0.2/bundled/config/document.json + https://aka.ms/dsc/schemas/v3.0.2/bundled/config/document.vscode.json + https://aka.ms/dsc/schemas/v3.0.1/config/document.json + https://aka.ms/dsc/schemas/v3.0.1/bundled/config/document.json + https://aka.ms/dsc/schemas/v3.0.1/bundled/config/document.vscode.json https://aka.ms/dsc/schemas/v3.0.0/config/document.json https://aka.ms/dsc/schemas/v3.0.0/bundled/config/document.json https://aka.ms/dsc/schemas/v3.0.0/bundled/config/document.vscode.json diff --git a/docs/reference/schemas/config/functions/equals.md b/docs/reference/schemas/config/functions/equals.md new file mode 100644 index 000000000..7dad419b9 --- /dev/null +++ b/docs/reference/schemas/config/functions/equals.md @@ -0,0 +1,183 @@ +--- +description: Reference for the 'equals' DSC configuration document function +ms.date: 07/02/2025 +ms.topic: reference +title: equals +--- + +# equals + +## Synopsis + +Checks whether two values are identical. + +## Syntax + +```Syntax +equals() +``` + +## Description + +The `equals()` function checks whether two values are identical, returning `true` if they are and +otherwise `false`. You can use this function to compare two values of the same data type. If the +values are different types, like a string and an integer, DSC returns `false` for this function. + +## Examples + +### Example 1 - Compare two strings + +The following example shows how you can use the function to compare two strings. + +```yaml +# equals.example.1.dsc.config.yaml +$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json +resources: +- name: Compare strings + type: Microsoft.DSC.Debug/Echo + properties: + output: + sameCase: "[equals('a', 'a')]" + differentCase: "[equals('a', 'A')]" + differentLetters: "[equals('a', 'b')]" +``` + +```bash +dsc config get --file equals.example.1.dsc.config.yaml +``` + +```yaml +results: +- name: Compare strings + type: Microsoft.DSC.Debug/Echo + result: + actualState: + output: + sameCase: true + differentCase: false + differentLetters: false +messages: [] +hadErrors: false +``` + +### Example 2 - Compare two integers + +The following example shows how you can use the function to compare two integers. + +```yaml +# equals.example.2.dsc.config.yaml +$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json +resources: +- name: Compare integers + type: Microsoft.DSC.Debug/Echo + properties: + output: + sameInteger: "[equals(1, 1)]" + differentInteger: "[equals(1, 2)]" +``` + +```bash +dsc config get --file equals.example.2.dsc.config.yaml +``` + +```yaml +results: +- name: Compare integers + type: Microsoft.DSC.Debug/Echo + result: + actualState: + output: + sameInteger: true + differentInteger: false + sameFloat: true + differentFloat: false + integerAndFloat: ? +messages: [] +hadErrors: false +``` + +### Example 3 - Compare two arrays + +The following example shows how you can use the function to compare two arrays. + +```yaml +# equals.example.3.dsc.config.yaml +$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json +resources: +- name: Compare arrays + type: Microsoft.DSC.Debug/Echo + properties: + output: + sameStringsAndOrder: >- + [equals( + createArray('a', 'b', 'c'), + createArray('a', 'b', 'c') + )] + sameStringsDifferentOrder: >- + [equals( + createArray('a', 'b', 'c'), + createArray('c', 'b', 'a') + )] + sameNumbers: >- + [equals( + createArray(1, 2, 3), + createArray(1, 2, 3) + )] + sameNestedArrays: >- + [equals( + createArray( + createArray('a', 'b', 'c'), + createArray(1, 2, 3) + ), + createArray( + createArray('a', 'b', 'c'), + createArray(1, 2, 3) + ) + )] +``` + +```bash +dsc config get --file equals.example.3.dsc.config.yaml +``` + +```yaml +results: +- name: Compare arrays + type: Microsoft.DSC.Debug/Echo + result: + actualState: + output: + sameStringsAndOrder: true + sameStringsDifferentOrder: false + sameNumbers: true + sameNestedArrays: true +messages: [] +hadErrors: false +``` + +## Parameters + +### inputValue + +The `equals()` function expects exactly two input values of the same type. Separate each value with +a comma. If the type of the second input value is different from the first value, DSC returns an +error for the function. + +String comparisons are case-sensitive. Array comparisons are position-sensitive. + +```yaml +Type: [integer, string, object, array] +Required: true +MinimumCount: 2 +MaximumCount: 2 +``` + +## Output + +The `equals()` function returns `true` if the input values are the same and otherwise `false`. + +```yaml +Type: bool +``` + + diff --git a/docs/reference/schemas/config/functions/format.md b/docs/reference/schemas/config/functions/format.md index 951c87f5a..8749f5eb6 100644 --- a/docs/reference/schemas/config/functions/format.md +++ b/docs/reference/schemas/config/functions/format.md @@ -21,7 +21,32 @@ format(, , , ...) The `format()` function returns a string that includes formatted values using a template and placeholders. Each placeholder in the template string is replaced with the corresponding argument -value. Placeholders are specified with curly braces around the zero-based index of the argument. +value. + +### Placeholder syntax + +Placeholders must be defined with the following syntax: + +```Syntax +{[:]} +``` + +Every placeholder must specify the zero-based index of the argument. + +This function supports a subset of format specifiers for controlling how data is formatted in the +string. To use a format specifier, define a placeholder followed by a colon and then a specifier. + +The following table defines the supported format specifiers and the data types they're valid for. +If you use a format specifier with an invalid data type, DSC raises an error. + +| Specifier | Format | Valid Types | +|:---------:|:----------------------|:------------| +| `b` | Binary | `integer` | +| `e` | Lowercase exponential | `integer` | +| `E` | Uppercase exponential | `integer` | +| `o` | Octal | `integer` | +| `e` | Lowercase hexadecimal | `integer` | +| `E` | Uppercase hexadecimal | `integer` | ## Examples @@ -54,13 +79,60 @@ messages: [] hadErrors: false ``` -### Example 2 - Format a string with parameters +### Example 2 - Format specifiers -The configuration uses other functions within the `format()` function to build a dynamic message. +This example demonstrates formatting every supported data type and format specifier. ```yaml # format.example.2.dsc.config.yaml $schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json +resources: +- name: descriptive resource name + type: Microsoft.DSC.Debug/Echo + properties: + output: + string: "[format('{0} {1}', 'hello', 'world')]" + boolean: "[format('{0} or {1}', true, false)]" + integer: + binary: "[format('{0} => {0:b}', 123)]" + octal: "[format('{0} => {0:o}', 123)]" + lowercaseHex: "[format('{0} => {0:x}', 123)]" + uppercaseHex: "[format('{0} => {0:X}', 123)]" + lowercaseExponent: "[format('{0} => {0:e}', 123)]" + uppercaseExponent: "[format('{0} => {0:E}', 123)]" +``` + +```bash +dsc config get --file format.example.2.dsc.config.yaml +``` + +```yaml +results: +- name: descriptive resource name + type: Microsoft.DSC.Debug/Echo + result: + actualState: + output: + string: hello world + boolean: true or false + integer: + binary: 1111011 + octal: 173 + lowercaseHex: 7b + uppercaseHex: 7B + lowercaseExponent: 1.23e2 + uppercaseExponent: 1.23E2 +messages: [] +hadErrors: false +``` + +### Example 3 - Format a string with parameters + +The configuration uses other functions within the `format()` function to build a dynamic message. + +```yaml +# format.example.3.dsc.config.yaml +$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json parameters: username: type: string @@ -75,19 +147,22 @@ resources: - name: Echo dynamic formatted string type: Microsoft.DSC.Debug/Echo properties: - output: "[format('Hello, {0}! The time is {1}:{2}.', parameters('username'), parameters('hour'), parameters('minute'))]" + output: >- + [format( + 'Hello, {0}! The time is {1}:{2}.', + parameters('username'), + parameters('hour'), + parameters('minute') + )] ``` ```bash -dsc --file format.example.2.dsc.config.yaml config get +dsc --file format.example.3.dsc.config.yaml config get ``` ```yaml results: -- metadata: - Microsoft.DSC: - duration: PT0.0185508S - name: Echo dynamic formatted string +- name: Echo dynamic formatted string type: Microsoft.DSC.Debug/Echo result: actualState: @@ -101,7 +176,13 @@ hadErrors: false ### formatString The `format()` function requires a template string that includes placeholders for argument values. -Placeholders use the format `{n}`, where `n` is the zero-based index of the argument to insert. + +Placeholders use the zero-based index of the function arguments. You can reference the same +argument any number of times. If DSC can't resolve the placeholder index to an argument, DSC raises +an error. + +For more information about the syntax for defining placeholders, see +[Placeholder syntax](#placeholder-syntax). ```yaml Type: string @@ -112,18 +193,18 @@ MaximumCount: 1 ### arguments -The function accepts one or more arguments of any type to insert into the formatted string. +The function accepts one or more arguments to insert into the formatted string. ```yaml -Type: any +Type: [boolean, integer, string] Required: true MinimumCount: 1 -MaximumCount: unlimited +MaximumCount: 18446744073709551615 ``` ## Output -The `format()` function returns a string where each placeholder in the **formatString** is replaced +The `format()` function returns a string where each placeholder in the `formatString` is replaced with the corresponding argument value. ```yaml diff --git a/docs/reference/schemas/config/functions/if.md b/docs/reference/schemas/config/functions/if.md new file mode 100644 index 000000000..faf1dd7cf --- /dev/null +++ b/docs/reference/schemas/config/functions/if.md @@ -0,0 +1,110 @@ +--- +description: Reference for the 'if' DSC configuration document function +ms.date: 07/02/2025 +ms.topic: reference +title: if +--- + +# if + +## Synopsis + +Returns a value based on whether a condition is true or false. + +## Syntax + +```Syntax +if(, , ) +``` + +## Description + +The `if()` function returns a value based on whether a condition is true or false. You can use this +function to conditionally use different values in a configuration document. + +## Examples + +### Example 1 - Returning values + +This example shows the returning of values when the conditional evaluates to `true` and `false`. + +```yaml +# if.example.1.dsc.config.yaml +$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json +resources: +- name: Show return for true and false + type: Microsoft.DSC.Debug/Echo + properties: + output: + whenTrue: "[if(equals('a', 'a'), 1, 2)]" + whenFalse: "[if(equals('a', 'b'), 1, 2)]" +``` + +```bash +dsc config get --file if.example.1.dsc.config.yaml +``` + +```yaml +results: +- name: Show return for true and false + type: Microsoft.DSC.Debug/Echo + result: + actualState: + output: + whenTrue: 1 + whenFalse: 2 +messages: [] +hadErrors: false +``` + +## Parameters + +### condition + +The `if()` function expects the first parameter to be a boolean value or an expression that +evaluates to a boolean value. When this parameter is `true`, the `if()` function returns the +`trueValue`. When this parameter is `false`, the function returns the `falseValue`. + +```yaml +Type: boolean +Required: true +MinimumCount: 1 +MaximumCount: 1 +``` + +### trueValue + +The `if()` function expects the second parameter to be the value to return when the `condition` +parameter evaluates to `true`. This parameter may be a literal value or an expression that +evaluates to a string, integer, boolean, object, or array value. + +```yaml +Type: [string, int, bool, object, array] +Required: true +MinimumCount: 1 +MaximumCount: 1 +``` + +### falseValue + +The `if()` function expects the third parameter to be the value to return when the `condition` +parameter evaluates to `false`. This parameter may be a literal value or an expression that +evaluates to a string, integer, boolean, object, or array value. + +```yaml +Type: [string, int, bool, object, array] +Required: true +MinimumCount: 1 +MaximumCount: 1 +``` + +## Output + +The function returns either the `trueValue` or `falseValue` depending on whether the `condition` +parameter evaluates to `true` or `false`. + +```yaml +Type: [string, int, bool, object, array] +``` + + diff --git a/docs/reference/schemas/config/metadata.md b/docs/reference/schemas/config/metadata.md index 93250df04..c26bcc549 100644 --- a/docs/reference/schemas/config/metadata.md +++ b/docs/reference/schemas/config/metadata.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for metadata in a Desired State Configuration document. -ms.date: 02/28/2025 +ms.date: 07/03/2025 ms.topic: reference title: DSC Configuration document metadata schema --- @@ -15,7 +15,7 @@ Defines a set of informational key-value pairs for the configuration. ```yaml SchemaDialect: https://json-schema.org/draft/2020-12/schema -SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/config/document.metadata.json +SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/config/document.metadata.json Type: object ``` diff --git a/docs/reference/schemas/config/parameter.md b/docs/reference/schemas/config/parameter.md index e2c8034d1..09cdaec7a 100644 --- a/docs/reference/schemas/config/parameter.md +++ b/docs/reference/schemas/config/parameter.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for a parameter in a Desired State Configuration document. -ms.date: 02/28/2025 +ms.date: 07/03/2025 ms.topic: reference title: DSC Configuration document parameter schema --- @@ -15,7 +15,7 @@ Defines runtime options for a configuration. ```yaml SchemaDialect: https://json-schema.org/draft/2020-12/schema -SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/config/document.parameter.json +SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/config/document.parameter.json Type: object ``` diff --git a/docs/reference/schemas/config/resource.md b/docs/reference/schemas/config/resource.md index 56114eea7..836005057 100644 --- a/docs/reference/schemas/config/resource.md +++ b/docs/reference/schemas/config/resource.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for a resource instance in a Desired State Configuration document. -ms.date: 02/28/2025 +ms.date: 07/03/2025 ms.topic: reference title: DSC Configuration document resource instance schema --- @@ -15,7 +15,7 @@ Defines a DSC Resource instance in a configuration document. ```yaml SchemaDialect: https://json-schema.org/draft/2020-12/schema -SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/config/document.resource.json +SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/config/document.resource.json Type: object ``` diff --git a/docs/reference/schemas/definitions/message.md b/docs/reference/schemas/definitions/message.md index 9075c992a..6b5a3e084 100644 --- a/docs/reference/schemas/definitions/message.md +++ b/docs/reference/schemas/definitions/message.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for a structured message returned from a 'dsc config' command. -ms.date: 02/28/2025 +ms.date: 07/03/2025 ms.topic: reference title: Structured message schema reference --- @@ -15,7 +15,7 @@ A message emitted by a DSC Resource with associated metadata. ```yaml SchemaDialect: https://json-schema.org/draft/2020-12/schema -SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/definitions/message.json +SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/definitions/message.json Type: object ``` diff --git a/docs/reference/schemas/definitions/parameters/dataTypes.md b/docs/reference/schemas/definitions/parameters/dataTypes.md index a61e71078..4d5751ffa 100644 --- a/docs/reference/schemas/definitions/parameters/dataTypes.md +++ b/docs/reference/schemas/definitions/parameters/dataTypes.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for valid parameter data types in a configuration document. -ms.date: 02/28/2025 +ms.date: 07/03/2025 ms.topic: reference title: DSC configuration parameter data type schema reference --- @@ -15,7 +15,7 @@ Defines valid data types for a DSC configuration parameter ```yaml SchemaDialect: https://json-schema.org/draft/2020-12/schema -SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/definitions/parameters/dataTypes.json +SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/definitions/parameters/dataTypes.json Type: string ValidValues: [array, bool, int, object, string, secureobject, securestring] ``` diff --git a/docs/reference/schemas/definitions/resourceKind.md b/docs/reference/schemas/definitions/resourceKind.md index 317462802..d368e4d69 100644 --- a/docs/reference/schemas/definitions/resourceKind.md +++ b/docs/reference/schemas/definitions/resourceKind.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for resource kind -ms.date: 02/28/2025 +ms.date: 07/03/2025 ms.topic: reference title: DSC Resource kind schema reference --- @@ -15,7 +15,7 @@ Identifies whether a resource is an adapter resource, a group resource, or a nor ```yaml SchemaDialect: https://json-schema.org/draft/2020-12/schema -SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/definitions/resourceKind.json +SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/definitions/resourceKind.json Type: string ValidValues: [resource, adapter, group, importer] ``` @@ -28,6 +28,7 @@ DSC supports three kinds of command-based DSC Resources: - `group` - Indicates that the manifest is for a [group resource](#group-resources). - `adapter` - Indicates that the manifest is for an [adapter resource](#adapter-resources). - `importer` - Indicates that the manifest is for an [importer resource](#importer-resources). +- `exporter` - Indicates that the manifest is for an [exporter resource](#exporter-resources). When `kind` isn't defined in the resource manifest, DSC infers the value for the property. If the `adapter` property is defined in the resource manifest, DSC infers the value of `kind` as @@ -73,6 +74,18 @@ manifest. For example, the `Microsoft.DSC/Import` importer resource resolves instances from an external configuration document, enabling you to compose configurations from multiple files. +### Exporter resources + +Exporter resources implement the **Export** operation to return full resource instances for DSC to +recursively export. This allows an exporter resource to help users quickly export the current +configuration of a system without having to know every available resource. + +For example, an exporter resource might discover whether Apache is installed and then return an +instance for every supported resource to fully export the configuration for Apache. + +An exporter resource must always define the [kind][03] and [export][06] properties in the resource +manifest. + ### Nested resource instances The resource instances declared in adapter and group resources or resolved by importer resources @@ -144,7 +157,7 @@ The following matrix defines the relations of each instance in the configuration ### Referencing nested instances Nested resource instances have limitations for the [dependsOn][04] property and the -[reference()][06] configuration function. +[reference()][07] configuration function. 1. You can only reference adjacent instances. You can't reference a nested instance from outside of the instance that declares or resolves it. You can't use a reference to a resource outside of the @@ -386,4 +399,5 @@ resources: [03]: ../resource/manifest/root.md#kind [04]: ../config/resource.md#dependson [05]: ../resource/manifest/resolve.md -[06]: ../config/functions/reference.md +[06]: ../resource/manifest/export.md +[07]: ../config/functions/reference.md diff --git a/docs/reference/schemas/definitions/resourceType.md b/docs/reference/schemas/definitions/resourceType.md index 219284ea7..de466c5a2 100644 --- a/docs/reference/schemas/definitions/resourceType.md +++ b/docs/reference/schemas/definitions/resourceType.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for a resource instance type name -ms.date: 02/28/2025 +ms.date: 07/03/2025 ms.topic: reference title: DSC Resource fully qualified type name schema reference --- @@ -15,7 +15,7 @@ Identifies a DSC Resource. ```yaml SchemaDialect: https://json-schema.org/draft/2020-12/schema -SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/definitions/resourceType.json +SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/definitions/resourceType.json Type: string Pattern: ^\w+(\.\w+){0,2}\/\w+$ ``` diff --git a/docs/reference/schemas/extension/manifest/discover.md b/docs/reference/schemas/extension/manifest/discover.md new file mode 100644 index 000000000..44b70c8ae --- /dev/null +++ b/docs/reference/schemas/extension/manifest/discover.md @@ -0,0 +1,97 @@ +--- +description: JSON schema reference for the 'discover' property in a DSC extension manifest +ms.date: 02/28/2025 +ms.topic: reference +title: DSC extension manifest discover property schema reference +--- + +# DSC extension manifest discover property schema reference + +## Synopsis + +Defines how to retrieve DSC resources not available in `PATH` or `DSC_RESOURCE_PATH`. + +## Metadata + +```yaml +SchemaDialect: https://json-schema.org/draft/2020-12/schema +SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/extension/manifest.discover.json +Type: object +``` + +## Description + +A DSC extension that can enumerate DSC resource not discoverable in the `PATH` or `DSC_RESOURCE_PATH` environment variables +should define the `export` property in its manifest. This property defines how DSC can get the +path to otherwise undiscoverable manifests. + +When the DSC performs discovery for any operation, it calls the command defined by this property. +The extension must return the path to discovered manifests as [JSON lines][05]. Each JSON Line +should be an object representing the instance and validate against the +[DSC extension discover operation stdout schema reference][06]. + +## Required Properties + +The `discover` definition must include these properties: + +- [executable](#executable) + +## Properties + +### executable + +The `executable` property defines the name of the command to run. The value must be the name of a +command discoverable in the system's `PATH` environment variable or the full path to the command. A +file extension is only required when the command isn't recognizable by the operating system as an +executable. + +```yaml +Type: string +Required: true +``` + +### args + +The `args` property defines the list of arguments to pass to the command. The arguments can be any +number of strings. If you want to pass the JSON object representing the property bag for the +extension input to an argument, you can define a single item in the array as a +[JSON object](#json-input-argument), indicating the name of the argument with the `jsonInputArg` +string property and whether the argument is mandatory for the command with the `mandatory` boolean +property. + +```yaml +Type: array +Required: false +Default: [] +Type: [string, object(JSON Input Argument)] +``` + +#### String arguments + +Any item in the argument array can be a string representing a static argument to pass to the +command, like `discover` or `--format`. + +```yaml +Type: string +``` + +#### JSON input argument + +Defines an argument for the command that accepts the JSON input object as a string. DSC passes the +JSON input to the named argument when available. A JSON input argument is defined as a JSON object +with the following properties: + +- `jsonInputArg` (required) - the argument to pass the JSON data to for the command, like `--input`. +- `mandatory` (optional) - Indicate whether DSC should always pass the argument to the command, + even when there's no JSON input for the command. In that case, DSC passes an empty string to the + JSON input argument. + +You can only define one JSON input argument per arguments array. + +```yaml +Type: object +RequiredProperties: [jsonInputArg] +``` + +[05]: https://jsonlines.org/ +[06]: ../stdout/discover.md diff --git a/docs/reference/schemas/extension/manifest/root.md b/docs/reference/schemas/extension/manifest/root.md new file mode 100644 index 000000000..b4e5834b8 --- /dev/null +++ b/docs/reference/schemas/extension/manifest/root.md @@ -0,0 +1,205 @@ +--- +description: JSON schema reference for a DSC extension manifest +ms.date: 02/28/2025 +ms.topic: reference +title: Command-based DSC extension manifest schema reference +--- + +# Command-based DSC extension manifest schema reference + +## Synopsis + +The data file that defines a command-based DSC extension. + +## Metadata + +```yaml +SchemaDialect: https://json-schema.org/draft/2020-12/schema +SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/extension/manifest.json +Type: object +``` + +## Description + +Every command-based DSC Resource must have a manifest. The manifest file must: + +1. Be discoverable in the `PATH` environment variable. +1. Be formatted as either JSON or YAML. +1. Follow the naming convention `.dsc.resource.`. Valid extensions include `json`, + `yml`, and `yaml`. +1. Be valid for the schema described in this document. + +The rest of this document describes the manifest's schema. + +## Required properties + +The manifest must include these properties: + +- [$schema](#schema) +- [type](#type) +- [version](#version) +- [get](#get) + +## Properties + +### $schema + +The `$schema` property indicates the canonical URI of this schema that the manifest validates +against. This property is mandatory. DSC uses this value to validate the manifest against the +correct JSON schema. + +The JSON schemas for DSC are published in multiple versions and forms. This documentation is for +the latest version of the schema. As a convenience, you can specify either the full URI for the +schema hosted in GitHub or use the shorter `aka.ms` URI. You can specify the schema for a specific +semantic version, the latest schema for a minor version, or the latest schema for a major version +of DSC. For more information about schema URIs and versioning, see +[DSC JSON Schema URIs](../../schema-uris.md). + +For every version of the schema, there are three valid urls: + +- `.../extension/manifest.json` + + The URL to the canonical non-bundled schema. When it's used for validation, the validating client + needs to retrieve this schema and every schema it references. + +- `.../bundled/extension/manifest.json` + + The URL to the canonically bundled schema. When it's used for validation, the validating client + only needs to retrieve this schema. + + This schema uses the bundling model introduced for JSON Schema 2020-12. While DSC can still + validate the document when it uses this schema, other tools may error or behave in unexpected + ways if they don't fully support the 2020-12 specification. + +- `.../bundled/extension/manifest.vscode.json` + + The URL to the enhanced authoring schema. This schema is much larger than the other schemas, as + it includes additional definitions that provide contextual help and snippets that the others + don't include. + + This schema uses keywords that are only recognized by VS Code. While DSC can still validate the + document when it uses this schema, other tools may error or behave in unexpected ways. + +```yaml +Type: string +Required: true +Format: URI +ValidValues: [ + https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/extension/manifest.json + https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/extension/manifest.json + https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/extension/manifest.vscode.json + https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/extension/manifest.json + https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/bundled/extension/manifest.json + https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/bundled/extension/manifest.vscode.json + https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/extension/manifest.json + https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/bundled/extension/manifest.json + https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/bundled/extension/manifest.vscode.json + https://aka.ms/dsc/schemas/v3/extension/manifest.json + https://aka.ms/dsc/schemas/v3/bundled/extension/manifest.json + https://aka.ms/dsc/schemas/v3/bundled/extension/manifest.vscode.json + https://aka.ms/dsc/schemas/v3.1/extension/manifest.json + https://aka.ms/dsc/schemas/v3.1/bundled/extension/manifest.json + https://aka.ms/dsc/schemas/v3.1/bundled/extension/manifest.vscode.json + https://aka.ms/dsc/schemas/v3.1.0/extension/manifest.json + https://aka.ms/dsc/schemas/v3.1.0/bundled/extension/manifest.json + https://aka.ms/dsc/schemas/v3.1.0/bundled/extension/manifest.vscode.json + ] +``` + +### type + +The `type` property represents the fully qualified type name of the extension. For more information +about extension type names, see [DSC extension fully qualified type name schema reference][01]. + +```yaml +Type: string +Required: true +Pattern: ^\w+(\.\w+){0,3}\/\w+$ +``` + +### version + +The `version` property must be the current version of the extension as a valid semantic version +(semver) string. + +```yaml +Type: string +Required: true +Pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$ +``` + +### description + +The `description` property defines a synopsis for the extension's purpose. The value for this +property must be a short string. + +```yaml +Type: string +Required: false +``` + +### tags + +The `tags` property defines a list of searchable terms for the extension. The value of this +property must be an array of strings. Each tag must contain only alphanumeric characters and +underscores. No other characters are permitted. Each tag must be unique. + +```yaml +Type: array +Required: false +ItemsMustBeUnique: true +ItemsType: string +ItemsPattern: ^\w+$ +``` + +### discover + +The `discover` property defines how to call the extension to discover DSC resources that aren't +available in the `PATH` or `DSC_RESOURCE_PATH` environment variables. When this property is +defined, DSC invokes the `discover` operation for the extension during the resource discovery phase +of any `dsc config` or `dsc resource` command. + +The value of this property must be an object. The object's `executable` property, defining the name +of the command to call, is mandatory. The `args` property is optional. For more +information, see [DSC extension manifest discover property schema reference][02]. + +```yaml +Type: object +Required: true +``` + +### exitCodes + +The `exitCodes` property defines a set of valid exit codes for the extension and their meaning. +Define this property as a set of key-value pairs where: + +- The key is a string containing a signed integer that maps to a known exit code for the extension. + The exit code must be a literal signed integer. You can't use alternate formats for the exit + code. For example, instead of the hexadecimal value `0x80070005` for "Access denied", specify the + exit code as `-2147024891`. +- The value is a string describing the semantic meaning of that exit code for a human reader. + +DSC interprets exit code `0` as a successful operation and any other exit code as an error. + +> [!TIP] +> If you're authoring your extension manifest in yaml, be sure to wrap the exit code in single +> quotes to ensure the YAML file can be parsed correctly. For example: +> +> ```yaml +> exitCodes: +> '0': Success +> '1': Invalid parameter +> '2': Invalid input +> '3': Registry error +> '4': JSON serialization failed +> ``` + +```yaml +Type: object +Required: false +PropertyNamePattern: ^-?[0-9]+# +PropertyValueType: string +``` + +[01]: ../../definitions/extensionType.md +[02]: discover.md diff --git a/docs/reference/schemas/extension/stdout/discover.md b/docs/reference/schemas/extension/stdout/discover.md new file mode 100644 index 000000000..fc33b89d6 --- /dev/null +++ b/docs/reference/schemas/extension/stdout/discover.md @@ -0,0 +1,49 @@ +--- +description: JSON schema reference for the 'discover' property in a DSC extension manifest +ms.date: 02/28/2025 +ms.topic: reference +title: DSC extension discover operation stdout schema reference +--- + +# DSC extension discover operation stdout schema reference + +## Synopsis + +Represents the path to a manifest not discoverable in the `PATH` or `DSC_RESOURCE_PATH` environment +variables. + +## Metadata + +```yaml +SchemaDialect: https://json-schema.org/draft/2020-12/schema +SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/extension/stdout/discover.json +Type: object +``` + +## Description + +Represents the actual state of a resource instance in DSCpath to a discovered DSC resource or +extension manifest on the system. DSC expects every JSON Line emitted to stdout for the +**Discover** operation to adhere to this schema. + +The output must be a JSON object. The object must define the full path to the discovered manifest. +If an extension returns JSON that is invalid against this schema, DSC raises an error. + +## Required Properties + +The output for the `discover` operation must include these properties: + +- [manifestPath](#manifestpath) + +## Properties + +### manifestPath + +The value for this property must be the absolute path to a manifest file on the system. The +manifest can be for a DSC resource or extension. If the returned path doesn't exist, DSC raises an +error. + +```yaml +Type: string +Required: true +``` diff --git a/docs/reference/schemas/metadata/Microsoft.DSC/properties.md b/docs/reference/schemas/metadata/Microsoft.DSC/properties.md index 5e8bc74dd..827f3096b 100644 --- a/docs/reference/schemas/metadata/Microsoft.DSC/properties.md +++ b/docs/reference/schemas/metadata/Microsoft.DSC/properties.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for the metadata field Microsoft.DSC -ms.date: 02/28/2025 +ms.date: 07/03/2025 ms.topic: reference title: Microsoft.DSC metadata property schema reference --- @@ -26,7 +26,7 @@ For example, `PT0.611216S` represents a duration of about `0.61` seconds. ```yaml SchemaDialect: https://json-schema.org/draft/2020-12/schema -SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/metadata/Microsoft.DSC/duration.json +SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/metadata/Microsoft.DSC/duration.json Type: string Format: duration ``` @@ -40,7 +40,7 @@ For example: `2024-04-14T08:49:51.395686600-07:00` ```yaml SchemaDialect: https://json-schema.org/draft/2020-12/schema -SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/metadata/Microsoft.DSC/endDateTime.json +SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/metadata/Microsoft.DSC/endDateTime.json Type: string Format: date-time ``` @@ -53,7 +53,7 @@ this value is `WhatIf` when DSC is invoked with the `--whatIf` argument. ```yaml SchemaDialect: https://json-schema.org/draft/2020-12/schema -SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/metadata/Microsoft.DSC/executionType.json +SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/metadata/Microsoft.DSC/executionType.json Type: string ValidValues: [Actual, WhatIf] ``` @@ -65,7 +65,7 @@ Defines the operation that DSC applied to the configuration document: `Get`, `Se ```yaml SchemaDialect: https://json-schema.org/draft/2020-12/schema -SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/metadata/Microsoft.DSC/operation.json +SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/metadata/Microsoft.DSC/operation.json Type: string ValidValues: [Get, Set, Test, Export] ``` @@ -79,7 +79,7 @@ non-elevated session. ```yaml SchemaDialect: https://json-schema.org/draft/2020-12/schema -SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/metadata/Microsoft.DSC/securityContext.json +SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/metadata/Microsoft.DSC/securityContext.json Type: string ValidValues: [Current, Elevated, Restricted] ``` @@ -93,7 +93,7 @@ For example: `2024-04-14T08:49:51.395686600-07:00` ```yaml SchemaDialect: https://json-schema.org/draft/2020-12/schema -SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/metadata/Microsoft.DSC/startDatetime.json +SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/metadata/Microsoft.DSC/startDatetime.json Type: string Format: date-time ``` @@ -105,7 +105,7 @@ DSC command, like `3.0.0-preview.7`. ```yaml SchemaDialect: https://json-schema.org/draft/2020-12/schema -SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/metadata/Microsoft.DSC/version.json +SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/metadata/Microsoft.DSC/version.json Type: object ``` diff --git a/docs/reference/schemas/outputs/config/get.md b/docs/reference/schemas/outputs/config/get.md index 631f4e98d..222f88934 100644 --- a/docs/reference/schemas/outputs/config/get.md +++ b/docs/reference/schemas/outputs/config/get.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for the data returned by the 'dsc config get' command. -ms.date: 02/28/2025 +ms.date: 07/03/2025 ms.topic: reference title: dsc config get result schema reference --- @@ -15,7 +15,7 @@ The result output from the `dsc config get` command. ```yaml SchemaDialect: https://json-schema.org/draft/2020-12/schema -SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/outputs/config/get.json +SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/outputs/config/get.json Type: object ``` diff --git a/docs/reference/schemas/outputs/config/set.md b/docs/reference/schemas/outputs/config/set.md index 5407bbff2..dac249178 100644 --- a/docs/reference/schemas/outputs/config/set.md +++ b/docs/reference/schemas/outputs/config/set.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for the data returned by the 'dsc config set' command. -ms.date: 02/28/2025 +ms.date: 07/03/2025 ms.topic: reference title: dsc config set result schema reference --- @@ -15,7 +15,7 @@ The result output from the `dsc config set` command. ```yaml SchemaDialect: https://json-schema.org/draft/2020-12/schema -SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/outputs/config/set.json +SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/outputs/config/set.json Type: object ``` diff --git a/docs/reference/schemas/outputs/config/test.md b/docs/reference/schemas/outputs/config/test.md index f58936072..df64e67fa 100644 --- a/docs/reference/schemas/outputs/config/test.md +++ b/docs/reference/schemas/outputs/config/test.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for the data returned by the 'dsc config test' command. -ms.date: 02/28/2025 +ms.date: 07/03/2025 ms.topic: reference title: dsc config test result schema reference --- @@ -15,7 +15,7 @@ The result output from the `dsc config test` command. ```yaml SchemaDialect: https://json-schema.org/draft/2020-12/schema -SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/outputs/config/test.json +SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/outputs/config/test.json Type: object ``` diff --git a/docs/reference/schemas/outputs/extension/list.md b/docs/reference/schemas/outputs/extension/list.md new file mode 100644 index 000000000..988013d40 --- /dev/null +++ b/docs/reference/schemas/outputs/extension/list.md @@ -0,0 +1,134 @@ +--- +description: JSON schema reference for the data returned by the 'dsc extension list' command. +ms.date: 02/28/2025 +ms.topic: reference +title: dsc extension list result schema reference +--- + +# dsc extension list result schema reference + +## Synopsis + +The result output from the `dsc extension list` command. + +## Metadata + +```yaml +SchemaDialect: https://json-schema.org/draft/2020-12/schema +SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/outputs/extension/list.json +Type: object +``` + +## Description + +The output from the `dsc extension list` command includes a representation of discovered DSC +extensions as a series of [JSON Lines][01]. This schema describes the JSON object returned for each +extension. + +## Required properties + +Each extension in the output always includes these properties: + +- [type](#type) +- [version](#version) +- [path](#path) +- [directory](#directory) +- [author](#author) +- [manifest](#manifest) + +## Properties + +### type + +Identifies the fully qualified type name of the extension. For more information about extension type names, see +[DSC extension fully qualified type name schema reference][02]. + +```yaml +Type: string +Required: true +Pattern: ^\w+(\.\w+){0,2}\/\w+$ +``` + +### version + +Represents the current version of the extension as a valid semantic version (semver) string. + +```yaml +Type: string +Required: true +Pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$ +``` + +### capabilities + +Defines the operations and behaviors the extension is implemented to support. This property is an +array of capabilities. + +The following list describes the available capabilities for an extension: + +- `discover` - The extension supports finding DSC resource + manifests that aren't in the `PATH` or `DSC_RESOURCE_PATH`, as with resources installed as Appx + packages. + +```yaml +Type: array +Required: true +ItemsMustBeUnique: true +ItemsType: string +ItemsValidValues: [ + discover + ] +``` + +### description + +Defines a synopsis for the extension's purpose as a short string. If the extension doesn't have a +description, this property is `null`. + +```yaml +Type: [string, 'null'] +Required: true +``` + +### path + +Represents the path to the extension's manifest on the machine. + +```yaml +Type: string +Required: true +``` + +### directory + +Represents the path to the folder containing the extension's manifest on the machine. + +```yaml +Type: string +Required: true +``` + +### author + +Indicates the name of the person or organization that developed and maintains the DSC extension. If +this property is `null`, the author is unknown. + +```yaml +Type: [string, 'null'] +Required: true +``` + +### manifest + +Represents the values defined in the extension's manifest. For more information on the value for +this property, see [Command-based DSC extension manifest schema reference][03]. + +```yaml +Type: [object] +Required: true +``` + + +[01]: https://jsonlines.org/ +[02]: ../../definitions/extensionType.md +[03]: ../../extension/manifest/root.md diff --git a/docs/reference/schemas/outputs/resource/get.md b/docs/reference/schemas/outputs/resource/get.md index b6fb41909..093a10a93 100644 --- a/docs/reference/schemas/outputs/resource/get.md +++ b/docs/reference/schemas/outputs/resource/get.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for the data returned by the 'dsc resource get' command. -ms.date: 02/28/2025 +ms.date: 07/03/2025 ms.topic: reference title: dsc resource get result schema reference --- @@ -15,7 +15,7 @@ The result output from the `dsc resource get` command. ```yaml SchemaDialect: https://json-schema.org/draft/2020-12/schema -SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/outputs/resource/get.json +SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/outputs/resource/get.json Type: object ``` diff --git a/docs/reference/schemas/outputs/resource/list.md b/docs/reference/schemas/outputs/resource/list.md index 68c4b4cc9..bff9b9635 100644 --- a/docs/reference/schemas/outputs/resource/list.md +++ b/docs/reference/schemas/outputs/resource/list.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for the data returned by the 'dsc resource list' command. -ms.date: 02/28/2025 +ms.date: 07/03/2025 ms.topic: reference title: dsc resource list result schema reference --- @@ -15,7 +15,7 @@ The result output from the `dsc resource list` command. ```yaml SchemaDialect: https://json-schema.org/draft/2020-12/schema -SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/outputs/resource/list.json +SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/outputs/resource/list.json Type: object ``` diff --git a/docs/reference/schemas/outputs/resource/set.md b/docs/reference/schemas/outputs/resource/set.md index c1210c7ed..b72ca7a7d 100644 --- a/docs/reference/schemas/outputs/resource/set.md +++ b/docs/reference/schemas/outputs/resource/set.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for the data returned by the 'dsc resource set' command. -ms.date: 02/28/2025 +ms.date: 07/03/2025 ms.topic: reference title: dsc resource set result schema reference --- @@ -15,7 +15,7 @@ The result output from the `dsc resource set` command. ```yaml SchemaDialect: https://json-schema.org/draft/2020-12/schema -SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/outputs/resource/set.json +SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/outputs/resource/set.json Type: object ``` diff --git a/docs/reference/schemas/outputs/resource/test.md b/docs/reference/schemas/outputs/resource/test.md index 9620c6d91..8f3622fa3 100644 --- a/docs/reference/schemas/outputs/resource/test.md +++ b/docs/reference/schemas/outputs/resource/test.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for the data returned by the 'dsc resource test' command. -ms.date: 02/28/2025 +ms.date: 07/03/2025 ms.topic: reference title: dsc resource test result schema reference --- @@ -15,7 +15,7 @@ The result output from the `dsc resource test` command. ```yaml SchemaDialect: https://json-schema.org/draft/2020-12/schema -SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/outputs/resource/test.json +SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/outputs/resource/test.json Type: object ``` diff --git a/docs/reference/schemas/overview.md b/docs/reference/schemas/overview.md index 076f667a8..2f007b414 100644 --- a/docs/reference/schemas/overview.md +++ b/docs/reference/schemas/overview.md @@ -31,12 +31,17 @@ configuration documents. The article [DSC Configuration document functions reference][04] describes DSC configuration functions generally and links to the reference documentation for the available functions. +## Extension schemas + +The article [DSC command extension manifest schema reference][05] describes the root JSON schema for +extension manifests. + ## Resource schemas -The article [DSC command resource manifest schema reference][05] describes the root JSON schema for +The article [DSC command resource manifest schema reference][06] describes the root JSON schema for resource manifests. -The article [# DSC canonical properties reference][06] describes DSC canonical resource properties +The article [# DSC canonical properties reference][07] describes DSC canonical resource properties generally and links to the reference documentation for the available canonical properties. ## Output schemas @@ -44,15 +49,16 @@ generally and links to the reference documentation for the available canonical p The following table links to the reference documentation for the JSON schemas describing the output DSC returns for its commands: -| Command | Article link | -|:--------------------|:------------------------------------------------------------------------| -| `dsc config get` | [dsc config get result schema reference][07] | -| `dsc config set` | [dsc config set result schema reference][08] | -| `dsc config test` | [dsc config test result schema reference][09] | -| `dsc resource get` | [dsc resource get result schema reference][10] | -| `dsc resource list` | [dsc resource list result schema reference][11] | -| `dsc resource set` | [dsc resource set result schema reference][12] | -| `dsc resource test` | [dsc resource test result schema reference][13] | +| Command | Article link | +|:---------------------|:-------------------------------------------------| +| `dsc config get` | [dsc config get result schema reference][08] | +| `dsc config set` | [dsc config set result schema reference][09] | +| `dsc config test` | [dsc config test result schema reference][10] | +| `dsc extension list` | [dsc extension list result schema reference][11] | +| `dsc resource get` | [dsc resource get result schema reference][12] | +| `dsc resource list` | [dsc resource list result schema reference][13] | +| `dsc resource set` | [dsc resource set result schema reference][14] | +| `dsc resource test` | [dsc resource test result schema reference][15] | ## Definition schemas @@ -60,28 +66,30 @@ The following list defines the reference documentation for JSON schemas included throughout DSC. - For more information about the `Microsoft.DSC` metadata property, see - [Microsoft.DSC metadata property schema reference][14] -- For more information about the messages DSC emits, see [Structured message schema reference][15] + [Microsoft.DSC metadata property schema reference][16] +- For more information about the messages DSC emits, see [Structured message schema reference][17] - For more information about the kinds of DSC resources and how they affect schema validation, see - [DSC Resource kind schema reference][16]. + [DSC Resource kind schema reference][18]. - For more information about the naming of DSC resources and how they're validated, see - [DSC Resource fully qualified type name schema reference][17] + [DSC Resource fully qualified type name schema reference][19] [01]: https://json-schema.org/overview/what-is-jsonschema [02]: ./schema-uris.md [03]: ./config/document.md [04]: ./config/functions/overview.md -[05]: ./resource/manifest/root.md -[06]: ./resource/properties/overview.md -[07]: ./outputs/config/get.md -[08]: ./outputs/config/set.md -[09]: ./outputs/config/test.md -[10]: ./outputs/resource/get.md -[11]: ./outputs/resource/list.md -[12]: ./outputs/resource/set.md -[13]: ./outputs/resource/test.md -[14]: ./metadata/Microsoft.DSC/properties.md -[15]: ./definitions/message.md -[16]: ./definitions/resourceKind.md -[17]: ./definitions/resourceType.md +[05]: ./extension/manifest/root.md +[06]: ./resource/manifest/root.md +[07]: ./resource/properties/overview.md +[08]: ./outputs/config/get.md +[09]: ./outputs/config/set.md +[10]: ./outputs/config/test.md +[11]: ./outputs/extension/list.md +[12]: ./outputs/resource/get.md +[13]: ./outputs/resource/list.md +[14]: ./outputs/resource/set.md +[15]: ./outputs/resource/test.md +[16]: ./metadata/Microsoft.DSC/properties.md +[17]: ./definitions/message.md +[18]: ./definitions/resourceKind.md +[19]: ./definitions/resourceType.md diff --git a/docs/reference/schemas/resource/manifest/adapter.md b/docs/reference/schemas/resource/manifest/adapter.md index 28b5d8e79..64926a33d 100644 --- a/docs/reference/schemas/resource/manifest/adapter.md +++ b/docs/reference/schemas/resource/manifest/adapter.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for the 'adapter' property in a DSC Resource manifest -ms.date: 02/28/2025 +ms.date: 07/03/2025 ms.topic: reference title: DSC Resource manifest adapter property schema reference --- @@ -15,7 +15,7 @@ Defines a DSC Resource as a DSC Resource Adapter. ```yaml SchemaDialect: https://json-schema.org/draft/2020-12/schema -SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/resource/manifest.adapter.json +SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/resource/manifest.adapter.json Type: object ``` diff --git a/docs/reference/schemas/resource/manifest/delete.md b/docs/reference/schemas/resource/manifest/delete.md index 8f9064418..938c4a55c 100644 --- a/docs/reference/schemas/resource/manifest/delete.md +++ b/docs/reference/schemas/resource/manifest/delete.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for the 'delete' property in a DSC Resource manifest -ms.date: 02/28/2025 +ms.date: 07/03/2025 ms.topic: reference title: DSC Resource manifest delete property schema reference --- @@ -15,7 +15,7 @@ Indicates how to call the resource to delete a specific instance. ```yaml SchemaDialect: https://json-schema.org/draft/2020-12/schema -SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/resource/manifest.delete.json +SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/resource/manifest.delete.json Type: object ``` diff --git a/docs/reference/schemas/resource/manifest/export.md b/docs/reference/schemas/resource/manifest/export.md index a9899e6f7..0a98fda5f 100644 --- a/docs/reference/schemas/resource/manifest/export.md +++ b/docs/reference/schemas/resource/manifest/export.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for the 'export' property in a DSC Resource manifest -ms.date: 02/28/2025 +ms.date: 07/03/2025 ms.topic: reference title: DSC Resource manifest export property schema reference --- @@ -15,7 +15,7 @@ Defines how to retrieve the current state of every instance for a DSC Resource. ```yaml SchemaDialect: https://json-schema.org/draft/2020-12/schema -SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/resource/manifest.export.json +SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/resource/manifest.export.json Type: object ``` diff --git a/docs/reference/schemas/resource/manifest/get.md b/docs/reference/schemas/resource/manifest/get.md index c216ed2c8..7ffae514b 100644 --- a/docs/reference/schemas/resource/manifest/get.md +++ b/docs/reference/schemas/resource/manifest/get.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for the 'get' property in a DSC Resource manifest -ms.date: 02/28/2025 +ms.date: 07/03/2025 ms.topic: reference title: DSC Resource manifest get property schema reference --- @@ -15,7 +15,7 @@ Defines how to retrieve a DSC Resource instance. ```yaml SchemaDialect: https://json-schema.org/draft/2020-12/schema -SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/resource/manifest.get.json +SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/resource/manifest.get.json Type: object ``` diff --git a/docs/reference/schemas/resource/manifest/resolve.md b/docs/reference/schemas/resource/manifest/resolve.md index ab76b178f..b53f40ab1 100644 --- a/docs/reference/schemas/resource/manifest/resolve.md +++ b/docs/reference/schemas/resource/manifest/resolve.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for the 'resolve' property in a DSC Resource manifest -ms.date: 02/28/2025 +ms.date: 07/03/2025 ms.topic: reference title: DSC Resource manifest resolve property schema reference --- @@ -16,7 +16,7 @@ source. ```yaml SchemaDialect: https://json-schema.org/draft/2020-12/schema -SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/resource/manifest.resolve.json +SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/resource/manifest.resolve.json Type: object ``` diff --git a/docs/reference/schemas/resource/manifest/root.md b/docs/reference/schemas/resource/manifest/root.md index 28f42694e..bcb47e1e4 100644 --- a/docs/reference/schemas/resource/manifest/root.md +++ b/docs/reference/schemas/resource/manifest/root.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for a DSC Resource manifest -ms.date: 02/28/2025 +ms.date: 07/03/2025 ms.topic: reference title: Command-based DSC Resource manifest schema reference --- @@ -15,7 +15,7 @@ The data file that defines a command-based DSC Resource. ```yaml SchemaDialect: https://json-schema.org/draft/2020-12/schema -SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/resource/manifest.json +SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/resource/manifest.json Type: object ``` @@ -53,7 +53,7 @@ the latest version of the schema. As a convenience, you can specify either the f schema hosted in GitHub or use the shorter `aka.ms` URI. You can specify the schema for a specific semantic version, the latest schema for a minor version, or the latest schema for a major version of DSC. For more information about schema URIs and versioning, see -[DSC JSON Schema URIs](../schema-uris.md). +[DSC JSON Schema URIs](../../schema-uris.md). For every version of the schema, there are three valid urls: @@ -88,18 +88,42 @@ ValidValues: [ https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/resource/manifest.json https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/resource/manifest.json https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/resource/manifest.vscode.json + https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/resource/manifest.json + https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/bundled/resource/manifest.json + https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/bundled/resource/manifest.vscode.json + https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/resource/manifest.json + https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/bundled/resource/manifest.json + https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/bundled/resource/manifest.vscode.json https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/resource/manifest.json https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/resource/manifest.json https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/resource/manifest.vscode.json + https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/resource/manifest.json + https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/bundled/resource/manifest.json + https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/bundled/resource/manifest.vscode.json + https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/resource/manifest.json + https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/bundled/resource/manifest.json + https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/bundled/resource/manifest.vscode.json https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/resource/manifest.json https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/resource/manifest.json https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/resource/manifest.vscode.json https://aka.ms/dsc/schemas/v3/resource/manifest.json https://aka.ms/dsc/schemas/v3/bundled/resource/manifest.json https://aka.ms/dsc/schemas/v3/bundled/resource/manifest.vscode.json + https://aka.ms/dsc/schemas/v3.1/resource/manifest.json + https://aka.ms/dsc/schemas/v3.1/bundled/resource/manifest.json + https://aka.ms/dsc/schemas/v3.1/bundled/resource/manifest.vscode.json + https://aka.ms/dsc/schemas/v3.1.0/resource/manifest.json + https://aka.ms/dsc/schemas/v3.1.0/bundled/resource/manifest.json + https://aka.ms/dsc/schemas/v3.1.0/bundled/resource/manifest.vscode.json https://aka.ms/dsc/schemas/v3.0/resource/manifest.json https://aka.ms/dsc/schemas/v3.0/bundled/resource/manifest.json https://aka.ms/dsc/schemas/v3.0/bundled/resource/manifest.vscode.json + https://aka.ms/dsc/schemas/v3.0.2/resource/manifest.json + https://aka.ms/dsc/schemas/v3.0.2/bundled/resource/manifest.json + https://aka.ms/dsc/schemas/v3.0.2/bundled/resource/manifest.vscode.json + https://aka.ms/dsc/schemas/v3.0.1/resource/manifest.json + https://aka.ms/dsc/schemas/v3.0.1/bundled/resource/manifest.json + https://aka.ms/dsc/schemas/v3.0.1/bundled/resource/manifest.vscode.json https://aka.ms/dsc/schemas/v3.0.0/resource/manifest.json https://aka.ms/dsc/schemas/v3.0.0/bundled/resource/manifest.json https://aka.ms/dsc/schemas/v3.0.0/bundled/resource/manifest.vscode.json diff --git a/docs/reference/schemas/resource/manifest/schema/embedded.md b/docs/reference/schemas/resource/manifest/schema/embedded.md index 7d89026e4..f49617b69 100644 --- a/docs/reference/schemas/resource/manifest/schema/embedded.md +++ b/docs/reference/schemas/resource/manifest/schema/embedded.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for the embedded instance schema in a DSC Resource manifest -ms.date: 02/28/2025 +ms.date: 07/03/2025 ms.topic: reference title: DSC Resource manifest embedded schema reference --- @@ -15,7 +15,7 @@ Defines a JSON Schema that validates a DSC Resource instance. ```yaml SchemaDialect: https://json-schema.org/draft/2020-12/schema -SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/resource/manifest.schema.json#/properties/embedded +SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/resource/manifest.schema.json#/properties/embedded Type: object ``` @@ -107,7 +107,7 @@ If defined, this property must be a reference to the schema for the canonical pr ```json "_exist": { - "$ref": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/resource/properties/exist.json" + "$ref": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/resource/properties/exist.json" } ``` @@ -123,7 +123,7 @@ If defined, this property must be a reference to the schema for the canonical pr ```json "_inDesiredState": { - "$ref": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/resource/properties/inDesiredState.json" + "$ref": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/resource/properties/inDesiredState.json" } ``` @@ -139,7 +139,7 @@ If defined, this property must be a reference to the schema for the canonical pr ```json "_purge": { - "$ref": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/resource/properties/purge.json" + "$ref": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/resource/properties/purge.json" } ``` @@ -155,7 +155,7 @@ If defined, this property must be a reference to the schema for the canonical pr ```json "_rebootRequested": { - "$ref": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/resource/properties/rebootRequested.json" + "$ref": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/resource/properties/rebootRequested.json" } ``` diff --git a/docs/reference/schemas/resource/manifest/schema/property.md b/docs/reference/schemas/resource/manifest/schema/property.md index addd800ba..8a0bb87f2 100644 --- a/docs/reference/schemas/resource/manifest/schema/property.md +++ b/docs/reference/schemas/resource/manifest/schema/property.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for the 'schema' property in a DSC Resource manifest -ms.date: 02/28/2025 +ms.date: 07/03/2025 ms.topic: reference title: DSC Resource manifest schema property schema reference --- @@ -15,7 +15,7 @@ Defines how to retrieve the JSON Schema that validates a DSC Resource instance. ```yaml SchemaDialect: https://json-schema.org/draft/2020-12/schema -SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/resource/manifest.schema.json +SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/resource/manifest.schema.json Type: object ``` diff --git a/docs/reference/schemas/resource/manifest/set.md b/docs/reference/schemas/resource/manifest/set.md index f8f7a910a..7a0f9e4a4 100644 --- a/docs/reference/schemas/resource/manifest/set.md +++ b/docs/reference/schemas/resource/manifest/set.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for the 'set' property in a DSC Resource manifest -ms.date: 02/28/2025 +ms.date: 07/03/2025 ms.topic: reference title: DSC Resource manifest set property schema reference --- @@ -15,7 +15,7 @@ Defines how to enforce state for a DSC Resource instance. ```yaml SchemaDialect: https://json-schema.org/draft/2020-12/schema -SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/resource/manifest.set.json +SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/resource/manifest.set.json Type: object ``` diff --git a/docs/reference/schemas/resource/manifest/test.md b/docs/reference/schemas/resource/manifest/test.md index 882132db3..7305b3459 100644 --- a/docs/reference/schemas/resource/manifest/test.md +++ b/docs/reference/schemas/resource/manifest/test.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for the 'test' property in a DSC Resource manifest -ms.date: 02/28/2025 +ms.date: 07/03/2025 ms.topic: reference title: DSC Resource manifest test property schema reference --- @@ -15,7 +15,7 @@ Defines how to test whether a DSC Resource instance is in the desired state. ```yaml SchemaDialect: https://json-schema.org/draft/2020-12/schema -SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/resource/manifest.test.json +SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/resource/manifest.test.json Type: object ``` diff --git a/docs/reference/schemas/resource/manifest/validate.md b/docs/reference/schemas/resource/manifest/validate.md index 0e4f42ff7..449305cb4 100644 --- a/docs/reference/schemas/resource/manifest/validate.md +++ b/docs/reference/schemas/resource/manifest/validate.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for the 'validate' property in a DSC Resource manifest -ms.date: 02/28/2025 +ms.date: 07/03/2025 ms.topic: reference title: DSC Resource manifest validate property schema reference --- @@ -15,7 +15,7 @@ Indicates how to call a group resource to test whether nested instances are vali ```yaml SchemaDialect: https://json-schema.org/draft/2020-12/schema -SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/resource/manifest.validate.json +SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/resource/manifest.validate.json Type: object ``` diff --git a/docs/reference/schemas/resource/manifest/whatif.md b/docs/reference/schemas/resource/manifest/whatif.md index 715d4bbc5..404806d31 100644 --- a/docs/reference/schemas/resource/manifest/whatif.md +++ b/docs/reference/schemas/resource/manifest/whatif.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for the 'whatIf' property in a DSC Resource manifest -ms.date: 02/28/2025 +ms.date: 07/03/2025 ms.topic: reference title: DSC Resource manifest whatIf property schema reference --- @@ -15,7 +15,7 @@ Defines how to indicate whether and how the set command will modify an instance. ```yaml SchemaDialect: https://json-schema.org/draft/2020-12/schema -SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/resource/manifest.whatIf.json +SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/resource/manifest.whatIf.json Type: object ``` diff --git a/docs/reference/schemas/resource/properties/exist.md b/docs/reference/schemas/resource/properties/exist.md index 7543ce22e..1bd6c29f9 100644 --- a/docs/reference/schemas/resource/properties/exist.md +++ b/docs/reference/schemas/resource/properties/exist.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for the '_exist' canonical DSC Resource property. -ms.date: 02/28/2025 +ms.date: 07/03/2025 ms.topic: reference title: DSC Resource _exist property schema --- @@ -15,7 +15,7 @@ Indicates whether an instance should exist. ```yaml SchemaDialect: https://json-schema.org/draft/2020-12/schema -SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/resource/properties/exist.json +SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/resource/properties/exist.json Type: boolean DefaultValue: true ``` @@ -44,7 +44,7 @@ snippet: ```json "_exist": { - "$ref": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/resource/properties/exist.json" + "$ref": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/resource/properties/exist.json" } ``` diff --git a/docs/reference/schemas/resource/properties/inDesiredState.md b/docs/reference/schemas/resource/properties/inDesiredState.md index b3e026ea1..71a17ba94 100644 --- a/docs/reference/schemas/resource/properties/inDesiredState.md +++ b/docs/reference/schemas/resource/properties/inDesiredState.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for the '_inDesiredState' canonical DSC Resource property. -ms.date: 02/28/2025 +ms.date: 07/03/2025 ms.topic: reference title: DSC Resource _inDesiredState property schema --- @@ -15,7 +15,7 @@ Indicates whether an instance is in the desired state. ```yaml SchemaDialect: https://json-schema.org/draft/2020-12/schema -SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/resource/properties/inDesiredState.json +SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/resource/properties/inDesiredState.json Type: [boolean, 'null'] ReadOnly: true ``` @@ -43,7 +43,7 @@ snippet: ```json "_inDesiredState": { - "$ref": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/resource/properties/inDesiredState.json" + "$ref": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/resource/properties/inDesiredState.json" } ``` diff --git a/docs/reference/schemas/resource/properties/purge.md b/docs/reference/schemas/resource/properties/purge.md index 109c13e5b..0874654bc 100644 --- a/docs/reference/schemas/resource/properties/purge.md +++ b/docs/reference/schemas/resource/properties/purge.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for the '_purge' well-known DSC Resource property. -ms.date: 02/28/2025 +ms.date: 07/03/2025 ms.topic: reference title: DSC Resource _purge property schema --- @@ -15,7 +15,7 @@ Indicates that the resource should treat non-defined entries in a list as invali ```yaml SchemaDialect: https://json-schema.org/draft/2020-12/schema -SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/resource/properties/purge.json +SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/resource/properties/purge.json Type: [boolean, 'null'] WriteOnly: true ``` @@ -44,7 +44,7 @@ snippet: ```json "_inDesiredState": { - "$ref": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/resource/properties/purge.json" + "$ref": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/resource/properties/purge.json" } ``` diff --git a/docs/reference/schemas/resource/properties/rebootRequested.md b/docs/reference/schemas/resource/properties/rebootRequested.md index b2288fa1e..a7c0e3a45 100644 --- a/docs/reference/schemas/resource/properties/rebootRequested.md +++ b/docs/reference/schemas/resource/properties/rebootRequested.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for the '_rebootRequested' canonical DSC Resource property. -ms.date: 02/28/2025 +ms.date: 07/03/2025 ms.topic: reference title: DSC Resource _rebootRequested property schema --- @@ -43,7 +43,7 @@ snippet: ```json "_rebootRequested": { - "$ref": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/resource/properties/rebootRequested.json" + "$ref": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/resource/properties/rebootRequested.json" } ``` diff --git a/docs/reference/schemas/schema-uris.md b/docs/reference/schemas/schema-uris.md index f0fae1113..431c11772 100644 --- a/docs/reference/schemas/schema-uris.md +++ b/docs/reference/schemas/schema-uris.md @@ -1,6 +1,6 @@ --- description: Reference for how DSC schemas are versioned and published and the URIs used to retrieve them. -ms.date: 03/25/2025 +ms.date: 07/03/2025 ms.topic: reference title: DSC JSON Schema URIs --- @@ -120,11 +120,11 @@ authoring schema describing a resource manifest is The following table illustrates these differences between schema forms: -| Schema form | Prefix folder | File extension | -|:------------------------|:-------------:|:--------------:| +| Schema form | Prefix folder | File extension | +|:-----------------------|:-------------:|:--------------:| | Canonical (nonbundled) | _None_ | `.json` | -| Canonically bundled | `bundled` | `.json` | -| Enhanced autoring | `bundled` | `.vscode.json` | +| Canonically bundled | `bundled` | `.json` | +| Enhanced autoring | `bundled` | `.vscode.json` | ### Canonical (nonbundled) schemas @@ -193,37 +193,65 @@ of the prefix URI used to retrieve the schema. |:---------------|:--------------------------------------------------------------------------------------------| | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/config/document.json` | | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/config/document.json` | +| `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/config/document.json` | +| `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/config/document.json` | +| `v3.0.2` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/config/document.json` | +| `v3.0.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/config/document.json` | | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/config/document.json` | The following list of tables defines the recognized URIs for the configuration document schema: - Short URIs by version and form: - | Form | Version | Recognized URI | - |:------------------------|:---------|:------------------------------------------------------------------------| + | Form | Version | Recognized URI | + |:-----------------------|:---------|:------------------------------------------------------------------------| + | Canonically bundled | `v3` | `https://aka.ms/dsc/schemas/v3/bundled/config/document.json` | + | Canonically bundled | `v3.1` | `https://aka.ms/dsc/schemas/v3.1/bundled/config/document.json` | + | Canonically bundled | `v3.1.0` | `https://aka.ms/dsc/schemas/v3.1.0/bundled/config/document.json` | + | Canonically bundled | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/bundled/config/document.json` | + | Canonically bundled | `v3.0.2` | `https://aka.ms/dsc/schemas/v3.0.2/bundled/config/document.json` | + | Canonically bundled | `v3.0.1` | `https://aka.ms/dsc/schemas/v3.0.1/bundled/config/document.json` | + | Canonically bundled | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/bundled/config/document.json` | | Canonical (nonbundled) | `v3` | `https://aka.ms/dsc/schemas/v3/config/document.json` | + | Canonical (nonbundled) | `v3.1` | `https://aka.ms/dsc/schemas/v3.1/config/document.json` | + | Canonical (nonbundled) | `v3.1.0` | `https://aka.ms/dsc/schemas/v3.1.0/config/document.json` | | Canonical (nonbundled) | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/config/document.json` | + | Canonical (nonbundled) | `v3.0.2` | `https://aka.ms/dsc/schemas/v3.0.2/config/document.json` | + | Canonical (nonbundled) | `v3.0.1` | `https://aka.ms/dsc/schemas/v3.0.1/config/document.json` | | Canonical (nonbundled) | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/config/document.json` | - | Canonically bundled | `v3` | `https://aka.ms/dsc/schemas/v3/bundled/config/document.json` | - | Canonically bundled | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/bundled/config/document.json` | - | Canonically bundled | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/bundled/config/document.json` | - | Enhanced authoring | `v3` | `https://aka.ms/dsc/schemas/v3/bundled/config/document.vscode.json` | - | Enhanced authoring | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/bundled/config/document.vscode.json` | - | Enhanced authoring | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/bundled/config/document.vscode.json` | + | Enhanced authoring | `v3` | `https://aka.ms/dsc/schemas/v3/bundled/config/document.vscode.json` | + | Enhanced authoring | `v3.1` | `https://aka.ms/dsc/schemas/v3.1/bundled/config/document.vscode.json` | + | Enhanced authoring | `v3.1.0` | `https://aka.ms/dsc/schemas/v3.1.0/bundled/config/document.vscode.json` | + | Enhanced authoring | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/bundled/config/document.vscode.json` | + | Enhanced authoring | `v3.0.2` | `https://aka.ms/dsc/schemas/v3.0.2/bundled/config/document.vscode.json` | + | Enhanced authoring | `v3.0.1` | `https://aka.ms/dsc/schemas/v3.0.1/bundled/config/document.vscode.json` | + | Enhanced authoring | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/bundled/config/document.vscode.json` | - GitHub URIs by version and form: - | Form | Version | Recognized URI | - |:------------------------|:---------|:-----------------------------------------------------------------------------------------------------------| + | Form | Version | Recognized URI | + |:-----------------------|:---------|:-----------------------------------------------------------------------------------------------------------| + | Canonically bundled | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/config/document.json` | + | Canonically bundled | `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/bundled/config/document.json` | + | Canonically bundled | `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/bundled/config/document.json` | + | Canonically bundled | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/config/document.json` | + | Canonically bundled | `v3.0.2` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/bundled/config/document.json` | + | Canonically bundled | `v3.0.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/bundled/config/document.json` | + | Canonically bundled | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/config/document.json` | | Canonical (nonbundled) | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/config/document.json` | + | Canonical (nonbundled) | `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/config/document.json` | + | Canonical (nonbundled) | `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/config/document.json` | | Canonical (nonbundled) | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/config/document.json` | + | Canonical (nonbundled) | `v3.0.2` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/config/document.json` | + | Canonical (nonbundled) | `v3.0.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/config/document.json` | | Canonical (nonbundled) | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/config/document.json` | - | Canonically bundled | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/config/document.json` | - | Canonically bundled | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/config/document.json` | - | Canonically bundled | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/config/document.json` | - | Enhanced authoring | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/config/document.vscode.json` | - | Enhanced authoring | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/config/document.vscode.json` | - | Enhanced authoring | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/config/document.vscode.json` | + | Enhanced authoring | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/config/document.vscode.json` | + | Enhanced authoring | `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/bundled/config/document.vscode.json` | + | Enhanced authoring | `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/bundled/config/document.vscode.json` | + | Enhanced authoring | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/config/document.vscode.json` | + | Enhanced authoring | `v3.0.2` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/bundled/config/document.vscode.json` | + | Enhanced authoring | `v3.0.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/bundled/config/document.vscode.json` | + | Enhanced authoring | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/config/document.vscode.json` | ### Resource manifest schema @@ -234,38 +262,136 @@ the prefix URI used to retrieve the schema. | Version folder | ID | |:---------------|:----------------------------------------------------------------------------------------------| | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/resource/manifest.json` | +| `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/resource/manifest.json` | +| `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/resource/manifest.json` | | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/resource/manifest.json` | +| `v3.0.2` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/resource/manifest.json` | +| `v3.0.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/resource/manifest.json` | | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/resource/manifest.json` | The following list of tables defines the recognized URIs for the resource manifest schema: - Short URIs by version and form: - | Form | Version | Recognized URI | - |:------------------------|:---------|:--------------------------------------------------------------------------| + | Form | Version | Recognized URI | + |:-----------------------|:---------|:--------------------------------------------------------------------------| + | Canonically bundled | `v3` | `https://aka.ms/dsc/schemas/v3/bundled/resource/manifest.json` | + | Canonically bundled | `v3.1` | `https://aka.ms/dsc/schemas/v3.1/bundled/resource/manifest.json` | + | Canonically bundled | `v3.1.0` | `https://aka.ms/dsc/schemas/v3.1.0/bundled/resource/manifest.json` | + | Canonically bundled | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/bundled/resource/manifest.json` | + | Canonically bundled | `v3.0.2` | `https://aka.ms/dsc/schemas/v3.0.2/bundled/resource/manifest.json` | + | Canonically bundled | `v3.0.1` | `https://aka.ms/dsc/schemas/v3.0.1/bundled/resource/manifest.json` | + | Canonically bundled | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/bundled/resource/manifest.json` | | Canonical (nonbundled) | `v3` | `https://aka.ms/dsc/schemas/v3/resource/manifest.json` | + | Canonical (nonbundled) | `v3.1` | `https://aka.ms/dsc/schemas/v3.1/resource/manifest.json` | + | Canonical (nonbundled) | `v3.1.0` | `https://aka.ms/dsc/schemas/v3.1.0/resource/manifest.json` | | Canonical (nonbundled) | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/resource/manifest.json` | + | Canonical (nonbundled) | `v3.0.2` | `https://aka.ms/dsc/schemas/v3.0.2/resource/manifest.json` | + | Canonical (nonbundled) | `v3.0.1` | `https://aka.ms/dsc/schemas/v3.0.1/resource/manifest.json` | | Canonical (nonbundled) | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/resource/manifest.json` | - | Canonically bundled | `v3` | `https://aka.ms/dsc/schemas/v3/bundled/resource/manifest.json` | - | Canonically bundled | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/bundled/resource/manifest.json` | - | Canonically bundled | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/bundled/resource/manifest.json` | - | Enhanced authoring | `v3` | `https://aka.ms/dsc/schemas/v3/bundled/resource/manifest.vscode.json` | - | Enhanced authoring | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/bundled/resource/manifest.vscode.json` | - | Enhanced authoring | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/bundled/resource/manifest.vscode.json` | + | Enhanced authoring | `v3` | `https://aka.ms/dsc/schemas/v3/bundled/resource/manifest.vscode.json` | + | Enhanced authoring | `v3.1` | `https://aka.ms/dsc/schemas/v3.1/bundled/resource/manifest.vscode.json` | + | Enhanced authoring | `v3.1.0` | `https://aka.ms/dsc/schemas/v3.1.0/bundled/resource/manifest.vscode.json` | + | Enhanced authoring | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/bundled/resource/manifest.vscode.json` | + | Enhanced authoring | `v3.0.2` | `https://aka.ms/dsc/schemas/v3.0.2/bundled/resource/manifest.vscode.json` | + | Enhanced authoring | `v3.0.1` | `https://aka.ms/dsc/schemas/v3.0.1/bundled/resource/manifest.vscode.json` | + | Enhanced authoring | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/bundled/resource/manifest.vscode.json` | - GitHub URIs by version and form: - | Form | Version | Recognized URI | - |:------------------------|:---------|:-------------------------------------------------------------------------------------------------------------| + | Form | Version | Recognized URI | + |:-----------------------|:---------|:-------------------------------------------------------------------------------------------------------------| + | Canonically bundled | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/resource/manifest.json` | + | Canonically bundled | `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/bundled/resource/manifest.json` | + | Canonically bundled | `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/bundled/resource/manifest.json` | + | Canonically bundled | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/resource/manifest.json` | + | Canonically bundled | `v3.0.2` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/bundled/resource/manifest.json` | + | Canonically bundled | `v3.0.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/bundled/resource/manifest.json` | + | Canonically bundled | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/resource/manifest.json` | | Canonical (nonbundled) | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/resource/manifest.json` | + | Canonical (nonbundled) | `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/resource/manifest.json` | + | Canonical (nonbundled) | `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/resource/manifest.json` | | Canonical (nonbundled) | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/resource/manifest.json` | + | Canonical (nonbundled) | `v3.0.2` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/resource/manifest.json` | + | Canonical (nonbundled) | `v3.0.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/resource/manifest.json` | | Canonical (nonbundled) | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/resource/manifest.json` | - | Canonically bundled | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/resource/manifest.json` | - | Canonically bundled | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/resource/manifest.json` | - | Canonically bundled | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/resource/manifest.json` | - | Enhanced authoring | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/resource/manifest.vscode.json` | - | Enhanced authoring | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/resource/manifest.vscode.json` | - | Enhanced authoring | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/resource/manifest.vscode.json` | + | Enhanced authoring | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/resource/manifest.vscode.json` | + | Enhanced authoring | `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/bundled/resource/manifest.vscode.json` | + | Enhanced authoring | `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/bundled/resource/manifest.vscode.json` | + | Enhanced authoring | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/resource/manifest.vscode.json` | + | Enhanced authoring | `v3.0.2` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/bundled/resource/manifest.vscode.json` | + | Enhanced authoring | `v3.0.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/bundled/resource/manifest.vscode.json` | + | Enhanced authoring | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/resource/manifest.vscode.json` | + +### Extension manifest schema + +The following table defines the value of the `$id` keyword for each published version of the +extension manifest schema. The `$id` is the same across all forms of the schema and regardless of +the prefix URI used to retrieve the schema. + +| Version folder | ID | +|:---------------|:-----------------------------------------------------------------------------------------------| +| `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/extension/manifest.json` | +| `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/extension/manifest.json` | +| `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/extension/manifest.json` | +| `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/extension/manifest.json` | +| `v3.0.2` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/extension/manifest.json` | +| `v3.0.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/extension/manifest.json` | +| `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/extension/manifest.json` | + +The following list of tables defines the recognized URIs for the resource manifest schema: + +- Short URIs by version and form: + + | Form | Version | Recognized URI | + |:-----------------------|:---------|:---------------------------------------------------------------------------| + | Canonically bundled | `v3` | `https://aka.ms/dsc/schemas/v3/bundled/extension/manifest.json` | + | Canonically bundled | `v3.1` | `https://aka.ms/dsc/schemas/v3.1/bundled/extension/manifest.json` | + | Canonically bundled | `v3.1.0` | `https://aka.ms/dsc/schemas/v3.1.0/bundled/extension/manifest.json` | + | Canonically bundled | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/bundled/extension/manifest.json` | + | Canonically bundled | `v3.0.2` | `https://aka.ms/dsc/schemas/v3.0.2/bundled/extension/manifest.json` | + | Canonically bundled | `v3.0.1` | `https://aka.ms/dsc/schemas/v3.0.1/bundled/extension/manifest.json` | + | Canonically bundled | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/bundled/extension/manifest.json` | + | Canonical (nonbundled) | `v3` | `https://aka.ms/dsc/schemas/v3/extension/manifest.json` | + | Canonical (nonbundled) | `v3.1` | `https://aka.ms/dsc/schemas/v3.1/extension/manifest.json` | + | Canonical (nonbundled) | `v3.1.0` | `https://aka.ms/dsc/schemas/v3.1.0/extension/manifest.json` | + | Canonical (nonbundled) | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/extension/manifest.json` | + | Canonical (nonbundled) | `v3.0.2` | `https://aka.ms/dsc/schemas/v3.0.2/extension/manifest.json` | + | Canonical (nonbundled) | `v3.0.1` | `https://aka.ms/dsc/schemas/v3.0.1/extension/manifest.json` | + | Canonical (nonbundled) | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/extension/manifest.json` | + | Enhanced authoring | `v3` | `https://aka.ms/dsc/schemas/v3/bundled/extension/manifest.vscode.json` | + | Enhanced authoring | `v3.1` | `https://aka.ms/dsc/schemas/v3.1/bundled/extension/manifest.vscode.json` | + | Enhanced authoring | `v3.1.0` | `https://aka.ms/dsc/schemas/v3.1.0/bundled/extension/manifest.vscode.json` | + | Enhanced authoring | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/bundled/extension/manifest.vscode.json` | + | Enhanced authoring | `v3.0.2` | `https://aka.ms/dsc/schemas/v3.0.2/bundled/extension/manifest.vscode.json` | + | Enhanced authoring | `v3.0.1` | `https://aka.ms/dsc/schemas/v3.0.1/bundled/extension/manifest.vscode.json` | + | Enhanced authoring | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/bundled/extension/manifest.vscode.json` | + +- GitHub URIs by version and form: + + | Form | Version | Recognized URI | + |:-----------------------|:---------|:--------------------------------------------------------------------------------------------------------------| + | Canonically bundled | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/extension/manifest.json` | + | Canonically bundled | `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/bundled/extension/manifest.json` | + | Canonically bundled | `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/bundled/extension/manifest.json` | + | Canonically bundled | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/extension/manifest.json` | + | Canonically bundled | `v3.0.2` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/bundled/extension/manifest.json` | + | Canonically bundled | `v3.0.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/bundled/extension/manifest.json` | + | Canonically bundled | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/extension/manifest.json` | + | Canonical (nonbundled) | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/extension/manifest.json` | + | Canonical (nonbundled) | `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/extension/manifest.json` | + | Canonical (nonbundled) | `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/extension/manifest.json` | + | Canonical (nonbundled) | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/extension/manifest.json` | + | Canonical (nonbundled) | `v3.0.2` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/extension/manifest.json` | + | Canonical (nonbundled) | `v3.0.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/extension/manifest.json` | + | Canonical (nonbundled) | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/extension/manifest.json` | + | Enhanced authoring | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/extension/manifest.vscode.json` | + | Enhanced authoring | `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/bundled/extension/manifest.vscode.json` | + | Enhanced authoring | `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/bundled/extension/manifest.vscode.json` | + | Enhanced authoring | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/extension/manifest.vscode.json` | + | Enhanced authoring | `v3.0.2` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/bundled/extension/manifest.vscode.json` | + | Enhanced authoring | `v3.0.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/bundled/extension/manifest.vscode.json` | + | Enhanced authoring | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/extension/manifest.vscode.json` | ### Output schema for dsc config get command @@ -273,41 +399,69 @@ The following table defines the value of the `$id` keyword for each published ve schema for the `dsc config get` command. The `$id` is the same across all forms of the schema and regardless of the prefix URI used to retrieve the schema. -| Version folder | ID | -|:---------------|:----------------------------------------------------------------------------------------------| +| Version folder | ID | +|:---------------|:-----------------------------------------------------------------------------------------------| | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/outputs/config/get.json` | +| `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/outputs/config/get.json` | +| `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/outputs/config/get.json` | | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/outputs/config/get.json` | | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/outputs/config/get.json` | +| `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/outputs/config/get.json` | +| `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/outputs/config/get.json` | The following list of tables defines the recognized URIs for the output schema: - Short URIs by version and form: - | Form | Version | Recognized URI | - |:------------------------|:---------|:--------------------------------------------------------------------------| + | Form | Version | Recognized URI | + |:-----------------------|:---------|:---------------------------------------------------------------------------| + | Canonically bundled | `v3` | `https://aka.ms/dsc/schemas/v3/bundled/outputs/config/get.json` | + | Canonically bundled | `v3.1` | `https://aka.ms/dsc/schemas/v3.1/bundled/outputs/config/get.json` | + | Canonically bundled | `v3.1.0` | `https://aka.ms/dsc/schemas/v3.1.0/bundled/outputs/config/get.json` | + | Canonically bundled | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/bundled/outputs/config/get.json` | + | Canonically bundled | `v3.0.2` | `https://aka.ms/dsc/schemas/v3.0.2/bundled/outputs/config/get.json` | + | Canonically bundled | `v3.0.1` | `https://aka.ms/dsc/schemas/v3.0.1/bundled/outputs/config/get.json` | + | Canonically bundled | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/bundled/outputs/config/get.json` | | Canonical (nonbundled) | `v3` | `https://aka.ms/dsc/schemas/v3/outputs/config/get.json` | + | Canonical (nonbundled) | `v3.1` | `https://aka.ms/dsc/schemas/v3.1/outputs/config/get.json` | + | Canonical (nonbundled) | `v3.1.0` | `https://aka.ms/dsc/schemas/v3.1.0/outputs/config/get.json` | | Canonical (nonbundled) | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/outputs/config/get.json` | + | Canonical (nonbundled) | `v3.0.2` | `https://aka.ms/dsc/schemas/v3.0.2/outputs/config/get.json` | + | Canonical (nonbundled) | `v3.0.1` | `https://aka.ms/dsc/schemas/v3.0.1/outputs/config/get.json` | | Canonical (nonbundled) | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/outputs/config/get.json` | - | Canonically bundled | `v3` | `https://aka.ms/dsc/schemas/v3/bundled/outputs/config/get.json` | - | Canonically bundled | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/bundled/outputs/config/get.json` | - | Canonically bundled | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/bundled/outputs/config/get.json` | - | Enhanced authoring | `v3` | `https://aka.ms/dsc/schemas/v3/bundled/outputs/config/get.vscode.json` | - | Enhanced authoring | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/bundled/outputs/config/get.vscode.json` | - | Enhanced authoring | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/bundled/outputs/config/get.vscode.json` | + | Enhanced authoring | `v3` | `https://aka.ms/dsc/schemas/v3/bundled/outputs/config/get.vscode.json` | + | Enhanced authoring | `v3.1` | `https://aka.ms/dsc/schemas/v3.1/bundled/outputs/config/get.vscode.json` | + | Enhanced authoring | `v3.1.0` | `https://aka.ms/dsc/schemas/v3.1.0/bundled/outputs/config/get.vscode.json` | + | Enhanced authoring | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/bundled/outputs/config/get.vscode.json` | + | Enhanced authoring | `v3.0.2` | `https://aka.ms/dsc/schemas/v3.0.2/bundled/outputs/config/get.vscode.json` | + | Enhanced authoring | `v3.0.1` | `https://aka.ms/dsc/schemas/v3.0.1/bundled/outputs/config/get.vscode.json` | + | Enhanced authoring | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/bundled/outputs/config/get.vscode.json` | - GitHub URIs by version and form: - | Form | Version | Recognized URI | - |:------------------------|:---------|:-------------------------------------------------------------------------------------------------------------| + | Form | Version | Recognized URI | + |:-----------------------|:---------|:--------------------------------------------------------------------------------------------------------------| + | Canonically bundled | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/outputs/config/get.json` | + | Canonically bundled | `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/bundled/outputs/config/get.json` | + | Canonically bundled | `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/bundled/outputs/config/get.json` | + | Canonically bundled | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/outputs/config/get.json` | + | Canonically bundled | `v3.0.2` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/bundled/outputs/config/get.json` | + | Canonically bundled | `v3.0.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/bundled/outputs/config/get.json` | + | Canonically bundled | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/outputs/config/get.json` | | Canonical (nonbundled) | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/outputs/config/get.json` | + | Canonical (nonbundled) | `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/outputs/config/get.json` | + | Canonical (nonbundled) | `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/outputs/config/get.json` | | Canonical (nonbundled) | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/outputs/config/get.json` | + | Canonical (nonbundled) | `v3.0.2` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/outputs/config/get.json` | + | Canonical (nonbundled) | `v3.0.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/outputs/config/get.json` | | Canonical (nonbundled) | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/outputs/config/get.json` | - | Canonically bundled | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/outputs/config/get.json` | - | Canonically bundled | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/outputs/config/get.json` | - | Canonically bundled | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/outputs/config/get.json` | - | Enhanced authoring | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/outputs/config/get.vscode.json` | - | Enhanced authoring | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/outputs/config/get.vscode.json` | - | Enhanced authoring | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/outputs/config/get.vscode.json` | + | Enhanced authoring | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/outputs/config/get.vscode.json` | + | Enhanced authoring | `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/bundled/outputs/config/get.vscode.json` | + | Enhanced authoring | `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/bundled/outputs/config/get.vscode.json` | + | Enhanced authoring | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/outputs/config/get.vscode.json` | + | Enhanced authoring | `v3.0.2` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/bundled/outputs/config/get.vscode.json` | + | Enhanced authoring | `v3.0.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/bundled/outputs/config/get.vscode.json` | + | Enhanced authoring | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/outputs/config/get.vscode.json` | ### Output schema for dsc config set command @@ -315,41 +469,69 @@ The following table defines the value of the `$id` keyword for each published ve schema for the `dsc config set` command. The `$id` is the same across all forms of the schema and regardless of the prefix URI used to retrieve the schema. -| Version folder | ID | -|:---------------|:----------------------------------------------------------------------------------------------| +| Version folder | ID | +|:---------------|:-----------------------------------------------------------------------------------------------| | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/outputs/config/set.json` | +| `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/outputs/config/set.json` | +| `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/outputs/config/set.json` | | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/outputs/config/set.json` | | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/outputs/config/set.json` | +| `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/outputs/config/set.json` | +| `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/outputs/config/set.json` | The following list of tables defines the recognized URIs for the output schema: - Short URIs by version and form: - | Form | Version | Recognized URI | - |:------------------------|:---------|:--------------------------------------------------------------------------| + | Form | Version | Recognized URI | + |:-----------------------|:---------|:---------------------------------------------------------------------------| + | Canonically bundled | `v3` | `https://aka.ms/dsc/schemas/v3/bundled/outputs/config/set.json` | + | Canonically bundled | `v3.1` | `https://aka.ms/dsc/schemas/v3.1/bundled/outputs/config/set.json` | + | Canonically bundled | `v3.1.0` | `https://aka.ms/dsc/schemas/v3.1.0/bundled/outputs/config/set.json` | + | Canonically bundled | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/bundled/outputs/config/set.json` | + | Canonically bundled | `v3.0.2` | `https://aka.ms/dsc/schemas/v3.0.2/bundled/outputs/config/set.json` | + | Canonically bundled | `v3.0.1` | `https://aka.ms/dsc/schemas/v3.0.1/bundled/outputs/config/set.json` | + | Canonically bundled | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/bundled/outputs/config/set.json` | | Canonical (nonbundled) | `v3` | `https://aka.ms/dsc/schemas/v3/outputs/config/set.json` | + | Canonical (nonbundled) | `v3.1` | `https://aka.ms/dsc/schemas/v3.1/outputs/config/set.json` | + | Canonical (nonbundled) | `v3.1.0` | `https://aka.ms/dsc/schemas/v3.1.0/outputs/config/set.json` | | Canonical (nonbundled) | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/outputs/config/set.json` | + | Canonical (nonbundled) | `v3.0.2` | `https://aka.ms/dsc/schemas/v3.0.2/outputs/config/set.json` | + | Canonical (nonbundled) | `v3.0.1` | `https://aka.ms/dsc/schemas/v3.0.1/outputs/config/set.json` | | Canonical (nonbundled) | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/outputs/config/set.json` | - | Canonically bundled | `v3` | `https://aka.ms/dsc/schemas/v3/bundled/outputs/config/set.json` | - | Canonically bundled | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/bundled/outputs/config/set.json` | - | Canonically bundled | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/bundled/outputs/config/set.json` | - | Enhanced authoring | `v3` | `https://aka.ms/dsc/schemas/v3/bundled/outputs/config/set.vscode.json` | - | Enhanced authoring | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/bundled/outputs/config/set.vscode.json` | - | Enhanced authoring | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/bundled/outputs/config/set.vscode.json` | + | Enhanced authoring | `v3` | `https://aka.ms/dsc/schemas/v3/bundled/outputs/config/set.vscode.json` | + | Enhanced authoring | `v3.1` | `https://aka.ms/dsc/schemas/v3.1/bundled/outputs/config/set.vscode.json` | + | Enhanced authoring | `v3.1.0` | `https://aka.ms/dsc/schemas/v3.1.0/bundled/outputs/config/set.vscode.json` | + | Enhanced authoring | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/bundled/outputs/config/set.vscode.json` | + | Enhanced authoring | `v3.0.2` | `https://aka.ms/dsc/schemas/v3.0.2/bundled/outputs/config/set.vscode.json` | + | Enhanced authoring | `v3.0.1` | `https://aka.ms/dsc/schemas/v3.0.1/bundled/outputs/config/set.vscode.json` | + | Enhanced authoring | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/bundled/outputs/config/set.vscode.json` | - GitHub URIs by version and form: - | Form | Version | Recognized URI | - |:------------------------|:---------|:-------------------------------------------------------------------------------------------------------------| + | Form | Version | Recognized URI | + |:-----------------------|:---------|:--------------------------------------------------------------------------------------------------------------| + | Canonically bundled | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/outputs/config/set.json` | + | Canonically bundled | `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/bundled/outputs/config/set.json` | + | Canonically bundled | `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/bundled/outputs/config/set.json` | + | Canonically bundled | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/outputs/config/set.json` | + | Canonically bundled | `v3.0.2` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/bundled/outputs/config/set.json` | + | Canonically bundled | `v3.0.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/bundled/outputs/config/set.json` | + | Canonically bundled | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/outputs/config/set.json` | | Canonical (nonbundled) | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/outputs/config/set.json` | + | Canonical (nonbundled) | `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/outputs/config/set.json` | + | Canonical (nonbundled) | `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/outputs/config/set.json` | | Canonical (nonbundled) | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/outputs/config/set.json` | + | Canonical (nonbundled) | `v3.0.2` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/outputs/config/set.json` | + | Canonical (nonbundled) | `v3.0.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/outputs/config/set.json` | | Canonical (nonbundled) | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/outputs/config/set.json` | - | Canonically bundled | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/outputs/config/set.json` | - | Canonically bundled | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/outputs/config/set.json` | - | Canonically bundled | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/outputs/config/set.json` | - | Enhanced authoring | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/outputs/config/set.vscode.json` | - | Enhanced authoring | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/outputs/config/set.vscode.json` | - | Enhanced authoring | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/outputs/config/set.vscode.json` | + | Enhanced authoring | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/outputs/config/set.vscode.json` | + | Enhanced authoring | `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/bundled/outputs/config/set.vscode.json` | + | Enhanced authoring | `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/bundled/outputs/config/set.vscode.json` | + | Enhanced authoring | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/outputs/config/set.vscode.json` | + | Enhanced authoring | `v3.0.2` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/bundled/outputs/config/set.vscode.json` | + | Enhanced authoring | `v3.0.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/bundled/outputs/config/set.vscode.json` | + | Enhanced authoring | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/outputs/config/set.vscode.json` | ### Output schema for dsc config test command @@ -357,41 +539,139 @@ The following table defines the value of the `$id` keyword for each published ve schema for the `dsc config test` command. The `$id` is the same across all forms of the schema and regardless of the prefix URI used to retrieve the schema. -| Version folder | ID | -|:---------------|:----------------------------------------------------------------------------------------------| +| Version folder | ID | +|:---------------|:------------------------------------------------------------------------------------------------| | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/outputs/config/test.json` | +| `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/outputs/config/test.json` | +| `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/outputs/config/test.json` | | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/outputs/config/test.json` | | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/outputs/config/test.json` | +| `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/outputs/config/test.json` | +| `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/outputs/config/test.json` | The following list of tables defines the recognized URIs for the output schema: - Short URIs by version and form: - | Form | Version | Recognized URI | - |:------------------------|:---------|:--------------------------------------------------------------------------| + | Form | Version | Recognized URI | + |:-----------------------|:---------|:----------------------------------------------------------------------------| + | Canonically bundled | `v3` | `https://aka.ms/dsc/schemas/v3/bundled/outputs/config/test.json` | + | Canonically bundled | `v3.1` | `https://aka.ms/dsc/schemas/v3.1/bundled/outputs/config/test.json` | + | Canonically bundled | `v3.1.0` | `https://aka.ms/dsc/schemas/v3.1.0/bundled/outputs/config/test.json` | + | Canonically bundled | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/bundled/outputs/config/test.json` | + | Canonically bundled | `v3.0.2` | `https://aka.ms/dsc/schemas/v3.0.2/bundled/outputs/config/test.json` | + | Canonically bundled | `v3.0.1` | `https://aka.ms/dsc/schemas/v3.0.1/bundled/outputs/config/test.json` | + | Canonically bundled | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/bundled/outputs/config/test.json` | | Canonical (nonbundled) | `v3` | `https://aka.ms/dsc/schemas/v3/outputs/config/test.json` | + | Canonical (nonbundled) | `v3.1` | `https://aka.ms/dsc/schemas/v3.1/outputs/config/test.json` | + | Canonical (nonbundled) | `v3.1.0` | `https://aka.ms/dsc/schemas/v3.1.0/outputs/config/test.json` | | Canonical (nonbundled) | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/outputs/config/test.json` | + | Canonical (nonbundled) | `v3.0.2` | `https://aka.ms/dsc/schemas/v3.0.2/outputs/config/test.json` | + | Canonical (nonbundled) | `v3.0.1` | `https://aka.ms/dsc/schemas/v3.0.1/outputs/config/test.json` | | Canonical (nonbundled) | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/outputs/config/test.json` | - | Canonically bundled | `v3` | `https://aka.ms/dsc/schemas/v3/bundled/outputs/config/test.json` | - | Canonically bundled | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/bundled/outputs/config/test.json` | - | Canonically bundled | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/bundled/outputs/config/test.json` | - | Enhanced authoring | `v3` | `https://aka.ms/dsc/schemas/v3/bundled/outputs/config/test.vscode.json` | - | Enhanced authoring | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/bundled/outputs/config/test.vscode.json` | - | Enhanced authoring | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/bundled/outputs/config/test.vscode.json` | + | Enhanced authoring | `v3` | `https://aka.ms/dsc/schemas/v3/bundled/outputs/config/test.vscode.json` | + | Enhanced authoring | `v3.1` | `https://aka.ms/dsc/schemas/v3.1/bundled/outputs/config/test.vscode.json` | + | Enhanced authoring | `v3.1.0` | `https://aka.ms/dsc/schemas/v3.1.0/bundled/outputs/config/test.vscode.json` | + | Enhanced authoring | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/bundled/outputs/config/test.vscode.json` | + | Enhanced authoring | `v3.0.2` | `https://aka.ms/dsc/schemas/v3.0.2/bundled/outputs/config/test.vscode.json` | + | Enhanced authoring | `v3.0.1` | `https://aka.ms/dsc/schemas/v3.0.1/bundled/outputs/config/test.vscode.json` | + | Enhanced authoring | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/bundled/outputs/config/test.vscode.json` | - GitHub URIs by version and form: - | Form | Version | Recognized URI | - |:------------------------|:---------|:-------------------------------------------------------------------------------------------------------------| + | Form | Version | Recognized URI | + |:-----------------------|:---------|:---------------------------------------------------------------------------------------------------------------| + | Canonically bundled | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/outputs/config/test.json` | + | Canonically bundled | `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/bundled/outputs/config/test.json` | + | Canonically bundled | `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/bundled/outputs/config/test.json` | + | Canonically bundled | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/outputs/config/test.json` | + | Canonically bundled | `v3.0.2` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/bundled/outputs/config/test.json` | + | Canonically bundled | `v3.0.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/bundled/outputs/config/test.json` | + | Canonically bundled | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/outputs/config/test.json` | | Canonical (nonbundled) | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/outputs/config/test.json` | + | Canonical (nonbundled) | `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/outputs/config/test.json` | + | Canonical (nonbundled) | `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/outputs/config/test.json` | | Canonical (nonbundled) | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/outputs/config/test.json` | + | Canonical (nonbundled) | `v3.0.2` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/outputs/config/test.json` | + | Canonical (nonbundled) | `v3.0.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/outputs/config/test.json` | | Canonical (nonbundled) | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/outputs/config/test.json` | - | Canonically bundled | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/outputs/config/test.json` | - | Canonically bundled | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/outputs/config/test.json` | - | Canonically bundled | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/outputs/config/test.json` | - | Enhanced authoring | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/outputs/config/test.vscode.json` | - | Enhanced authoring | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/outputs/config/test.vscode.json` | - | Enhanced authoring | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/outputs/config/test.vscode.json` | + | Enhanced authoring | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/outputs/config/test.vscode.json` | + | Enhanced authoring | `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/bundled/outputs/config/test.vscode.json` | + | Enhanced authoring | `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/bundled/outputs/config/test.vscode.json` | + | Enhanced authoring | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/outputs/config/test.vscode.json` | + | Enhanced authoring | `v3.0.2` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/bundled/outputs/config/test.vscode.json` | + | Enhanced authoring | `v3.0.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/bundled/outputs/config/test.vscode.json` | + | Enhanced authoring | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/outputs/config/test.vscode.json` | + +### Output schema for dsc extension list command + +The following table defines the value of the `$id` keyword for each published version of the output +schema for the `dsc extension list` command. The `$id` is the same across all forms of the schema +and regardless of the prefix URI used to retrieve the schema. + +| Version folder | ID | +|:---------------|:---------------------------------------------------------------------------------------------------| +| `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/outputs/extension/list.json` | +| `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/outputs/extension/list.json` | +| `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/outputs/extension/list.json` | +| `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/outputs/extension/list.json` | +| `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/outputs/extension/list.json` | +| `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/outputs/extension/list.json` | +| `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/outputs/extension/list.json` | + +The following list of tables defines the recognized URIs for the output schema: + +- Short URIs by version and form: + + | Form | Version | Recognized URI | + |:-----------------------|:---------|:-------------------------------------------------------------------------------| + | Canonically bundled | `v3` | `https://aka.ms/dsc/schemas/v3/bundled/outputs/extension/list.json` | + | Canonically bundled | `v3.1` | `https://aka.ms/dsc/schemas/v3.1/bundled/outputs/extension/list.json` | + | Canonically bundled | `v3.1.0` | `https://aka.ms/dsc/schemas/v3.1.0/bundled/outputs/extension/list.json` | + | Canonically bundled | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/bundled/outputs/extension/list.json` | + | Canonically bundled | `v3.0.2` | `https://aka.ms/dsc/schemas/v3.0.2/bundled/outputs/extension/list.json` | + | Canonically bundled | `v3.0.1` | `https://aka.ms/dsc/schemas/v3.0.1/bundled/outputs/extension/list.json` | + | Canonically bundled | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/bundled/outputs/extension/list.json` | + | Canonical (nonbundled) | `v3` | `https://aka.ms/dsc/schemas/v3/outputs/extension/list.json` | + | Canonical (nonbundled) | `v3.1` | `https://aka.ms/dsc/schemas/v3.1/outputs/extension/list.json` | + | Canonical (nonbundled) | `v3.1.0` | `https://aka.ms/dsc/schemas/v3.1.0/outputs/extension/list.json` | + | Canonical (nonbundled) | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/outputs/extension/list.json` | + | Canonical (nonbundled) | `v3.0.2` | `https://aka.ms/dsc/schemas/v3.0.2/outputs/extension/list.json` | + | Canonical (nonbundled) | `v3.0.1` | `https://aka.ms/dsc/schemas/v3.0.1/outputs/extension/list.json` | + | Canonical (nonbundled) | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/outputs/extension/list.json` | + | Enhanced authoring | `v3` | `https://aka.ms/dsc/schemas/v3/bundled/outputs/extension/list.vscode.json` | + | Enhanced authoring | `v3.1` | `https://aka.ms/dsc/schemas/v3.1/bundled/outputs/extension/list.vscode.json` | + | Enhanced authoring | `v3.1.0` | `https://aka.ms/dsc/schemas/v3.1.0/bundled/outputs/extension/list.vscode.json` | + | Enhanced authoring | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/bundled/outputs/extension/list.vscode.json` | + | Enhanced authoring | `v3.0.2` | `https://aka.ms/dsc/schemas/v3.0.2/bundled/outputs/extension/list.vscode.json` | + | Enhanced authoring | `v3.0.1` | `https://aka.ms/dsc/schemas/v3.0.1/bundled/outputs/extension/list.vscode.json` | + | Enhanced authoring | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/bundled/outputs/extension/list.vscode.json` | + +- GitHub URIs by version and form: + + | Form | Version | Recognized URI | + |:-----------------------|:---------|:------------------------------------------------------------------------------------------------------------------| + | Canonically bundled | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/outputs/extension/list.json` | + | Canonically bundled | `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/bundled/outputs/extension/list.json` | + | Canonically bundled | `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/bundled/outputs/extension/list.json` | + | Canonically bundled | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/outputs/extension/list.json` | + | Canonically bundled | `v3.0.2` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/bundled/outputs/extension/list.json` | + | Canonically bundled | `v3.0.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/bundled/outputs/extension/list.json` | + | Canonically bundled | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/outputs/extension/list.json` | + | Canonical (nonbundled) | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/outputs/extension/list.json` | + | Canonical (nonbundled) | `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/outputs/extension/list.json` | + | Canonical (nonbundled) | `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/outputs/extension/list.json` | + | Canonical (nonbundled) | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/outputs/extension/list.json` | + | Canonical (nonbundled) | `v3.0.2` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/outputs/extension/list.json` | + | Canonical (nonbundled) | `v3.0.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/outputs/extension/list.json` | + | Canonical (nonbundled) | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/outputs/extension/list.json` | + | Enhanced authoring | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/outputs/extension/list.vscode.json` | + | Enhanced authoring | `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/bundled/outputs/extension/list.vscode.json` | + | Enhanced authoring | `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/bundled/outputs/extension/list.vscode.json` | + | Enhanced authoring | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/outputs/extension/list.vscode.json` | + | Enhanced authoring | `v3.0.2` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/bundled/outputs/extension/list.vscode.json` | + | Enhanced authoring | `v3.0.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/bundled/outputs/extension/list.vscode.json` | + | Enhanced authoring | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/outputs/extension/list.vscode.json` | ### Output schema for dsc resource get command @@ -399,41 +679,69 @@ The following table defines the value of the `$id` keyword for each published ve schema for the `dsc resource get` command. The `$id` is the same across all forms of the schema and regardless of the prefix URI used to retrieve the schema. -| Version folder | ID | -|:---------------|:----------------------------------------------------------------------------------------------| +| Version folder | ID | +|:---------------|:-------------------------------------------------------------------------------------------------| | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/outputs/resource/get.json` | +| `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/outputs/resource/get.json` | +| `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/outputs/resource/get.json` | | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/outputs/resource/get.json` | | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/outputs/resource/get.json` | +| `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/outputs/resource/get.json` | +| `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/outputs/resource/get.json` | The following list of tables defines the recognized URIs for the output schema: - Short URIs by version and form: - | Form | Version | Recognized URI | - |:------------------------|:---------|:--------------------------------------------------------------------------| + | Form | Version | Recognized URI | + |:-----------------------|:---------|:-----------------------------------------------------------------------------| + | Canonically bundled | `v3` | `https://aka.ms/dsc/schemas/v3/bundled/outputs/resource/get.json` | + | Canonically bundled | `v3.1` | `https://aka.ms/dsc/schemas/v3.1/bundled/outputs/resource/get.json` | + | Canonically bundled | `v3.1.0` | `https://aka.ms/dsc/schemas/v3.1.0/bundled/outputs/resource/get.json` | + | Canonically bundled | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/bundled/outputs/resource/get.json` | + | Canonically bundled | `v3.0.2` | `https://aka.ms/dsc/schemas/v3.0.2/bundled/outputs/resource/get.json` | + | Canonically bundled | `v3.0.1` | `https://aka.ms/dsc/schemas/v3.0.1/bundled/outputs/resource/get.json` | + | Canonically bundled | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/bundled/outputs/resource/get.json` | | Canonical (nonbundled) | `v3` | `https://aka.ms/dsc/schemas/v3/outputs/resource/get.json` | + | Canonical (nonbundled) | `v3.1` | `https://aka.ms/dsc/schemas/v3.1/outputs/resource/get.json` | + | Canonical (nonbundled) | `v3.1.0` | `https://aka.ms/dsc/schemas/v3.1.0/outputs/resource/get.json` | | Canonical (nonbundled) | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/outputs/resource/get.json` | + | Canonical (nonbundled) | `v3.0.2` | `https://aka.ms/dsc/schemas/v3.0.2/outputs/resource/get.json` | + | Canonical (nonbundled) | `v3.0.1` | `https://aka.ms/dsc/schemas/v3.0.1/outputs/resource/get.json` | | Canonical (nonbundled) | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/outputs/resource/get.json` | - | Canonically bundled | `v3` | `https://aka.ms/dsc/schemas/v3/bundled/outputs/resource/get.json` | - | Canonically bundled | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/bundled/outputs/resource/get.json` | - | Canonically bundled | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/bundled/outputs/resource/get.json` | - | Enhanced authoring | `v3` | `https://aka.ms/dsc/schemas/v3/bundled/outputs/resource/get.vscode.json` | - | Enhanced authoring | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/bundled/outputs/resource/get.vscode.json` | - | Enhanced authoring | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/bundled/outputs/resource/get.vscode.json` | + | Enhanced authoring | `v3` | `https://aka.ms/dsc/schemas/v3/bundled/outputs/resource/get.vscode.json` | + | Enhanced authoring | `v3.1` | `https://aka.ms/dsc/schemas/v3.1/bundled/outputs/resource/get.vscode.json` | + | Enhanced authoring | `v3.1.0` | `https://aka.ms/dsc/schemas/v3.1.0/bundled/outputs/resource/get.vscode.json` | + | Enhanced authoring | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/bundled/outputs/resource/get.vscode.json` | + | Enhanced authoring | `v3.0.2` | `https://aka.ms/dsc/schemas/v3.0.2/bundled/outputs/resource/get.vscode.json` | + | Enhanced authoring | `v3.0.1` | `https://aka.ms/dsc/schemas/v3.0.1/bundled/outputs/resource/get.vscode.json` | + | Enhanced authoring | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/bundled/outputs/resource/get.vscode.json` | - GitHub URIs by version and form: - | Form | Version | Recognized URI | - |:------------------------|:---------|:-------------------------------------------------------------------------------------------------------------| + | Form | Version | Recognized URI | + |:-----------------------|:---------|:----------------------------------------------------------------------------------------------------------------| + | Canonically bundled | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/outputs/resource/get.json` | + | Canonically bundled | `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/bundled/outputs/resource/get.json` | + | Canonically bundled | `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/bundled/outputs/resource/get.json` | + | Canonically bundled | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/outputs/resource/get.json` | + | Canonically bundled | `v3.0.2` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/bundled/outputs/resource/get.json` | + | Canonically bundled | `v3.0.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/bundled/outputs/resource/get.json` | + | Canonically bundled | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/outputs/resource/get.json` | | Canonical (nonbundled) | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/outputs/resource/get.json` | + | Canonical (nonbundled) | `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/outputs/resource/get.json` | + | Canonical (nonbundled) | `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/outputs/resource/get.json` | | Canonical (nonbundled) | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/outputs/resource/get.json` | + | Canonical (nonbundled) | `v3.0.2` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/outputs/resource/get.json` | + | Canonical (nonbundled) | `v3.0.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/outputs/resource/get.json` | | Canonical (nonbundled) | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/outputs/resource/get.json` | - | Canonically bundled | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/outputs/resource/get.json` | - | Canonically bundled | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/outputs/resource/get.json` | - | Canonically bundled | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/outputs/resource/get.json` | - | Enhanced authoring | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/outputs/resource/get.vscode.json` | - | Enhanced authoring | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/outputs/resource/get.vscode.json` | - | Enhanced authoring | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/outputs/resource/get.vscode.json` | + | Enhanced authoring | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/outputs/resource/get.vscode.json` | + | Enhanced authoring | `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/bundled/outputs/resource/get.vscode.json` | + | Enhanced authoring | `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/bundled/outputs/resource/get.vscode.json` | + | Enhanced authoring | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/outputs/resource/get.vscode.json` | + | Enhanced authoring | `v3.0.2` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/bundled/outputs/resource/get.vscode.json` | + | Enhanced authoring | `v3.0.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/bundled/outputs/resource/get.vscode.json` | + | Enhanced authoring | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/outputs/resource/get.vscode.json` | ### Output schema for dsc resource list command @@ -441,41 +749,69 @@ The following table defines the value of the `$id` keyword for each published ve schema for the `dsc resource list` command. The `$id` is the same across all forms of the schema and regardless of the prefix URI used to retrieve the schema. -| Version folder | ID | -|:---------------|:----------------------------------------------------------------------------------------------| +| Version folder | ID | +|:---------------|:--------------------------------------------------------------------------------------------------| | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/outputs/resource/list.json` | +| `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/outputs/resource/list.json` | +| `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/outputs/resource/list.json` | | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/outputs/resource/list.json` | | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/outputs/resource/list.json` | +| `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/outputs/resource/list.json` | +| `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/outputs/resource/list.json` | The following list of tables defines the recognized URIs for the output schema: - Short URIs by version and form: - | Form | Version | Recognized URI | - |:------------------------|:---------|:--------------------------------------------------------------------------| + | Form | Version | Recognized URI | + |:-----------------------|:---------|:------------------------------------------------------------------------------| + | Canonically bundled | `v3` | `https://aka.ms/dsc/schemas/v3/bundled/outputs/resource/list.json` | + | Canonically bundled | `v3.1` | `https://aka.ms/dsc/schemas/v3.1/bundled/outputs/resource/list.json` | + | Canonically bundled | `v3.1.0` | `https://aka.ms/dsc/schemas/v3.1.0/bundled/outputs/resource/list.json` | + | Canonically bundled | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/bundled/outputs/resource/list.json` | + | Canonically bundled | `v3.0.2` | `https://aka.ms/dsc/schemas/v3.0.2/bundled/outputs/resource/list.json` | + | Canonically bundled | `v3.0.1` | `https://aka.ms/dsc/schemas/v3.0.1/bundled/outputs/resource/list.json` | + | Canonically bundled | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/bundled/outputs/resource/list.json` | | Canonical (nonbundled) | `v3` | `https://aka.ms/dsc/schemas/v3/outputs/resource/list.json` | + | Canonical (nonbundled) | `v3.1` | `https://aka.ms/dsc/schemas/v3.1/outputs/resource/list.json` | + | Canonical (nonbundled) | `v3.1.0` | `https://aka.ms/dsc/schemas/v3.1.0/outputs/resource/list.json` | | Canonical (nonbundled) | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/outputs/resource/list.json` | + | Canonical (nonbundled) | `v3.0.2` | `https://aka.ms/dsc/schemas/v3.0.2/outputs/resource/list.json` | + | Canonical (nonbundled) | `v3.0.1` | `https://aka.ms/dsc/schemas/v3.0.1/outputs/resource/list.json` | | Canonical (nonbundled) | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/outputs/resource/list.json` | - | Canonically bundled | `v3` | `https://aka.ms/dsc/schemas/v3/bundled/outputs/resource/list.json` | - | Canonically bundled | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/bundled/outputs/resource/list.json` | - | Canonically bundled | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/bundled/outputs/resource/list.json` | - | Enhanced authoring | `v3` | `https://aka.ms/dsc/schemas/v3/bundled/outputs/resource/list.vscode.json` | - | Enhanced authoring | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/bundled/outputs/resource/list.vscode.json` | - | Enhanced authoring | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/bundled/outputs/resource/list.vscode.json` | + | Enhanced authoring | `v3` | `https://aka.ms/dsc/schemas/v3/bundled/outputs/resource/list.vscode.json` | + | Enhanced authoring | `v3.1` | `https://aka.ms/dsc/schemas/v3.1/bundled/outputs/resource/list.vscode.json` | + | Enhanced authoring | `v3.1.0` | `https://aka.ms/dsc/schemas/v3.1.0/bundled/outputs/resource/list.vscode.json` | + | Enhanced authoring | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/bundled/outputs/resource/list.vscode.json` | + | Enhanced authoring | `v3.0.2` | `https://aka.ms/dsc/schemas/v3.0.2/bundled/outputs/resource/list.vscode.json` | + | Enhanced authoring | `v3.0.1` | `https://aka.ms/dsc/schemas/v3.0.1/bundled/outputs/resource/list.vscode.json` | + | Enhanced authoring | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/bundled/outputs/resource/list.vscode.json` | - GitHub URIs by version and form: - | Form | Version | Recognized URI | - |:------------------------|:---------|:-------------------------------------------------------------------------------------------------------------| + | Form | Version | Recognized URI | + |:-----------------------|:---------|:-----------------------------------------------------------------------------------------------------------------| + | Canonically bundled | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/outputs/resource/list.json` | + | Canonically bundled | `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/bundled/outputs/resource/list.json` | + | Canonically bundled | `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/bundled/outputs/resource/list.json` | + | Canonically bundled | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/outputs/resource/list.json` | + | Canonically bundled | `v3.0.2` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/bundled/outputs/resource/list.json` | + | Canonically bundled | `v3.0.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/bundled/outputs/resource/list.json` | + | Canonically bundled | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/outputs/resource/list.json` | | Canonical (nonbundled) | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/outputs/resource/list.json` | + | Canonical (nonbundled) | `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/outputs/resource/list.json` | + | Canonical (nonbundled) | `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/outputs/resource/list.json` | | Canonical (nonbundled) | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/outputs/resource/list.json` | + | Canonical (nonbundled) | `v3.0.2` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/outputs/resource/list.json` | + | Canonical (nonbundled) | `v3.0.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/outputs/resource/list.json` | | Canonical (nonbundled) | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/outputs/resource/list.json` | - | Canonically bundled | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/outputs/resource/list.json` | - | Canonically bundled | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/outputs/resource/list.json` | - | Canonically bundled | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/outputs/resource/list.json` | - | Enhanced authoring | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/outputs/resource/list.vscode.json` | - | Enhanced authoring | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/outputs/resource/list.vscode.json` | - | Enhanced authoring | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/outputs/resource/list.vscode.json` | + | Enhanced authoring | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/outputs/resource/list.vscode.json` | + | Enhanced authoring | `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/bundled/outputs/resource/list.vscode.json` | + | Enhanced authoring | `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/bundled/outputs/resource/list.vscode.json` | + | Enhanced authoring | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/outputs/resource/list.vscode.json` | + | Enhanced authoring | `v3.0.2` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/bundled/outputs/resource/list.vscode.json` | + | Enhanced authoring | `v3.0.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/bundled/outputs/resource/list.vscode.json` | + | Enhanced authoring | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/outputs/resource/list.vscode.json` | ### Output schema for dsc resource schema command @@ -483,41 +819,69 @@ The following table defines the value of the `$id` keyword for each published ve schema for the `dsc resource schema` command. The `$id` is the same across all forms of the schema and regardless of the prefix URI used to retrieve the schema. -| Version folder | ID | -|:---------------|:----------------------------------------------------------------------------------------------| +| Version folder | ID | +|:---------------|:----------------------------------------------------------------------------------------------------| | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/outputs/resource/schema.json` | +| `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/outputs/resource/schema.json` | +| `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/outputs/resource/schema.json` | | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/outputs/resource/schema.json` | | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/outputs/resource/schema.json` | +| `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/outputs/resource/schema.json` | +| `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/outputs/resource/schema.json` | The following list of tables defines the recognized URIs for the output schema: - Short URIs by version and form: - | Form | Version | Recognized URI | - |:------------------------|:---------|:--------------------------------------------------------------------------| + | Form | Version | Recognized URI | + |:-----------------------|:---------|:--------------------------------------------------------------------------------| + | Canonically bundled | `v3` | `https://aka.ms/dsc/schemas/v3/bundled/outputs/resource/schema.json` | + | Canonically bundled | `v3.1` | `https://aka.ms/dsc/schemas/v3.1/bundled/outputs/resource/schema.json` | + | Canonically bundled | `v3.1.0` | `https://aka.ms/dsc/schemas/v3.1.0/bundled/outputs/resource/schema.json` | + | Canonically bundled | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/bundled/outputs/resource/schema.json` | + | Canonically bundled | `v3.0.2` | `https://aka.ms/dsc/schemas/v3.0.2/bundled/outputs/resource/schema.json` | + | Canonically bundled | `v3.0.1` | `https://aka.ms/dsc/schemas/v3.0.1/bundled/outputs/resource/schema.json` | + | Canonically bundled | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/bundled/outputs/resource/schema.json` | | Canonical (nonbundled) | `v3` | `https://aka.ms/dsc/schemas/v3/outputs/resource/schema.json` | + | Canonical (nonbundled) | `v3.1` | `https://aka.ms/dsc/schemas/v3.1/outputs/resource/schema.json` | + | Canonical (nonbundled) | `v3.1.0` | `https://aka.ms/dsc/schemas/v3.1.0/outputs/resource/schema.json` | | Canonical (nonbundled) | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/outputs/resource/schema.json` | + | Canonical (nonbundled) | `v3.0.2` | `https://aka.ms/dsc/schemas/v3.0.2/outputs/resource/schema.json` | + | Canonical (nonbundled) | `v3.0.1` | `https://aka.ms/dsc/schemas/v3.0.1/outputs/resource/schema.json` | | Canonical (nonbundled) | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/outputs/resource/schema.json` | - | Canonically bundled | `v3` | `https://aka.ms/dsc/schemas/v3/bundled/outputs/resource/schema.json` | - | Canonically bundled | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/bundled/outputs/resource/schema.json` | - | Canonically bundled | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/bundled/outputs/resource/schema.json` | - | Enhanced authoring | `v3` | `https://aka.ms/dsc/schemas/v3/bundled/outputs/resource/schema.vscode.json` | - | Enhanced authoring | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/bundled/outputs/resource/schema.vscode.json` | - | Enhanced authoring | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/bundled/outputs/resource/schema.vscode.json` | + | Enhanced authoring | `v3` | `https://aka.ms/dsc/schemas/v3/bundled/outputs/resource/schema.vscode.json` | + | Enhanced authoring | `v3.1` | `https://aka.ms/dsc/schemas/v3.1/bundled/outputs/resource/schema.vscode.json` | + | Enhanced authoring | `v3.1.0` | `https://aka.ms/dsc/schemas/v3.1.0/bundled/outputs/resource/schema.vscode.json` | + | Enhanced authoring | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/bundled/outputs/resource/schema.vscode.json` | + | Enhanced authoring | `v3.0.2` | `https://aka.ms/dsc/schemas/v3.0.2/bundled/outputs/resource/schema.vscode.json` | + | Enhanced authoring | `v3.0.1` | `https://aka.ms/dsc/schemas/v3.0.1/bundled/outputs/resource/schema.vscode.json` | + | Enhanced authoring | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/bundled/outputs/resource/schema.vscode.json` | - GitHub URIs by version and form: - | Form | Version | Recognized URI | - |:------------------------|:---------|:-------------------------------------------------------------------------------------------------------------| + | Form | Version | Recognized URI | + |:-----------------------|:---------|:-------------------------------------------------------------------------------------------------------------------| + | Canonically bundled | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/outputs/resource/schema.json` | + | Canonically bundled | `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/bundled/outputs/resource/schema.json` | + | Canonically bundled | `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/bundled/outputs/resource/schema.json` | + | Canonically bundled | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/outputs/resource/schema.json` | + | Canonically bundled | `v3.0.2` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/bundled/outputs/resource/schema.json` | + | Canonically bundled | `v3.0.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/bundled/outputs/resource/schema.json` | + | Canonically bundled | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/outputs/resource/schema.json` | | Canonical (nonbundled) | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/outputs/resource/schema.json` | + | Canonical (nonbundled) | `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/outputs/resource/schema.json` | + | Canonical (nonbundled) | `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/outputs/resource/schema.json` | | Canonical (nonbundled) | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/outputs/resource/schema.json` | + | Canonical (nonbundled) | `v3.0.2` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/outputs/resource/schema.json` | + | Canonical (nonbundled) | `v3.0.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/outputs/resource/schema.json` | | Canonical (nonbundled) | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/outputs/resource/schema.json` | - | Canonically bundled | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/outputs/resource/schema.json` | - | Canonically bundled | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/outputs/resource/schema.json` | - | Canonically bundled | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/outputs/resource/schema.json` | - | Enhanced authoring | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/outputs/resource/schema.vscode.json` | - | Enhanced authoring | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/outputs/resource/schema.vscode.json` | - | Enhanced authoring | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/outputs/resource/schema.vscode.json` | + | Enhanced authoring | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/outputs/resource/schema.vscode.json` | + | Enhanced authoring | `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/bundled/outputs/resource/schema.vscode.json` | + | Enhanced authoring | `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/bundled/outputs/resource/schema.vscode.json` | + | Enhanced authoring | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/outputs/resource/schema.vscode.json` | + | Enhanced authoring | `v3.0.2` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/bundled/outputs/resource/schema.vscode.json` | + | Enhanced authoring | `v3.0.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/bundled/outputs/resource/schema.vscode.json` | + | Enhanced authoring | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/outputs/resource/schema.vscode.json` | ### Output schema for dsc resource set command @@ -525,41 +889,69 @@ The following table defines the value of the `$id` keyword for each published ve schema for the `dsc resource set` command. The `$id` is the same across all forms of the schema and regardless of the prefix URI used to retrieve the schema. -| Version folder | ID | -|:---------------|:----------------------------------------------------------------------------------------------| +| Version folder | ID | +|:---------------|:-------------------------------------------------------------------------------------------------| | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/outputs/resource/set.json` | +| `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/outputs/resource/set.json` | +| `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/outputs/resource/set.json` | | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/outputs/resource/set.json` | | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/outputs/resource/set.json` | +| `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/outputs/resource/set.json` | +| `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/outputs/resource/set.json` | The following list of tables defines the recognized URIs for the output schema: - Short URIs by version and form: - | Form | Version | Recognized URI | - |:------------------------|:---------|:--------------------------------------------------------------------------| + | Form | Version | Recognized URI | + |:-----------------------|:---------|:-----------------------------------------------------------------------------| + | Canonically bundled | `v3` | `https://aka.ms/dsc/schemas/v3/bundled/outputs/resource/set.json` | + | Canonically bundled | `v3.1` | `https://aka.ms/dsc/schemas/v3.1/bundled/outputs/resource/set.json` | + | Canonically bundled | `v3.1.0` | `https://aka.ms/dsc/schemas/v3.1.0/bundled/outputs/resource/set.json` | + | Canonically bundled | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/bundled/outputs/resource/set.json` | + | Canonically bundled | `v3.0.2` | `https://aka.ms/dsc/schemas/v3.0.2/bundled/outputs/resource/set.json` | + | Canonically bundled | `v3.0.1` | `https://aka.ms/dsc/schemas/v3.0.1/bundled/outputs/resource/set.json` | + | Canonically bundled | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/bundled/outputs/resource/set.json` | | Canonical (nonbundled) | `v3` | `https://aka.ms/dsc/schemas/v3/outputs/resource/set.json` | + | Canonical (nonbundled) | `v3.1` | `https://aka.ms/dsc/schemas/v3.1/outputs/resource/set.json` | + | Canonical (nonbundled) | `v3.1.0` | `https://aka.ms/dsc/schemas/v3.1.0/outputs/resource/set.json` | | Canonical (nonbundled) | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/outputs/resource/set.json` | + | Canonical (nonbundled) | `v3.0.2` | `https://aka.ms/dsc/schemas/v3.0.2/outputs/resource/set.json` | + | Canonical (nonbundled) | `v3.0.1` | `https://aka.ms/dsc/schemas/v3.0.1/outputs/resource/set.json` | | Canonical (nonbundled) | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/outputs/resource/set.json` | - | Canonically bundled | `v3` | `https://aka.ms/dsc/schemas/v3/bundled/outputs/resource/set.json` | - | Canonically bundled | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/bundled/outputs/resource/set.json` | - | Canonically bundled | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/bundled/outputs/resource/set.json` | - | Enhanced authoring | `v3` | `https://aka.ms/dsc/schemas/v3/bundled/outputs/resource/set.vscode.json` | - | Enhanced authoring | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/bundled/outputs/resource/set.vscode.json` | - | Enhanced authoring | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/bundled/outputs/resource/set.vscode.json` | + | Enhanced authoring | `v3` | `https://aka.ms/dsc/schemas/v3/bundled/outputs/resource/set.vscode.json` | + | Enhanced authoring | `v3.1` | `https://aka.ms/dsc/schemas/v3.1/bundled/outputs/resource/set.vscode.json` | + | Enhanced authoring | `v3.1.0` | `https://aka.ms/dsc/schemas/v3.1.0/bundled/outputs/resource/set.vscode.json` | + | Enhanced authoring | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/bundled/outputs/resource/set.vscode.json` | + | Enhanced authoring | `v3.0.2` | `https://aka.ms/dsc/schemas/v3.0.2/bundled/outputs/resource/set.vscode.json` | + | Enhanced authoring | `v3.0.1` | `https://aka.ms/dsc/schemas/v3.0.1/bundled/outputs/resource/set.vscode.json` | + | Enhanced authoring | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/bundled/outputs/resource/set.vscode.json` | - GitHub URIs by version and form: - | Form | Version | Recognized URI | - |:------------------------|:---------|:-------------------------------------------------------------------------------------------------------------| + | Form | Version | Recognized URI | + |:-----------------------|:---------|:----------------------------------------------------------------------------------------------------------------| + | Canonically bundled | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/outputs/resource/set.json` | + | Canonically bundled | `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/bundled/outputs/resource/set.json` | + | Canonically bundled | `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/bundled/outputs/resource/set.json` | + | Canonically bundled | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/outputs/resource/set.json` | + | Canonically bundled | `v3.0.2` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/bundled/outputs/resource/set.json` | + | Canonically bundled | `v3.0.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/bundled/outputs/resource/set.json` | + | Canonically bundled | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/outputs/resource/set.json` | | Canonical (nonbundled) | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/outputs/resource/set.json` | + | Canonical (nonbundled) | `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/outputs/resource/set.json` | + | Canonical (nonbundled) | `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/outputs/resource/set.json` | | Canonical (nonbundled) | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/outputs/resource/set.json` | + | Canonical (nonbundled) | `v3.0.2` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/outputs/resource/set.json` | + | Canonical (nonbundled) | `v3.0.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/outputs/resource/set.json` | | Canonical (nonbundled) | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/outputs/resource/set.json` | - | Canonically bundled | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/outputs/resource/set.json` | - | Canonically bundled | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/outputs/resource/set.json` | - | Canonically bundled | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/outputs/resource/set.json` | - | Enhanced authoring | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/outputs/resource/set.vscode.json` | - | Enhanced authoring | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/outputs/resource/set.vscode.json` | - | Enhanced authoring | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/outputs/resource/set.vscode.json` | + | Enhanced authoring | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/outputs/resource/set.vscode.json` | + | Enhanced authoring | `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/bundled/outputs/resource/set.vscode.json` | + | Enhanced authoring | `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/bundled/outputs/resource/set.vscode.json` | + | Enhanced authoring | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/outputs/resource/set.vscode.json` | + | Enhanced authoring | `v3.0.2` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/bundled/outputs/resource/set.vscode.json` | + | Enhanced authoring | `v3.0.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/bundled/outputs/resource/set.vscode.json` | + | Enhanced authoring | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/outputs/resource/set.vscode.json` | ### Output schema for dsc resource test command @@ -567,41 +959,69 @@ The following table defines the value of the `$id` keyword for each published ve schema for the `dsc resource test` command. The `$id` is the same across all forms of the schema and regardless of the prefix URI used to retrieve the schema. -| Version folder | ID | -|:---------------|:----------------------------------------------------------------------------------------------| +| Version folder | ID | +|:---------------|:--------------------------------------------------------------------------------------------------| | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/outputs/resource/test.json` | +| `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/outputs/resource/test.json` | +| `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/outputs/resource/test.json` | | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/outputs/resource/test.json` | | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/outputs/resource/test.json` | +| `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/outputs/resource/test.json` | +| `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/outputs/resource/test.json` | The following list of tables defines the recognized URIs for the output schema: - Short URIs by version and form: - | Form | Version | Recognized URI | - |:------------------------|:---------|:--------------------------------------------------------------------------| + | Form | Version | Recognized URI | + |:-----------------------|:---------|:------------------------------------------------------------------------------| + | Canonically bundled | `v3` | `https://aka.ms/dsc/schemas/v3/bundled/outputs/resource/test.json` | + | Canonically bundled | `v3.1` | `https://aka.ms/dsc/schemas/v3.1/bundled/outputs/resource/test.json` | + | Canonically bundled | `v3.1.0` | `https://aka.ms/dsc/schemas/v3.1.0/bundled/outputs/resource/test.json` | + | Canonically bundled | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/bundled/outputs/resource/test.json` | + | Canonically bundled | `v3.0.2` | `https://aka.ms/dsc/schemas/v3.0.2/bundled/outputs/resource/test.json` | + | Canonically bundled | `v3.0.1` | `https://aka.ms/dsc/schemas/v3.0.1/bundled/outputs/resource/test.json` | + | Canonically bundled | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/bundled/outputs/resource/test.json` | | Canonical (nonbundled) | `v3` | `https://aka.ms/dsc/schemas/v3/outputs/resource/test.json` | + | Canonical (nonbundled) | `v3.1` | `https://aka.ms/dsc/schemas/v3.1/outputs/resource/test.json` | + | Canonical (nonbundled) | `v3.1.0` | `https://aka.ms/dsc/schemas/v3.1.0/outputs/resource/test.json` | | Canonical (nonbundled) | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/outputs/resource/test.json` | + | Canonical (nonbundled) | `v3.0.2` | `https://aka.ms/dsc/schemas/v3.0.2/outputs/resource/test.json` | + | Canonical (nonbundled) | `v3.0.1` | `https://aka.ms/dsc/schemas/v3.0.1/outputs/resource/test.json` | | Canonical (nonbundled) | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/outputs/resource/test.json` | - | Canonically bundled | `v3` | `https://aka.ms/dsc/schemas/v3/bundled/outputs/resource/test.json` | - | Canonically bundled | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/bundled/outputs/resource/test.json` | - | Canonically bundled | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/bundled/outputs/resource/test.json` | - | Enhanced authoring | `v3` | `https://aka.ms/dsc/schemas/v3/bundled/outputs/resource/test.vscode.json` | - | Enhanced authoring | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/bundled/outputs/resource/test.vscode.json` | - | Enhanced authoring | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/bundled/outputs/resource/test.vscode.json` | + | Enhanced authoring | `v3` | `https://aka.ms/dsc/schemas/v3/bundled/outputs/resource/test.vscode.json` | + | Enhanced authoring | `v3.1` | `https://aka.ms/dsc/schemas/v3.1/bundled/outputs/resource/test.vscode.json` | + | Enhanced authoring | `v3.1.0` | `https://aka.ms/dsc/schemas/v3.1.0/bundled/outputs/resource/test.vscode.json` | + | Enhanced authoring | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/bundled/outputs/resource/test.vscode.json` | + | Enhanced authoring | `v3.0.2` | `https://aka.ms/dsc/schemas/v3.0.2/bundled/outputs/resource/test.vscode.json` | + | Enhanced authoring | `v3.0.1` | `https://aka.ms/dsc/schemas/v3.0.1/bundled/outputs/resource/test.vscode.json` | + | Enhanced authoring | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/bundled/outputs/resource/test.vscode.json` | - GitHub URIs by version and form: - | Form | Version | Recognized URI | - |:------------------------|:---------|:-------------------------------------------------------------------------------------------------------------| + | Form | Version | Recognized URI | + |:-----------------------|:---------|:-----------------------------------------------------------------------------------------------------------------| + | Canonically bundled | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/outputs/resource/test.json` | + | Canonically bundled | `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/bundled/outputs/resource/test.json` | + | Canonically bundled | `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/bundled/outputs/resource/test.json` | + | Canonically bundled | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/outputs/resource/test.json` | + | Canonically bundled | `v3.0.2` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/bundled/outputs/resource/test.json` | + | Canonically bundled | `v3.0.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/bundled/outputs/resource/test.json` | + | Canonically bundled | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/outputs/resource/test.json` | | Canonical (nonbundled) | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/outputs/resource/test.json` | + | Canonical (nonbundled) | `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/outputs/resource/test.json` | + | Canonical (nonbundled) | `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/outputs/resource/test.json` | | Canonical (nonbundled) | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/outputs/resource/test.json` | + | Canonical (nonbundled) | `v3.0.2` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/outputs/resource/test.json` | + | Canonical (nonbundled) | `v3.0.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/outputs/resource/test.json` | | Canonical (nonbundled) | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/outputs/resource/test.json` | - | Canonically bundled | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/outputs/resource/test.json` | - | Canonically bundled | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/outputs/resource/test.json` | - | Canonically bundled | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/outputs/resource/test.json` | - | Enhanced authoring | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/outputs/resource/test.vscode.json` | - | Enhanced authoring | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/outputs/resource/test.vscode.json` | - | Enhanced authoring | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/outputs/resource/test.vscode.json` | + | Enhanced authoring | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/outputs/resource/test.vscode.json` | + | Enhanced authoring | `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/bundled/outputs/resource/test.vscode.json` | + | Enhanced authoring | `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/bundled/outputs/resource/test.vscode.json` | + | Enhanced authoring | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/outputs/resource/test.vscode.json` | + | Enhanced authoring | `v3.0.2` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/bundled/outputs/resource/test.vscode.json` | + | Enhanced authoring | `v3.0.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/bundled/outputs/resource/test.vscode.json` | + | Enhanced authoring | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/outputs/resource/test.vscode.json` | ### Output schema for dsc schema command @@ -609,41 +1029,69 @@ The following table defines the value of the `$id` keyword for each published ve schema for the `dsc schema` command. The `$id` is the same across all forms of the schema and regardless of the prefix URI used to retrieve the schema. -| Version folder | ID | -|:---------------|:----------------------------------------------------------------------------------------------| +| Version folder | ID | +|:---------------|:-------------------------------------------------------------------------------------------| | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/outputs/schema.json` | +| `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/outputs/schema.json` | +| `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/outputs/schema.json` | | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/outputs/schema.json` | | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/outputs/schema.json` | +| `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/outputs/schema.json` | +| `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/outputs/schema.json` | The following list of tables defines the recognized URIs for the output schema: - Short URIs by version and form: - | Form | Version | Recognized URI | - |:------------------------|:---------|:--------------------------------------------------------------------------| + | Form | Version | Recognized URI | + |:-----------------------|:---------|:-----------------------------------------------------------------------| + | Canonically bundled | `v3` | `https://aka.ms/dsc/schemas/v3/bundled/outputs/schema.json` | + | Canonically bundled | `v3.1` | `https://aka.ms/dsc/schemas/v3.1/bundled/outputs/schema.json` | + | Canonically bundled | `v3.1.0` | `https://aka.ms/dsc/schemas/v3.1.0/bundled/outputs/schema.json` | + | Canonically bundled | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/bundled/outputs/schema.json` | + | Canonically bundled | `v3.0.2` | `https://aka.ms/dsc/schemas/v3.0.2/bundled/outputs/schema.json` | + | Canonically bundled | `v3.0.1` | `https://aka.ms/dsc/schemas/v3.0.1/bundled/outputs/schema.json` | + | Canonically bundled | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/bundled/outputs/schema.json` | | Canonical (nonbundled) | `v3` | `https://aka.ms/dsc/schemas/v3/outputs/schema.json` | + | Canonical (nonbundled) | `v3.1` | `https://aka.ms/dsc/schemas/v3.1/outputs/schema.json` | + | Canonical (nonbundled) | `v3.1.0` | `https://aka.ms/dsc/schemas/v3.1.0/outputs/schema.json` | | Canonical (nonbundled) | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/outputs/schema.json` | + | Canonical (nonbundled) | `v3.0.2` | `https://aka.ms/dsc/schemas/v3.0.2/outputs/schema.json` | + | Canonical (nonbundled) | `v3.0.1` | `https://aka.ms/dsc/schemas/v3.0.1/outputs/schema.json` | | Canonical (nonbundled) | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/outputs/schema.json` | - | Canonically bundled | `v3` | `https://aka.ms/dsc/schemas/v3/bundled/outputs/schema.json` | - | Canonically bundled | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/bundled/outputs/schema.json` | - | Canonically bundled | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/bundled/outputs/schema.json` | - | Enhanced authoring | `v3` | `https://aka.ms/dsc/schemas/v3/bundled/outputs/schema.vscode.json` | - | Enhanced authoring | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/bundled/outputs/schema.vscode.json` | - | Enhanced authoring | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/bundled/outputs/schema.vscode.json` | + | Enhanced authoring | `v3` | `https://aka.ms/dsc/schemas/v3/bundled/outputs/schema.vscode.json` | + | Enhanced authoring | `v3.1` | `https://aka.ms/dsc/schemas/v3.1/bundled/outputs/schema.vscode.json` | + | Enhanced authoring | `v3.1.0` | `https://aka.ms/dsc/schemas/v3.1.0/bundled/outputs/schema.vscode.json` | + | Enhanced authoring | `v3.0` | `https://aka.ms/dsc/schemas/v3.0/bundled/outputs/schema.vscode.json` | + | Enhanced authoring | `v3.0.2` | `https://aka.ms/dsc/schemas/v3.0.2/bundled/outputs/schema.vscode.json` | + | Enhanced authoring | `v3.0.1` | `https://aka.ms/dsc/schemas/v3.0.1/bundled/outputs/schema.vscode.json` | + | Enhanced authoring | `v3.0.0` | `https://aka.ms/dsc/schemas/v3.0.0/bundled/outputs/schema.vscode.json` | - GitHub URIs by version and form: - | Form | Version | Recognized URI | - |:------------------------|:---------|:-------------------------------------------------------------------------------------------------------------| + | Form | Version | Recognized URI | + |:-----------------------|:---------|:----------------------------------------------------------------------------------------------------------| + | Canonically bundled | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/outputs/schema.json` | + | Canonically bundled | `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/bundled/outputs/schema.json` | + | Canonically bundled | `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/bundled/outputs/schema.json` | + | Canonically bundled | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/outputs/schema.json` | + | Canonically bundled | `v3.0.2` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/bundled/outputs/schema.json` | + | Canonically bundled | `v3.0.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/bundled/outputs/schema.json` | + | Canonically bundled | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/outputs/schema.json` | | Canonical (nonbundled) | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/outputs/schema.json` | + | Canonical (nonbundled) | `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/outputs/schema.json` | + | Canonical (nonbundled) | `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/outputs/schema.json` | | Canonical (nonbundled) | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/outputs/schema.json` | + | Canonical (nonbundled) | `v3.0.2` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/outputs/schema.json` | + | Canonical (nonbundled) | `v3.0.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/outputs/schema.json` | | Canonical (nonbundled) | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/outputs/schema.json` | - | Canonically bundled | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/outputs/schema.json` | - | Canonically bundled | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/outputs/schema.json` | - | Canonically bundled | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/outputs/schema.json` | - | Enhanced authoring | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/outputs/schema.vscode.json` | - | Enhanced authoring | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/outputs/schema.vscode.json` | - | Enhanced authoring | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/outputs/schema.vscode.json` | + | Enhanced authoring | `v3` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/outputs/schema.vscode.json` | + | Enhanced authoring | `v3.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/bundled/outputs/schema.vscode.json` | + | Enhanced authoring | `v3.1.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/bundled/outputs/schema.vscode.json` | + | Enhanced authoring | `v3.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/outputs/schema.vscode.json` | + | Enhanced authoring | `v3.0.2` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/bundled/outputs/schema.vscode.json` | + | Enhanced authoring | `v3.0.1` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/bundled/outputs/schema.vscode.json` | + | Enhanced authoring | `v3.0.0` | `https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/outputs/schema.vscode.json` | [01]: https://semver.org