Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions dsc/docs-conceptual/dsc-3.0/concepts/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
items:
- name: DSC configuration documents
items:
- name: Overview
href: configuration-documents/overview.md
- name: DSC resources
items:
- name: Overview
href: resources/overview.md
- name: Resource instances
href: resources/instances.md
- name: Resource operations
href: resources/operations.md
- name: Resource properties
href: resources/properties.md
- name: Resource capabilities
href: resources/capabilities.md
- name: Resource kinds
href: resources/kinds.md
- name: Anatomy of a command resource
href: resources/anatomy.md
- name: Enhanced authoring
href: enhanced-authoring.md
- name: Output accessibility
href: output-accessibility.md
43 changes: 43 additions & 0 deletions dsc/docs-conceptual/dsc-3.0/reference/cli/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
items:
- name: dsc
href: index.md
- name: dsc completer
href: completer/index.md
- name: dsc config subcommands
items:
- name: dsc config
href: config/index.md
- name: dsc config export
href: config/export.md
- name: dsc config get
href: config/get.md
- name: dsc config set
href: config/set.md
- name: dsc config test
href: config/test.md
- name: dsc extension subcommands
items:
- name: dsc extension
href: extension/index.md
- name: dsc extension list
href: extension/list.md
- name: dsc resource subcommands
items:
- name: dsc resource
href: resource/index.md
- name: dsc resource delete
href: resource/delete.md
- name: dsc resource export
href: resource/export.md
- name: dsc resource get
href: resource/get.md
- name: dsc resource list
href: resource/list.md
- name: dsc resource schema
href: resource/schema.md
- name: dsc resource set
href: resource/set.md
- name: dsc resource test
href: resource/test.md
- name: dsc schema
href: schema/index.md
75 changes: 75 additions & 0 deletions dsc/docs-conceptual/dsc-3.0/reference/resources/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
items:
- name: Builtin resources
items:
- name: Overview
href: builtin.md
- name: DSC.PackageManagement/APT
items:
- name: DSC resource
href: DSC/PackageManagement/APT/index.md
- name: Examples
items:
- name: Manage packages
href: DSC/PackageManagement/APT/examples/manage-packages-with-apt.md
- name: Microsoft.DSC.Debug/Echo
items:
- name: DSC resource
href: Microsoft/DSC/Debug/Echo/index.md
- name: Examples
items:
- name: Basic usage
href: Microsoft/DSC/Debug/Echo/examples/basic-echo-example.md
- name: Microsoft.DSC/PowerShell
items:
- name: DSC resource
href: Microsoft/Dsc/PowerShell/index.md
- name: Microsoft/OSInfo
items:
- name: DSC resource
href: Microsoft/OSInfo/index.md
- name: Examples
items:
- name: Validate OS with dsc resource commands
href: Microsoft/OSInfo/examples/validate-with-dsc-resource.md
- name: Validate OS in a configuration
href: Microsoft/OSInfo/examples/validate-with-dsc-resource.md
- name: Microsoft.Windows/RebootPending
items:
- name: DSC resource
href: Microsoft/Windows/RebootPending/index.md
- name: Examples
items:
- name: Check for pending reboot
href: Microsoft/Windows/RebootPending/examples/check-for-pending-reboot.md
- name: Use in configuration
href: Microsoft/Windows/RebootPending/examples/use-rebootpending-in-configuration.md
- name: Microsoft.Windows/Registry
items:
- name: DSC resource
href: Microsoft/Windows/Registry/index.md
- name: Examples
items:
- name: Manage a key
href: Microsoft/Windows/Registry/examples/manage-a-registry-key.md
- name: Manage a value
href: Microsoft/Windows/Registry/examples/manage-a-registry-value.md
- name: Configure keys and values
href: Microsoft/Windows/Registry/examples/configure-registry-keys-and-values.md
- name: Microsoft.Windows/WindowsPowerShell
items:
- name: DSC resource
href: Microsoft/Windows/WindowsPowerShell/index.md
- name: Examples
items:
- name: Manage a Windows service
href: Microsoft/Windows/WindowsPowerShell/examples/manage-a-windows-service.md
- name: Microsoft.Windows/WMI
items:
- name: DSC resource
href: Microsoft/Windows/WMI/index.md
- name: Examples
items:
- name: Query operating system
href: Microsoft/Windows/WMI/examples/query-operating-system-info.md
- name: Query filtered disk
href: Microsoft/Windows/WMI/examples/query-filtered-disk-info.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ ValidValues: [resource, adapter, group, importer, exporter]

## Description

DSC supports three kinds of command-based DSC Resources:
DSC supports several kinds of command-based DSC Resources:

