DSC/resources/dism_dsc/featureondemand.dsc.resource.json at 3b5a1621fee6398032ab4f59577c6bb636ae36aa · PowerShell/DSC · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
{
    "$schema": "https://aka.ms/dsc/schemas/v3/bundled/resource/manifest.json",
    "description": "Manage Windows Features on Demand (capabilities) using the DISM API.",
    "tags": [
        "windows",
        "dism",
        "capability",
        "featureondemand",
        "fod"
    ],
    "type": "Microsoft.Windows/FeatureOnDemandList",
    "version": "0.1.0",
    "get": {
        "executable": "dism_dsc",
        "args": [
            "get",
            "feature-on-demand"
        ],
        "input": "stdin",
        "requireSecurityContext": "elevated"
    },
    "export": {
        "executable": "dism_dsc",
        "args": [
            "export",
            "feature-on-demand"
        ],
        "input": "stdin",
        "requireSecurityContext": "elevated"
    },
    "set": {
        "executable": "dism_dsc",
        "args": [
            "set",
            "feature-on-demand"
        ],
        "input": "stdin",
        "implementsPretest": false,
        "return": "state",
        "requireSecurityContext": "elevated"
    },
    "schema": {
        "embedded": {
            "$schema": "http://json-schema.org/draft-07/schema#",
            "$id": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/resources/Microsoft.Windows/FeatureOnDemandList/v0.1.0/schema.json",
            "title": "Windows Feature on Demand",
            "description": "Manage Windows Features on Demand (capabilities) using the DISM API. Supports get, set, and export operations.\n\nhttps://learn.microsoft.com/powershell/dsc/reference/microsoft.windows/featureondemandlist/resource\n",
            "markdownDescription": "The `Microsoft.Windows/FeatureOnDemandList` resource enables you to manage Windows Features on Demand (capabilities) using the DISM API.\n\n[Online documentation][01]\n\n[01]: https://learn.microsoft.com/powershell/dsc/reference/microsoft.windows/featureondemandlist/resource\n",
            "type": "object",
            "additionalProperties": false,
            "required": [
                "capabilities"
            ],
            "properties": {
                "_restartRequired": {
                    "type": "array",
                    "title": "Restart required",
                    "description": "Indicates that a system restart is required to complete the state change. Returned by the set operation when DISM reports that a reboot is needed.",
                    "items": {
                        "type": "object",
                        "additionalProperties": true
                    }
                },
                "capabilities": {
                    "type": "array",
                    "title": "Capabilities",
                    "description": "An array of Feature on Demand (capability) filters or information objects.",
                    "items": {
                        "type": "object",
                        "additionalProperties": false,
                        "properties": {
                            "identity": {
                                "type": "string",
                                "title": "Capability identity",
                                "description": "The identity of the Windows capability (Feature on Demand). Required for get and set operations. For export operation, this is optional and wildcards (*) are supported for case-insensitive filtering."
                            },
                            "_exist": {
                                "type": "boolean",
                                "title": "Exists",
                                "description": "Indicates whether the capability exists on the system. Set to false when the requested capability name is not recognized by DISM."
                            },
                            "state": {
                                "type": "string",
                                "enum": [
                                    "NotPresent",
                                    "UninstallPending",
                                    "Staged",
                                    "Removed",
                                    "Installed",
                                    "InstallPending",
                                    "Superseded",
                                    "PartiallyInstalled"
                                ],
                                "title": "Capability state",
                                "description": "The current state of the capability. For set operations, this property is required and only Installed and NotPresent are accepted; other states are returned by get and export operations and are not valid inputs for set."
                            },
                            "displayName": {
                                "type": "string",
                                "title": "Display name",
                                "description": "The display name of the capability. Returned by get and export operations. For export, wildcards (*) are supported for case-insensitive filtering."
                            },
                            "description": {
                                "type": "string",
                                "title": "Description",
                                "description": "The description of the capability. Returned by get and export operations. For export, wildcards (*) are supported for case-insensitive filtering."
                            },
                            "downloadSize": {
                                "type": "integer",
                                "title": "Download size",
                                "description": "The download size of the capability in bytes. Returned by get and export operations."
                            },
                            "installSize": {
                                "type": "integer",
                                "title": "Install size",
                                "description": "The install size of the capability in bytes. Returned by get and export operations."
                            }
                        }
                    }
                },
                "sourcePaths": {
                    "type": "array",
                    "title": "Source paths",
                    "description": "An array of paths to feature files if the files are not available in the local feature store. This is an optional property for set operations and is ignored for get operations.",
                    "items": {
                        "type": "string"
                    }
                }
            }
        }
    }
}