chocolatey.ChocolateySoftware.dsc.adaptedResource.json

{
  "$schema": "https://aka.ms/dsc/schemas/v3/bundled/adaptedresource/manifest.json",
  "type": "chocolatey/ChocolateySoftware",
  "kind": "resource",
  "version": "0.11.0",
  "capabilities": [
    "get",
    "test",
    "set"
  ],
  "description": "The `ChocolateySoftware` DSC resource is used to install or remove choco.exe.",
  "author": "Gael Colas",
  "requireAdapter": "Microsoft.Adapter/PowerShell",
  "path": "chocolatey.psd1",
  "schema": {
    "embedded": {
      "type": "object",
      "title": "chocolatey/ChocolateySoftware",
      "description": "The `ChocolateySoftware` DSC resource is used to install or remove choco.exe.",
      "additionalProperties": false,
      "properties": {
        "Ensure": {
          "type": "string",
          "enum": [
            "Absent",
            "Present"
          ],
          "title": "Ensure",
          "description": "Indicate whether the Chocolatey Software should be installed or not on the system."
        },
        "InstallationDirectory": {
          "type": "string",
          "title": "InstallationDirectory",
          "description": "The InstallationDirectory property."
        },
        "ChocolateyPackageUrl": {
          "type": "string",
          "title": "ChocolateyPackageUrl",
          "description": "Exact URL of the chocolatey package. This can be an HTTP server, a network or local path. This must be the .nupkg package as downloadable from here: https://chocolatey.org/packages/chocolatey"
        },
        "PackageFeedUrl": {
          "type": "string",
          "title": "PackageFeedUrl",
          "description": "Url of the NuGet Feed API to use for looking up the latest version of Chocolatey (available on that feed). This is also used when searching for a specific version, doing a lookup via an Odata filter."
        },
        "Version": {
          "type": "string",
          "title": "Version",
          "description": "Version to install if you want to be specific, this is the way to Install a pre-release version, as when not specified, the latest non-prerelease version is looked up from the feed defined in PackageFeedUrl."
        },
        "ChocoTempDir": {
          "type": "string",
          "title": "ChocoTempDir",
          "description": "The temporary folder to extract the Chocolatey Binaries during install. This does not set the Chocolatey Cache dir."
        },
        "ProxyLocation": {
          "type": "string",
          "title": "ProxyLocation",
          "description": "Proxy url to use when downloading the Chocolatey Package for installation."
        },
        "IgnoreProxy": {
          "type": "boolean",
          "title": "IgnoreProxy",
          "description": "Ensure the proxy is bypassed when downloading the Chocolatey Package from the URL."
        },
        "ProxyCredential": {
          "type": "string",
          "title": "ProxyCredential",
          "description": "Credential to authenticate to the proxy, if not specified but the ProxyLocation is set, an attempt to use the Cached credential will be made."
        },
        "Reasons": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "title": "Reasons",
          "readOnly": true,
          "description": "The Reasons property."
        }
      },
      "required": [
        "Ensure"
      ],
      "$schema": "https://json-schema.org/draft/2020-12/schema"
    }
  }
}