- `resource` - Indicates that the manifest isn't for a group or adapter resource.
- `group` - Indicates that the manifest is for a [group resource](#group-resources).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -165,23 +165,24 @@ Required: false

### kind

The `kind` property defines how DSC should handle the resource. DSC supports three kinds of
command-based DSC Resources: `Resource`, `Group`, and `Adapter`.
The `kind` property defines how DSC should handle the resource. DSC supports several kinds
ofcommand-based DSC Resources: `resource`, `group`, `adapter`, `importer`, and `exporter`.

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
`Adapter`. If the `adapter` property isn't defined, DSC infers the value of `kind` as `Resource`.
DSC can't infer whether a manifest is for a group resource.
`adapter`. If the `adapter` property isn't defined, DSC infers the value of `kind` as `resource`.
DSC can't infer whether a manifest is for a group` or importer resource.

When defining a group resource, always explicitly define the `kind` property in the manifest as
`Group`.
`group`. When defining an importer resource, always explicitly define the `kind` property in the
manifest as `importer`.

For more information, see [DSC Resource kind schema reference][02].

```yaml
Type: string
Required: false
ValidValues: [Resource, Adapter, Group]
ValidValues: [resource, adapter, group, importer, exporter]
```

### tags
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ To add this property to a resource's instance schema, define the property with t
snippet:

```json
"_inDesiredState": {
"_purge": {
"$ref": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/resource/properties/purge.json"
}
```
151 changes: 151 additions & 0 deletions dsc/docs-conceptual/dsc-3.0/reference/schemas/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,151 @@
items:
- name: Overview
href: overview.md
- name: Schema URIs
href: schema-uris.md
- name: dsc command outputs
items:
- name: dsc config command outputs
items:
- name: dsc config get output
href: outputs/config/get.md
- name: dsc config set output
href: outputs/config/set.md
- name: dsc config test output
href: outputs/config/test.md
- name: dsc extension command outputs
items:
- name: dsc extension list output
href: outputs/extension/list.md
- name: dsc resource command outputs
items:
- name: dsc resource get output
href: outputs/resource/get.md
- name: dsc resource list output
href: outputs/resource/list.md
- name: dsc resource set output
href: outputs/resource/set.md
- name: dsc resource test output
href: outputs/resource/test.md
- name: Configuration
items:
- name: Documents
href: config/document.md
- name: Document metadata
href: config/metadata.md
- name: Document parameters
href: config/parameter.md
- name: Resource instances
href: config/resource.md
- name: Functions
items:
- name: Overview
href: config/functions/overview.md
- name: add
href: config/functions/add.md
- name: base64
href: config/functions/base64.md
- name: concat
href: config/functions/concat.md
- name: createArray
href: config/functions/createArray.md
- name: div
href: config/functions/div.md
- name: envvar
href: config/functions/envvar.md
- name: equals
href: config/functions/equals.md
- name: format
href: config/functions/format.md
- name: if
href: config/functions/if.md
- name: int
href: config/functions/int.md
- name: max
href: config/functions/max.md
- name: min
href: config/functions/min.md
- name: mod
href: config/functions/mod.md
- name: mul
href: config/functions/mul.md
- name: parameters
href: config/functions/parameters.md
- name: reference
href: config/functions/reference.md
- name: resourceId
href: config/functions/resourceId.md
- name: sub
href: config/functions/sub.md
- name: variables
href: config/functions/variables.md
- name: Extension
items:
- name: Manifests
items:
- name: Root
href: extension/manifest/root.md
- name: Discover property
href: extension/manifest/discover.md
- name: Expected stdout
items:
- name: Discover operation stdout
href: extension/stdout/discover.md
- name: Resource
items:
- name: Manifests
items:
- name: Root
href: resource/manifest/root.md
- name: adapter command field
href: resource/manifest/adapter.md
- name: delete command field
href: resource/manifest/delete.md
- name: export command field
href: resource/manifest/export.md
- name: get command field
href: resource/manifest/get.md
- name: set command field
href: resource/manifest/set.md
- name: whatIf command field
href: resource/manifest/whatIf.md
- name: test command field
href: resource/manifest/test.md
- name: validate command field
href: resource/manifest/validate.md
- name: resolve command field
href: resource/manifest/resolve.md
- name: schema field
items:
- name: Command
href: resource/manifest/schema/property.md
- name: Embedded schemas
href: resource/manifest/schema/embedded.md
- name: Canonical resource properties
items:
- name: Overview
href: resource/properties/overview.md
- name: _ensure
href: resource/properties/ensure.md
- name: _exist
href: resource/properties/exist.md
- name: _inDesiredState
href: resource/properties/inDesiredState.md
- name: _purge
href: resource/properties/purge.md
- name: _rebootRequested
href: resource/properties/rebootRequested.md
- name: Metadata
items:
- name: Microsoft.DSC properties
href: metadata/Microsoft.DSC/properties.md
- name: Shared definitions
items:
- name: message
href: definitions/message.md
- name: resourceKind
href: definitions/resourceKind.md
- name: resourceType
href: definitions/resourceType.md
- name: Parameter dataTypes
href: definitions/parameters/dataTypes.md
9 changes: 9 additions & 0 deletions dsc/docs-conceptual/dsc-3.0/reference/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
items:
- name: DSC CLI
href: cli/toc.yml
- name: DSC JSON Schemas
href: schemas/toc.yml
- name: DSC resources
href: resources/toc.yml
- name: DSC tools
href: tools/toc.yml
31 changes: 31 additions & 0 deletions dsc/docs-conceptual/dsc-3.0/reference/tools/toc.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
items:
- name: Builtin commands
items:
- name: Overview
href: builtin.md
- name: osinfo
href: osinfo.md
- name: registry commandline
items:
- name: registry
href: registry/index.md
- name: registry query
href: registry/query/index.md
- name: registry set
href: registry/set/index.md
- name: registry remove
href: registry/remove/index.md
- name: registry find
href: registry/find/index.md
- name: registry config subcommands
items:
- name: registry config
href: registry/config/index.md
- name: registry config get
href: registry/config/get.md
- name: registry config set
href: registry/config/set.md
- name: registry config delete
href: registry/config/delete.md
- name: registry schema
href: registry/schema/index.md
Loading
Loading