|
| 1 | +{ |
| 2 | + "$schema": "https://json-schema.org/draft/2020-12/schema", |
| 3 | + "$id": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/outputs/resource/get.json", |
| 4 | + "title": "dsc resource get result", |
| 5 | + "description": "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.", |
| 6 | + "anyOf": [ |
| 7 | + { |
| 8 | + "$ref": "#/$defs/PowerShell/DSC/main/schemas/v3.0.2/outputs/resource/get.simple.json" |
| 9 | + }, |
| 10 | + { |
| 11 | + "type": "array", |
| 12 | + "items": { |
| 13 | + "$ref": "#/$defs/PowerShell/DSC/main/schemas/v3.0.2/outputs/resource/get.full.json" |
| 14 | + } |
| 15 | + } |
| 16 | + ], |
| 17 | + "$defs": { |
| 18 | + "PowerShell": { |
| 19 | + "DSC": { |
| 20 | + "main": { |
| 21 | + "schemas": { |
| 22 | + "v3.0.2": { |
| 23 | + "outputs": { |
| 24 | + "resource": { |
| 25 | + "get.simple.json": { |
| 26 | + "$schema": "https://json-schema.org/draft/2020-12/schema", |
| 27 | + "$id": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/outputs/resource/get.simple.json", |
| 28 | + "title": "dsc resource get result (simple)", |
| 29 | + "description": "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.\nWhen you use `dsc resource get` for a group or adapter resource, the command returns an array of full test result objects that include the name and type for the nested instances.", |
| 30 | + "type": "object", |
| 31 | + "required": [ |
| 32 | + "actualState" |
| 33 | + ], |
| 34 | + "properties": { |
| 35 | + "actualState": { |
| 36 | + "title": "Actual state", |
| 37 | + "description": "This property always represents the current state of the DSC resource instance as returned by its `get` method. DSC validates this return value against the DSC resource's schema.", |
| 38 | + "type": "object" |
| 39 | + } |
| 40 | + } |
| 41 | + }, |
| 42 | + "get.full.json": { |
| 43 | + "$schema": "https://json-schema.org/draft/2020-12/schema", |
| 44 | + "$id": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/outputs/resource/get.full.json", |
| 45 | + "title": "dsc resource get result (full)", |
| 46 | + "description": "Describes the return data for the full result of the `get` operation for a\nresource instance. This data is returned:\n\n- For every instance in a configuration document when you use the\n `dsc config get` command.\n\n- For nested instances of a group or adapter resource when you use the\n `dsc resource get` command.", |
| 47 | + "type": "object", |
| 48 | + "required": [ |
| 49 | + "metadata", |
| 50 | + "name", |
| 51 | + "result", |
| 52 | + "type" |
| 53 | + ], |
| 54 | + "properties": { |
| 55 | + "metadata": { |
| 56 | + "$ref": "#/$defs/PowerShell/DSC/main/schemas/v3.0.2/metadata/resourceInstanceResult.json" |
| 57 | + }, |
| 58 | + "name": { |
| 59 | + "$ref": "#/$defs/PowerShell/DSC/main/schemas/v3.0.2/definitions/instanceName.json" |
| 60 | + }, |
| 61 | + "type": { |
| 62 | + "$ref": "#/$defs/PowerShell/DSC/main/schemas/v3.0.2/definitions/resourceType.json" |
| 63 | + }, |
| 64 | + "result": { |
| 65 | + "$ref": "#/$defs/PowerShell/DSC/main/schemas/v3.0.2/outputs/resource/get.json" |
| 66 | + } |
| 67 | + } |
| 68 | + } |
| 69 | + } |
| 70 | + }, |
| 71 | + "metadata": { |
| 72 | + "resourceInstanceResult.json": { |
| 73 | + "$schema": "https://json-schema.org/draft/2020-12/schema", |
| 74 | + "$id": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/metadata/resourceInstanceResult.json", |
| 75 | + "title": "Resource instance result metadata", |
| 76 | + "description": "Defines metadata DSC returns for a DSC configuration operation against a resource instance in a configuration document, as from the `dsc config get` or `dsc config set` commands. The metadata properties under the `Microsoft.DSC` property describe the context of the operation.", |
| 77 | + "markdownDescription": "Defines metadata DSC returns for a configuration operation, as from the `dsc config get` or\n`dsc config set` commands. The metadata properties under the `Microsoft.DSC` property describe\nthe context of the operation.", |
| 78 | + "type": "object", |
| 79 | + "required": [ |
| 80 | + "Microsoft.DSC" |
| 81 | + ], |
| 82 | + "properties": { |
| 83 | + "Microsoft.DSC": { |
| 84 | + "title": "DSC context metadata", |
| 85 | + "description": "The child properties for this metadata describe the context of the DSC operation against a resource instance, including the duration of the operation.", |
| 86 | + "type": "object", |
| 87 | + "required": [ |
| 88 | + "duration" |
| 89 | + ], |
| 90 | + "properties": { |
| 91 | + "duration": { |
| 92 | + "$ref": "#/$defs/PowerShell/DSC/main/schemas/v3.0.2/metadata/Microsoft.DSC/duration.json" |
| 93 | + } |
| 94 | + } |
| 95 | + } |
| 96 | + } |
| 97 | + }, |
| 98 | + "Microsoft.DSC": { |
| 99 | + "duration.json": { |
| 100 | + "$schema": "https://json-schema.org/draft/2020-12/schema", |
| 101 | + "$id": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/metadata/Microsoft.DSC/duration.json", |
| 102 | + "title": "Duration", |
| 103 | + "description": "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 about `0.61` seconds. For more information, see: https://datatracker.ietf.org/doc/html/rfc3339#appendix-A", |
| 104 | + "markdownDescription": "Defines the duration of a DSC operation against a configuration document or resource instance as\na string following the format defined in [ISO8601 ABNF for `duration`][01]. For example,\n`PT0.611216S` represents a duration of about `0.61` seconds.\n\n[01]: https://datatracker.ietf.org/doc/html/rfc3339#appendix-A", |
| 105 | + "type": "string", |
| 106 | + "format": "duration" |
| 107 | + } |
| 108 | + } |
| 109 | + }, |
| 110 | + "definitions": { |
| 111 | + "instanceName.json": { |
| 112 | + "$schema": "https://json-schema.org/draft/2020-12/schema", |
| 113 | + "$id": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/definitions/instanceName.json", |
| 114 | + "title": "Instance name", |
| 115 | + "description": "The short, human-readable name for a DSC resource instance. Must be unique within a DSC Configuration document. Must be a non-empty string containing only letters, numbers, and spaces.", |
| 116 | + "type": "string", |
| 117 | + "pattern": "^[a-zA-Z0-9 ]+$", |
| 118 | + "minLength": 1, |
| 119 | + "patternErrorMessage": "Invalid value for instance name. An instance name must be a non-empty string containing only\nletters, numbers, and spaces.\n", |
| 120 | + "markdownDescription": "***\n[_Online Documentation_][01]\n***\n\nDefines the short, human-readable name for a DSC resource instance. This property must be unique\nwithin a DSC configuration document. If any resource instances share the same name, DSC raises an\nerror.\n\nThe instance name must be a non-empty string containing only letters, numbers, and spaces.\n\n[01]: https://learn.microsoft.com/powershell/dsc/reference/schemas/config/resource?view=dsc-3.0&preserve-view=true#name\n" |
| 121 | + }, |
| 122 | + "resourceType.json": { |
| 123 | + "$schema": "https://json-schema.org/draft/2020-12/schema", |
| 124 | + "$id": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/definitions/resourceType.json", |
| 125 | + "title": "DSC resource fully qualified type name", |
| 126 | + "description": "The namespaced name of the DSC resource, using the syntax:\n\nowner[.group][.area]/name\n\nFor example:\n\n - Microsoft.SqlServer/Database\n - Microsoft.SqlServer.Database/User\n", |
| 127 | + "type": "string", |
| 128 | + "pattern": "^\\w+(\\.\\w+){0,2}\\/\\w+$", |
| 129 | + "markdownDescription": "***\n[_Online Documentation_][01]\n***\n\nThe namespaced name of the DSC resource, using the syntax:\n\n```yaml\nowner[.group][.area]/name\n```\n\nFor example:\n\n- `Microsoft.SqlServer/Database`\n- `Microsoft.SqlServer.Database/User`\n\n[01]: https://learn.microsoft.com/powershell/dsc/reference/schemas/definitions/resourcetype?view=dsc-3.0&preserve-view=true\n", |
| 130 | + "patternErrorMessage": "Invalid type name. Valid resource type names always define an owner and a name separated by a\nslash, like `Microsoft/OSInfo`. Type names may optionally include a group and area to namespace\nthe resource under the owner, like `Microsoft.Windows/Registry`.\n" |
| 131 | + } |
| 132 | + } |
| 133 | + } |
| 134 | + } |
| 135 | + } |
| 136 | + } |
| 137 | + } |
| 138 | + } |
| 139 | +} |
0 commit comments