chocolatey.ChocolateyPackage.dsc.adaptedResource.json

{
  "$schema": "https://aka.ms/dsc/schemas/v3/bundled/adaptedresource/manifest.json",
  "type": "chocolatey/ChocolateyPackage",
  "kind": "resource",
  "version": "0.11.0",
  "capabilities": [
    "get",
    "test",
    "set",
    "delete",
    "export"
  ],
  "description": "The `ChocolateyPackage` DSC resource is used to install or remove chocolatey packages.",
  "author": "Gael Colas",
  "requireAdapter": "Microsoft.Adapter/PowerShell",
  "path": "chocolatey.psd1",
  "schema": {
    "embedded": {
      "type": "object",
      "title": "chocolatey/ChocolateyPackage",
      "description": "The `ChocolateyPackage` DSC resource is used to install or remove chocolatey packages.",
      "additionalProperties": false,
      "properties": {
        "Ensure": {
          "type": "string",
          "enum": [
            "Absent",
            "Present"
          ],
          "title": "Ensure",
          "description": "The Ensure property."
        },
        "Name": {
          "type": "string",
          "title": "Name",
          "description": "The name of the ChocolateyPackage to set in the desired state."
        },
        "Version": {
          "type": "string",
          "title": "Version",
          "description": "The version of the package to install. If not set, it will only ensure the package is present/absent. If set to latest, it will always make sure the latest version available on the source is the one installed. If set to a version it will try to compare and make sure the installed version is greater or equal than the one desired."
        },
        "ChocolateyOptions": {
          "type": "object",
          "title": "ChocolateyOptions",
          "description": "Chocolatey parameters as per the Install or Update chocolateyPackage commands."
        },
        "Source": {
          "type": "string",
          "title": "Source",
          "description": "The Source property."
        },
        "Credential": {
          "type": "string",
          "title": "Credential",
          "description": "The Credential property."
        },
        "UpdateOnly": {
          "type": "boolean",
          "title": "UpdateOnly",
          "readOnly": true,
          "description": "Only update the package if present. When absent do not attempt to install."
        },
        "Reasons": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "title": "Reasons",
          "readOnly": true,
          "description": "Reason for compliance or non-compliance returned by the Get method."
        }
      },
      "required": [
        "Ensure",
        "Name"
      ],
      "$schema": "https://json-schema.org/draft/2020-12/schema"
    }
  }
}