Tfs Team Settings Tool

Tool for migrating team settings including team configurations, area paths, iterations, and team-specific settings from source to target Team Foundation Server or Azure DevOps.

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

Tool for migrating team settings including team configurations, area paths, iterations, and team-specific settings from source to target Team Foundation Server or Azure DevOps.

top

Options

Parameter
Type
Description
Default Value
Parameter:
Enabled
Type:
Boolean
Description:
If set to true then the tool will run. Set to false and the processor will not run.
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:
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

{
  "MigrationTools": {
    "Version": "16.0",
    "CommonTools": {
      "TfsTeamSettingsTool": {
        "Enabled": "True",
        "MigrateTeamCapacities": "True",
        "MigrateTeamSettings": "True",
        "Teams": [
          "Team 1",
          "Team 2"
        ],
        "UpdateTeamSettings": "True"
      }
    }
  }
}
top

Defaults

Defaults

{
  "MigrationTools": {
    "Version": "16.0",
    "CommonTools": {
      "TfsTeamSettingsTool": {
        "Enabled": "True",
        "MigrateTeamCapacities": "True",
        "MigrateTeamSettings": "True",
        "Teams": null,
        "UpdateTeamSettings": "True"
      }
    }
  }
}
top

Classic

Classic

{
  "$type": "TfsTeamSettingsToolOptions",
  "Enabled": true,
  "MigrateTeamSettings": true,
  "UpdateTeamSettings": true,
  "MigrateTeamCapacities": true,
  "UseUserMapping": false,
  "Teams": [
    "Team 1",
    "Team 2"
  ]
}
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.tools.tfsteamsettingstool.json",
  "title": "TfsTeamSettingsTool",
  "description": "Tool for migrating team settings including team configurations, area paths, iterations, and team-specific settings from source to target Team Foundation Server or Azure DevOps.",
  "type": "object",
  "properties": {
    "enabled": {
      "description": "If set to `true` then the tool will run. Set to `false` and the processor will not run.",
      "type": "boolean"
    },
    "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"
    },
    "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