AzureDevOpsDscNative.AzDoTestPlan.dsc.adaptedResource.json

{
  "$schema": "https://aka.ms/dsc/schemas/v3/bundled/adaptedresource/manifest.json",
  "type": "AzureDevOpsDscNative/AzDoTestPlan",
  "kind": "resource",
  "version": "1.3.0",
  "capabilities": [
    "set",
    "test",
    "get"
  ],
  "description": "DSC resource for managing Azure DevOps test plans.",
  "author": "ZanattaMichael",
  "requireAdapter": "Microsoft.Adapter/PowerShell",
  "path": "AzureDevOpsDscNative.psd1",
  "schema": {
    "embedded": {
      "title": "AzureDevOpsDscNative/AzDoTestPlan",
      "additionalProperties": false,
      "type": "object",
      "required": [
        "ProjectName",
        "Name"
      ],
      "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."
        },
        "Name": {
          "type": "string",
          "title": "Name",
          "description": "The name of the test plan."
        },
        "AreaPath": {
          "type": "string",
          "title": "AreaPath",
          "description": "The area path new test cases are assigned to by default."
        },
        "Iteration": {
          "type": "string",
          "title": "Iteration",
          "description": "The iteration path the plan is scoped to."
        },
        "Owner": {
          "type": "string",
          "title": "Owner",
          "description": "The user or group who owns the plan. Resolved via Find-AzDoIdentity the same way other resources resolve identity strings (UPN, '[Project]\\Group', or display name)."
        },
        "StartDate": {
          "type": "string",
          "title": "StartDate",
          "description": "The date testing is scheduled to start."
        },
        "EndDate": {
          "type": "string",
          "title": "EndDate",
          "description": "The date testing is scheduled to end."
        },
        "State": {
          "type": "string",
          "enum": [
            "Active",
            "Inactive"
          ],
          "title": "State",
          "description": "The plan's state: 'Active' or 'Inactive'."
        },
        "BuildDefinitionId": {
          "type": "integer",
          "title": "BuildDefinitionId",
          "description": "The numeric id of the build pipeline used to identify the build under test for automated runs. Optional - omit for a plan with no associated build pipeline."
        }
      },
      "description": "DSC resource for managing Azure DevOps test plans.",
      "$schema": "https://json-schema.org/draft/2020-12/schema"
    }
  }
}