JSON Schemas

The Azure DevOps Migration Tools provide JSON Schema definitions for configuration validation and IDE support.

Main Configuration Schema

• Configuration Schema - Complete configuration schema for Azure DevOps Migration Tools

Component Schemas

Processors

• AzureDevOpsPipelineProcessor
  Azure DevOps Processor that migrates Taskgroups, Build- and Release Pipelines.
• KeepOutboundLinkTargetProcessor
  missing XML code comments
• OutboundLinkCheckingProcessor
  missing XML code comments
• ProcessDefinitionProcessor
  Process definition processor used to keep processes between two orgs in sync
• TfsExportProfilePictureFromADProcessor
  Downloads corporate images and updates TFS/Azure DevOps profiles
• TfsExportUsersForMappingProcessor
  ExportUsersForMappingContext is a tool used to create a starter mapping file for users between the …
• TfsImportProfilePictureProcessor
  Downloads corporate images and updates TFS/Azure DevOps profiles
• TfsSharedQueryProcessor
  The TfsSharedQueryProcessor enabled you to migrate queries from one locatio nto another.
• TfsTeamSettingsProcessor
  Native TFS Processor, does not work with any other Endpoints.
• TfsTestConfigurationsMigrationProcessor
  This processor can migrate `test configuration`. This should be run before `LinkMigrationConfig`.
• TfsTestPlansAndSuitesMigrationProcessor
  Rebuilds Suits and plans for Test Cases migrated using the WorkItemMigration
• TfsTestVariablesMigrationProcessor
  This processor can migrate test variables that are defined in the test plans / suites. This must run …
• TfsWorkItemBulkEditProcessor
  This processor allows you to make changes in place where we load from the Target and update the …
• TfsWorkItemDeleteProcessor
  The `WorkItemDelete` processor allows you to delete any amount of work items that meet the query. …
• TfsWorkItemMigrationProcessor
  WorkItemMigrationConfig is the main processor used to Migrate Work Items, Links, and Attachments. …
• TfsWorkItemOverwriteAreasAsTagsProcessor
  A common issue with older *TFS/Azure DevOps* instances is the proliferation of `Area Paths`. With …
• TfsWorkItemOverwriteProcessor
  Reapply field mappings after a migration. Does not migrate Work Items, only reapplies changes to …
• TfsWorkItemTypeValidatorProcessor
  Work item type validation processor. Basically it just runs the to validate work item types. The …
• WorkItemTrackingProcessor
  This processor is intended, with the aid of [ProcessorEnrichers](../ProcessorEnrichers/index.md), to …

Tools

• FieldMappingTool
  Tool for applying field mapping transformations to work items during migration, supporting various …
• StringManipulatorTool
  Used to process the String fields of a work item. This is useful for cleaning up data. It will limit …
• TfsAttachmentTool
  Tool for processing and migrating work item attachments between Team Foundation Server instances, …
• TfsChangeSetMappingTool
  missing XML code comments
• TfsEmbededImagesTool
  missing XML code comments
• TfsGitRepositoryTool
  missing XML code comments
• TfsNodeStructureTool
  Tool for creating missing area and iteration path nodes in the target project during migration. …
• TfsRevisionManagerTool
  The TfsRevisionManagerTool manipulates the revisions of a work item to reduce the number of …
• TfsTeamSettingsTool
  Tool for migrating team settings including team configurations, area paths, iterations, and …
• TfsUserMappingTool
  The TfsUserMappingTool is used to map users from the source to the target system. Run it with the …
• TfsValidateRequiredFieldTool
  Tool for validating that required fields exist in target work item types before migration, …
• TfsWorkItemEmbededLinkTool
  Tool for processing embedded links within work item fields, such as links in HTML fields and …
• TfsWorkItemLinkTool
  Tool for migrating work item links and relationships between work items, including shared steps and …
• TfsWorkItemTypeValidatorTool
  missing XML code comments
• WorkItemTypeMappingTool
  Provides mapping functionality for transforming work item types from source to target systems during …

Field Maps

• FieldCalculationMap
  Performs mathematical calculations on numeric fields using NCalc expressions during migration.
• FieldClearMap
  Clears a target field by setting its value to null, useful for removing data from specific fields …
• FieldLiteralMap
  Maps a literal (static) value to a target field, useful for setting constant values across all …
• FieldMergeMap
  Merges values from multiple source fields into a single target field using a specified format …
• FieldSkipMap
  Skips field mapping for a specific target field, effectively leaving the field unchanged during …
• FieldToFieldMap
  Maps the value from a source field to a target field directly, with optional default value …
• FieldToFieldMultiMap
  missing XML code comments
• FieldToTagFieldMap
  missing XML code comments
• FieldValueMap
  Maps field values based on a lookup table, allowing specific source values to be translated to …
• MultiValueConditionalMap
  missing XML code comments
• RegexFieldMap
  Applies regular expression transformations to map values from a source field to a target field using …
• TreeToTagFieldMap
  Maps work item area path or iteration path hierarchies to tags, allowing tree structures to be …

Endpoints

• AzureDevOpsEndpoint
  Azure DevOps REST API endpoint implementation for connecting to Azure DevOps organizations. Provides …
• FileSystemWorkItemEndpoint
  missing XML code comments
• TfsEndpoint
  missing XML code comments
• TfsTeamProjectEndpoint
  missing XML code comments
• TfsTeamSettingsEndpoint
  missing XML code comments
• TfsWorkItemEndpoint
  missing XML code comments

Processor Enrichers

• PauseAfterEachItem
  missing XML code comments

Usage

You can reference these schemas in your JSON configuration files:

{
  "$schema": "https://devopsmigration.io/schema/configuration.schema.json",
  "MigrationTools": {
    // your configuration here
  }
}

Schema Validation

Most modern IDEs and editors support JSON Schema validation. Simply add the $schema property to your configuration files to enable:

• Auto-completion
• Validation
• Documentation on hover
• Error highlighting