AzureDevOpsDscNative.AzDoProcessField.dsc.adaptedResource.json

{
  "$schema": "https://aka.ms/dsc/schemas/v3/bundled/adaptedresource/manifest.json",
  "type": "AzureDevOpsDscNative/AzDoProcessField",
  "kind": "resource",
  "version": "1.1.0",
  "capabilities": [
    "set",
    "test",
    "get"
  ],
  "description": "DSC resource for managing fields on a work item type of an Azure DevOps inherited process.",
  "author": "ZanattaMichael",
  "requireAdapter": "Microsoft.Adapter/PowerShell",
  "path": "AzureDevOpsDscNative.psd1",
  "schema": {
    "embedded": {
      "additionalProperties": false,
      "type": "object",
      "description": "DSC resource for managing fields on a work item type of an Azure DevOps inherited process.",
      "title": "AzureDevOpsDscNative/AzDoProcessField",
      "$schema": "https://json-schema.org/draft/2020-12/schema",
      "properties": {
        "Ensure": {
          "type": "string",
          "enum": [
            "Present",
            "Absent"
          ],
          "title": "Ensure",
          "description": "The Ensure property."
        },
        "LookupResult": {
          "type": "object",
          "title": "LookupResult",
          "readOnly": true,
          "description": "The LookupResult property."
        },
        "ProcessName": {
          "type": "string",
          "title": "ProcessName",
          "description": "The name of the inherited process."
        },
        "WorkItemTypeName": {
          "type": "string",
          "title": "WorkItemTypeName",
          "description": "The display name of the work item type."
        },
        "FieldName": {
          "type": "string",
          "title": "FieldName",
          "description": "The display name of the field."
        },
        "FieldReferenceName": {
          "type": "string",
          "title": "FieldReferenceName",
          "description": "The reference name of an existing field to attach, for example 'System.Priority'. Omit when creating a new custom field."
        },
        "FieldType": {
          "type": "string",
          "enum": [
            "string",
            "integer",
            "boolean",
            "dateTime",
            "html",
            "picklistString",
            "picklistInteger",
            "identity",
            "double",
            "plainText",
            "treePath"
          ],
          "title": "FieldType",
          "description": "The field type for a new custom field: 'string', 'integer', 'boolean', 'dateTime', 'html', 'picklistString', 'picklistInteger', 'identity', 'double', 'plainText' or 'treePath'."
        },
        "PicklistName": {
          "type": "string",
          "title": "PicklistName",
          "description": "The name of the picklist backing a picklist-typed field. Declare it with AzDoPicklist and use DependsOn."
        },
        "IsRequired": {
          "type": "boolean",
          "title": "IsRequired",
          "description": "Whether the field is required on this work item type."
        },
        "DefaultValue": {
          "type": "string",
          "title": "DefaultValue",
          "description": "The default value for the field on this work item type."
        },
        "ReadOnly": {
          "type": "boolean",
          "title": "ReadOnly",
          "description": "Whether the field is read-only on this work item type."
        }
      },
      "required": [
        "ProcessName",
        "WorkItemTypeName",
        "FieldName"
      ]
    }
  }
}