AzureDevOpsDscNative.AzDoWikiPage.dsc.adaptedResource.json

{
  "$schema": "https://aka.ms/dsc/schemas/v3/bundled/adaptedresource/manifest.json",
  "type": "AzureDevOpsDscNative/AzDoWikiPage",
  "kind": "resource",
  "version": "1.2.0",
  "capabilities": [
    "set",
    "test",
    "get"
  ],
  "description": "DSC resource for managing the content and ordering of an Azure DevOps wiki page.",
  "author": "ZanattaMichael",
  "requireAdapter": "Microsoft.Adapter/PowerShell",
  "path": "AzureDevOpsDscNative.psd1",
  "schema": {
    "embedded": {
      "additionalProperties": false,
      "title": "AzureDevOpsDscNative/AzDoWikiPage",
      "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."
        },
        "WikiName": {
          "type": "string",
          "title": "WikiName",
          "description": "The name of the wiki that contains this page. Resolved via the 'LiveWikis' cache, the same way AzDoWiki resolves it. Only a project wiki (WikiType 'projectWiki') is supported."
        },
        "Path": {
          "type": "string",
          "title": "Path",
          "description": "The full path of the wiki page, for example '/Runbooks/On-call'. This is the resource key. The parent page ('/Runbooks' here) must already exist - declare it as its own AzDoWikiPage."
        },
        "Content": {
          "type": "string",
          "title": "Content",
          "description": "The page's Markdown content. Mutually exclusive with ContentPath."
        },
        "ContentPath": {
          "type": "string",
          "title": "ContentPath",
          "description": "A local file to read the page's Markdown content from. Keeps large pages out of the configuration itself. Mutually exclusive with Content."
        },
        "Order": {
          "type": "integer",
          "title": "Order",
          "description": "The page's desired position among its sibling pages. Left unspecified, the page's order is never compared or changed."
        },
        "AllowRecursiveDelete": {
          "type": "boolean",
          "title": "AllowRecursiveDelete",
          "description": "Deleting a wiki page deletes every sub-page beneath it. Removal of a page that still has sub-pages is refused unless this is set to $true."
        }
      },
      "required": [
        "ProjectName",
        "WikiName",
        "Path"
      ],
      "type": "object",
      "$schema": "https://json-schema.org/draft/2020-12/schema",
      "description": "DSC resource for managing the content and ordering of an Azure DevOps wiki page."
    }
  }
}