AzureDevOpsDscNative.AzDoBuildRetentionSettings.dsc.adaptedResource.json

{
  "$schema": "https://aka.ms/dsc/schemas/v3/bundled/adaptedresource/manifest.json",
  "type": "AzureDevOpsDscNative/AzDoBuildRetentionSettings",
  "kind": "resource",
  "version": "1.2.0",
  "capabilities": [
    "set",
    "test",
    "get"
  ],
  "description": "DSC resource for managing Azure DevOps project run and artifact retention settings.",
  "author": "ZanattaMichael",
  "requireAdapter": "Microsoft.Adapter/PowerShell",
  "path": "AzureDevOpsDscNative.psd1",
  "schema": {
    "embedded": {
      "type": "object",
      "required": [
        "ProjectName"
      ],
      "additionalProperties": false,
      "description": "DSC resource for managing Azure DevOps project run and artifact retention settings.",
      "$schema": "https://json-schema.org/draft/2020-12/schema",
      "title": "AzureDevOpsDscNative/AzDoBuildRetentionSettings",
      "properties": {
        "Ensure": {
          "type": "string",
          "enum": [
            "Present",
            "Absent"
          ],
          "title": "Ensure",
          "description": "The Ensure property."
        },
        "LookupResult": {
          "type": "object",
          "title": "LookupResult",
          "readOnly": true,
          "description": "The LookupResult property."
        },
        "ProjectName": {
          "type": "string",
          "title": "ProjectName",
          "description": "The name of the Azure DevOps project."
        },
        "DaysToKeepRuns": {
          "type": "integer",
          "title": "DaysToKeepRuns",
          "description": "The number of days to keep pipeline runs before they are purged (API field 'purgeRuns' when read, 'runRetention' when written). Rejected if outside the org's live min/max range for this setting."
        },
        "DaysToKeepArtifacts": {
          "type": "integer",
          "title": "DaysToKeepArtifacts",
          "description": "The number of days to keep build artifacts, symbols and attachments before they are purged (API field 'purgeArtifacts' when read, 'artifactsRetention' when written). Rejected if outside the org's live min/max range for this setting."
        },
        "DaysToKeepPullRequestRuns": {
          "type": "integer",
          "title": "DaysToKeepPullRequestRuns",
          "description": "The number of days to keep runs triggered by pull requests before they are purged (API field 'purgePullRequestRuns' when read, 'pullRequestRunRetention' when written). Rejected if outside the org's live min/max range for this setting."
        },
        "RunsToRetainPerProtectedBranch": {
          "type": "integer",
          "title": "RunsToRetainPerProtectedBranch",
          "description": "The minimum number of runs to always retain per protected branch, regardless of age (API field 'retainRunsPerProtectedBranch', the same when read and written). Rejected if outside the org's live min/max range for this setting."
        }
      }
    }
  }
}