description | ms.date | ms.topic | title |
---|---|---|---|
JSON schema reference for the data returned by the 'dsc resource get' command. |
01/17/2024 |
reference |
dsc resource get result schema reference |
The result output from the dsc resource get
command.
SchemaDialect: https://json-schema.org/draft/2020-12/schema
SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/outputs/resource/get.json
Type: object
Describes the return data for a DSC Resource instance from the dsc resource get
command. The
return data is either a single object that describes the actual state of a non-nested instance or
an array of objects that describe the actual state of the nested instances for a group or adapter
resource.
DSC returns a simple get response when the instance isn't a group resource, adapter resource, or nested inside a group or adapter resource.
When the retrieved instance is for group resource, adapter resource, or nested inside a group or adapter resource, DSC returns a full get result, which also includes the resource type and instance name.
Describes the return data for a single DSC Resource instance from the dsc resource get
command.
This data is returned for instances that aren't group resources, adapter resources, or nested
inside a group or adapter resource.
The output always includes these properties:
The actualState
property always includes the state of the instance returned when DSC invokes the
resource's get operation. DSC validates this property's value against the resource's instance
schema.
Type: object
Required: true
Describes the return data for the full result of the get
operation for a resource instance. This
data is returned:
- For every instance in a configuration document when you use the
dsc config get
command. - For nested instances of a group or adapter resource when you use the
dsc resource get
command.
Defines metadata DSC returns for a configuration operation. The properties under the
Microsoft.DSC
property describe the context of the operation.
- duration defines the duration of a DSC operation against a configuration document or
resource instance as a string following the format defined in ISO8601 ABNF for
duration
. For example,PT0.611216S
represents a duration of about0.61
seconds.
Type: object
Required: true
The type
property identifies the instance's DSC Resource by its fully qualified type name.
For more information about type names, see
DSC Resource fully qualified type name schema reference.
Type: string
Required: true
Pattern: ^\w+(\.\w+){0,2}\/\w+$
The name
property identifies the instance by its short, unique, human-readable name.
Type: string
Required: true
The result
property includes the actual state for the resource. This value is either:
- The simple get response for the instance
- An array of full get result objects for each nested instance, if the resource is a group or adapter resource.
Type: [object, array]
Required: true