chocolatey.ChocolateySource.dsc.adaptedResource.json

{
  "$schema": "https://aka.ms/dsc/schemas/v3/bundled/adaptedresource/manifest.json",
  "type": "chocolatey/ChocolateySource",
  "kind": "resource",
  "version": "0.11.0",
  "capabilities": [
    "get",
    "test",
    "set"
  ],
  "description": "The `ChocolateySource` DSC resource is used to configure or remove source feeds for chocolatey.",
  "author": "Gael Colas",
  "requireAdapter": "Microsoft.Adapter/PowerShell",
  "path": "chocolatey.psd1",
  "schema": {
    "embedded": {
      "type": "object",
      "title": "chocolatey/ChocolateySource",
      "description": "The `ChocolateySource` DSC resource is used to configure or remove source feeds for chocolatey.",
      "additionalProperties": false,
      "properties": {
        "Ensure": {
          "type": "string",
          "enum": [
            "Absent",
            "Present"
          ],
          "title": "Ensure",
          "description": "Indicate whether the Chocolatey source should be installed or removed from the system."
        },
        "Name": {
          "type": "string",
          "title": "Name",
          "description": "Name - the name of the source. Required with some actions. Defaults to empty."
        },
        "Source": {
          "type": "string",
          "title": "Source",
          "description": "Source - The source. This can be a folder/file share or an http location. If it is a url, it will be a location you can go to in a browser and it returns OData with something that says Packages in the browser, similar to what you see when you go to https://chocolatey.org/api/v2/. Defaults to empty."
        },
        "Disabled": {
          "type": "string",
          "title": "Disabled",
          "description": "Allow the source to be registered but disabled."
        },
        "ByPassProxy": {
          "type": "string",
          "title": "ByPassProxy",
          "description": "Bypass Proxy - Should this source explicitly bypass any explicitly or system configured proxies? Defaults to false. Available in 0.10.4+."
        },
        "SelfService": {
          "type": "string",
          "title": "SelfService",
          "description": "Allow Self-Service - Should this source be allowed to be used with self- service? Requires business edition (v1.10.0+) with feature 'useBackgroundServiceWithSelfServiceSourcesOnly' turned on. Defaults to false. Available in 0.10.4+."
        },
        "Priority": {
          "type": "string",
          "title": "Priority",
          "description": "Priority - The priority order of this source as compared to other sources, lower is better. Defaults to 0 (no priority). All priorities above 0 will be evaluated first, then zero-based values will be evaluated in config file order. Available in 0.9.9.9+."
        },
        "Username": {
          "type": "string",
          "title": "Username",
          "description": "Username used with authenticated feeds. Must be used together with Password. Cannot be used together with Credential."
        },
        "Password": {
          "type": "string",
          "title": "Password",
          "description": "Password used with authenticated feeds. Must be used together with Username. Cannot be used together with Credential."
        },
        "Credential": {
          "type": "string",
          "title": "Credential",
          "description": "Credential used with authenticated feeds. Defaults to empty. Cannot be used together with Username/Password."
        },
        "Reasons": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "title": "Reasons",
          "readOnly": true,
          "description": "The Reasons property."
        }
      },
      "required": [
        "Name"
      ],
      "$schema": "https://json-schema.org/draft/2020-12/schema"
    }
  }
}