psresourcelist.dsc.resource.json

{
  "$schema": "https://aka.ms/dsc/schemas/v3/bundled/resource/manifest.json",
  "description": "Manage PowerShell resources using PSResourceGet.",
  "tags": [
    "linux",
    "windows",
    "macos",
    "powershell",
    "nuget"
  ],
  "type": "Microsoft.PowerShell.PSResourceGet/PSResourceList",
  "version": "0.0.1",
  "get": {
    "executable": "pwsh",
    "args": [
      "-NoLogo",
      "-NonInteractive",
      "-NoProfile",
      "-ExecutionPolicy",
      "Bypass",
      "-Command",
      "$Input | ./psresourceget.ps1 -resourcetype 'psresourcelist' -operation get; exit $LASTEXITCODE"
    ],
    "input": "stdin"
  },
  "set": {
    "executable": "pwsh",
    "args": [
      "-NoLogo",
      "-NonInteractive",
      "-NoProfile",
      "-ExecutionPolicy",
      "Bypass",
      "-Command",
      "$Input | ./psresourceget.ps1 -resourcetype 'psresourcelist' -operation set",
      { "whatIfArg": "-WhatIf" }
    ],
    "input": "stdin",
    "return": "stateAndDiff",
    "whatIfReturns": "state"
  },
  "export": {
    "executable": "pwsh",
    "args": [
      "-NoLogo",
      "-NonInteractive",
      "-NoProfile",
      "-ExecutionPolicy",
      "Bypass",
      "-Command",
      "./psresourceget.ps1 -resourcetype 'psresourcelist' -operation export; exit $LASTEXITCODE"
    ],
    "input": "stdin"
  },
  "test": {
    "executable": "pwsh",
    "args": [
      "-NoLogo",
      "-NonInteractive",
      "-NoProfile",
      "-ExecutionPolicy",
      "Bypass",
      "-Command",
      "$Input | ./psresourceget.ps1 -resourcetype 'psresourcelist' -operation test; exit $LASTEXITCODE"
    ],
    "input": "stdin",
    "return": "stateAndDiff"
  },
  "exitCodes": {
    "0": "Success",
    "1": "Error",
    "2": "Repository not found (during set operation)",
    "3": "Repository not trusted (during set operation)",
    "4": "Could not install one or more resources (during set operation)",
    "5": "Unknown resource type",
    "6": "Resource is not implemented",
    "7": "Test operation is not implemented for the resource",
    "8": "Export operation is not implemented for the resource",
    "9": "Get operation is not implemented for the resource",
    "10": "Set operation is not implemented for the resource",
    "11": "Delete operation is not implemented for the resource",
    "12": "Unknown operation"
  },
  "schema": {
    "embedded": {
      "$schema": "https://json-schema.org/draft/2020-12/schema",
      "title": "PSResourceList",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "repositoryName"
      ],
      "properties": {
        "repositoryName": {
          "title": "Repository Name",
          "description": "The name of the repository from where the resources are acquired.",
          "type": ["string", "null"]
        },
        "trustedRepository": {
          "title": "Trusted Repository",
          "description": "Indicates whether the repository is a trusted repository and installation should continue without prompting.",
          "type": "boolean",
          "default": false
        },
        "resources": {
          "title": "Resources",
          "description": "The list of resources to manage.",
          "type": "array",
          "items": {
            "$ref": "#/$defs/PSResource"
          },
          "minItems": 0
        },
        "_inDesiredState": {
          "$ref": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/resource/properties/inDesiredState.json"
        }
      },
      "$defs": {
        "Scope": {
          "type": ["string", "null"],
          "title": "Scope",
          "description": "Scope of the resource installation.",
          "enum": [
            "CurrentUser",
            "AllUsers"
          ]
        },
        "PSResource": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "name"
          ],
          "properties": {
            "name": {
              "title": "Name",
              "description": "The name of the resource.",
              "type": ["string", "null"]
            },
            "version": {
              "title": "Version",
              "description": "The version range of the resource.",
              "type": ["string", "null"]
            },
            "scope": {
              "title": "Scope",
              "description": "The scope of the resource. Can be 'CurrentUser' or 'AllUsers'.",
              "$ref": "#/$defs/Scope"
            },
            "repositoryName": {
              "title": "Repository Name",
              "description": "The name of the repository from where the resource is acquired.",
              "type": ["string", "null"]
            },
            "preRelease": {
              "title": "Pre-Release version",
              "description": "Indicates whether to include pre-release versions of the resource.",
              "type": "boolean",
              "default": false
            },
            "_exist": {
              "$ref": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/resource/properties/exist.json"
            },
            "_inDesiredState": {
              "$ref": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/resource/properties/inDesiredState.json"
            },
            "_metadata": {
              "type": "object",
              "title": "Metadata",
              "description": "Metadata populated during what-if operations.",
              "readOnly": true,
              "additionalProperties": false,
              "properties": {
                "whatIf": {
                  "type": "array",
                  "description": "Messages describing what the set operation would do.",
                  "items": { "type": "string" }
                }
              }
            }
          }
        },
        "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/resource/properties/exist.json": {
          "$schema": "https://json-schema.org/draft/2020-12/schema",
          "$id": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/resource/properties/exist.json",
          "title": "Instance should exist",
          "description": "Indicates whether the DSC resource instance should exist.",
          "type": "boolean",
          "default": true,
          "enum": [
            false,
            true
          ]
        },
        "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/resource/properties/inDesiredState.json": {
          "$schema": "https://json-schema.org/draft/2020-12/schema",
          "$id": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/resource/properties/inDesiredState.json",
          "title": "Instance is in desired state",
          "description": "Indicates whether the DSC resource instance is in the desired state.",
          "type": "boolean",
          "default": true,
          "enum": [
            false,
            true
          ]
        }
      }
    }
  }
}