Tfs Team Settings Processor

Native TFS Processor, does not work with any other Endpoints.

Last updated: July 28, 2025 | Edit this page | Discuss this page

Native TFS Processor, does not work with any other Endpoints.

top

Options

Parameter
Type
Description
Default Value
Parameter:
Enabled
Type:
Boolean
Description:
If set to true then the processor will run. Set to false and the processor will not run.
Default Value:
missing XML code comments
Parameter:
Enrichers
Type:
List
Description:
List of Enrichers that can be used to add more features to this processor. Only works with Native Processors and not legacy Processors.
Default Value:
missing XML code comments
Parameter:
MigrateTeamCapacities
Type:
Boolean
Description:
Migrate original team member capacities after their creation on the target team project. Note: It will only migrate team member capacity if the team member with same display name exists on the target collection otherwise it will be ignored.
Default Value:
Not specified
Parameter:
MigrateTeamSettings
Type:
Boolean
Description:
Migrate original team settings after their creation on target team project
Default Value:
Not specified
Parameter:
PrefixProjectToNodes
Type:
Boolean
Description:
Prefix your iterations and areas with the project name. If you have enabled this in NodeStructuresMigrationConfig you must do it here too.
Default Value:
Not specified
Parameter:
RefName
Type:
String
Description:
Refname will be used in the future to allow for using named Options without the need to copy all of the options.
Default Value:
missing XML code comments
Parameter:
SourceName
Type:
String
Description:
This is the IEndpoint that will be used as the source of the Migration. Can be null for a write only processor.
Default Value:
missing XML code comments
Parameter:
TargetName
Type:
String
Description:
This is the IEndpoint that will be used as the Target of the Migration. Can be null for a read only processor.
Default Value:
missing XML code comments
Parameter:
Teams
Type:
List
Description:
List of Teams to process. If this is null then all teams will be processed.
Default Value:
missing XML code comments
Parameter:
UpdateTeamSettings
Type:
Boolean
Description:
Reset the target team settings to match the source if the team exists
Default Value:
Not specified
Parameter:
UseUserMapping
Type:
Boolean
Description:
Use user mapping file from TfsTeamSettingsTool when matching users when migrating capacities. By default, users in source are matched in target users by current display name. When this is set to true, users are matched also by mapped name from user mapping file.
Default Value:
missing XML code comments
top

Samples

top

Sample

Sample

There is no sample, but you can check the classic below for a general feel.
top

Defaults

Defaults

There are no defaults! Check the sample for options!
top

Classic

Classic

{
  "$type": "TfsTeamSettingsProcessorOptions",
  "Enabled": false,
  "MigrateTeamSettings": false,
  "UpdateTeamSettings": false,
  "PrefixProjectToNodes": false,
  "MigrateTeamCapacities": false,
  "Teams": null,
  "UseUserMapping": false,
  "SourceName": null,
  "TargetName": null
}
top

Metadata

top

Schema

This is the JSON schema that defines the structure and validation rules for this configuration.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://devopsmigration.io/schema/schema.processors.tfsteamsettingsprocessor.json",
  "title": "TfsTeamSettingsProcessor",
  "description": "Native TFS Processor, does not work with any other Endpoints.",
  "type": "object",
  "properties": {
    "enabled": {
      "description": "If set to `true` then the processor will run. Set to `false` and the processor will not run.",
      "type": "boolean"
    },
    "enrichers": {
      "description": "List of Enrichers that can be used to add more features to this processor. Only works with Native Processors and not legacy Processors.",
      "type": "array"
    },
    "migrateTeamCapacities": {
      "description": "Migrate original team member capacities after their creation on the target team project. Note: It will only migrate team member capacity if the team member with same display name exists on the target collection otherwise it will be ignored.",
      "type": "boolean",
      "default": "false"
    },
    "migrateTeamSettings": {
      "description": "Migrate original team settings after their creation on target team project",
      "type": "boolean",
      "default": "false"
    },
    "prefixProjectToNodes": {
      "description": "Prefix your iterations and areas with the project name. If you have enabled this in `NodeStructuresMigrationConfig` you must do it here too.",
      "type": "boolean",
      "default": "false"
    },
    "refName": {
      "description": "`Refname` will be used in the future to allow for using named Options without the need to copy all of the options.",
      "type": "string"
    },
    "sourceName": {
      "description": "This is the `IEndpoint` that will be used as the source of the Migration. Can be null for a write only processor.",
      "type": "string"
    },
    "targetName": {
      "description": "This is the `IEndpoint` that will be used as the Target of the Migration. Can be null for a read only processor.",
      "type": "string"
    },
    "teams": {
      "description": "List of Teams to process. If this is `null` then all teams will be processed.",
      "type": "array"
    },
    "updateTeamSettings": {
      "description": "Reset the target team settings to match the source if the team exists",
      "type": "boolean",
      "default": "false"
    },
    "useUserMapping": {
      "description": "Use user mapping file from TfsTeamSettingsTool when matching users when migrating capacities. By default, users in source are matched in target users by current display name. When this is set to `true`, users are matched also by mapped name from user mapping file.",
      "type": "boolean"
    }
  }
}
Project Information
Azure DevOps Marketplace
YouTube Channel
Maintainer

Created and maintained by Martin Hinshelwood of nkdagility.com

Getting Support
Community Support
Questions & Discussions

The first place to look for usage, configuration, and general help.

Commercial Support

We provide training, ad-hoc support, and full service migrations through our professional services.

Azure DevOps Migration Services
Documentation