Tfs Team Project Endpoint

This document provides an overview of the Tfs Team Project Endpoint used in the Azure DevOps Migration Tools, including its configuration and usage.

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

missing XML code comments

top

Options

Parameter
Type
Description
Default Value
Parameter:
AllowCrossProjectLinking
Type:
Boolean
Description:
When true, allows work items to link to items in different projects within the same collection. Default is false for security and organizational clarity.
Default Value:
missing XML code comments
Parameter:
Authentication
Type:
TfsAuthenticationOptions
Description:
Authentication configuration for connecting to the TFS server. Supports various authentication modes including Windows authentication and access tokens.
Default Value:
missing XML code comments
Parameter:
Collection
Type:
Uri
Description:
URI of the TFS collection (e.g., “http://tfsserver:8080/tfs/DefaultCollection”). Must be a valid absolute URL pointing to the TFS collection.
Default Value:
missing XML code comments
Parameter:
Enabled
Type:
Boolean
Description:
Will be used if enabled
Default Value:
missing XML code comments
Parameter:
EndpointEnrichers
Type:
List
Description:
missing XML code comments
Default Value:
missing XML code comments
Parameter:
LanguageMaps
Type:
TfsLanguageMapOptions
Description:
Language mapping configuration for translating area and iteration path names between different language versions of TFS.
Default Value:
missing XML code comments
Parameter:
Name
Type:
String
Description:
missing XML code comments
Default Value:
missing XML code comments
Parameter:
Project
Type:
String
Description:
Name of the TFS project within the collection to connect to. This is the project that will be used for migration operations.
Default Value:
missing XML code comments
Parameter:
ReflectedWorkItemIdField
Type:
String
Description:
Name of the custom field used to store the reflected work item ID for tracking migrated items. Typically “Custom.ReflectedWorkItemId”.
Default Value:
missing XML code comments
top

Samples

top

Sample

Sample

{
  "MigrationTools": {
    "Version": "16.0",
    "Endpoints": {
      "#KEY#": {
        "EndpointType": "TfsTeamProjectEndpoint",
        "AllowCrossProjectLinking": "False",
        "Authentication": {
          "AccessToken": "jklsadhjksahfkjsdhjksahsadjhksadhsad",
          "AuthenticationMode": "AccessToken",
          "NetworkCredentials": {
            "Domain": "",
            "Password": "",
            "UserName": ""
          }
        },
        "Collection": "https://dev.azure.com/nkdagility-preview/",
        "Project": "migrationSource1",
        "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId"
      }
    }
  }
}
top

Defaults

Defaults

{
  "MigrationTools": {
    "Version": "16.0",
    "Endpoints": {
      "#KEY#": {
        "EndpointType": "TfsTeamProjectEndpoint",
        "AllowCrossProjectLinking": "False",
        "Authentication": {
          "AccessToken": "",
          "AuthenticationMode": "AccessToken",
          "NetworkCredentials": {
            "Domain": "",
            "Password": "",
            "UserName": ""
          }
        },
        "AuthenticationMode": "AccessToken",
        "Collection": "",
        "LanguageMaps": {
          "AreaPath": "Area",
          "IterationPath": "Iteration"
        },
        "Project": "",
        "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId"
      }
    }
  }
}
top

Classic

Classic

{
  "$type": "TfsTeamProjectEndpointOptions",
  "Collection": "https://dev.azure.com/nkdagility-preview/",
  "Project": "migrationSource1",
  "Authentication": {
    "AuthenticationMode": "AccessToken",
    "NetworkCredentials": {
      "Domain": "",
      "UserName": "",
      "Password": "** removed as a secret ***"
    },
    "AccessToken": "** removed as a secret ***"
  },
  "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId",
  "LanguageMaps": {
    "AreaPath": "Area",
    "IterationPath": "Iteration"
  }
}
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.endpoints.tfsteamprojectendpoint.json",
  "title": "TfsTeamProjectEndpoint",
  "description": "missing XML code comments",
  "type": "object",
  "properties": {
    "allowCrossProjectLinking": {
      "description": "When true, allows work items to link to items in different projects within the same collection. Default is false for security and organizational clarity.",
      "type": "boolean"
    },
    "authentication": {
      "description": "Authentication configuration for connecting to the TFS server. Supports various authentication modes including Windows authentication and access tokens.",
      "type": "string"
    },
    "collection": {
      "description": "URI of the TFS collection (e.g., \"http://tfsserver:8080/tfs/DefaultCollection\"). Must be a valid absolute URL pointing to the TFS collection.",
      "type": "string"
    },
    "enabled": {
      "description": "Will be used if enabled",
      "type": "boolean"
    },
    "endpointEnrichers": {
      "description": "missing XML code comments",
      "type": "array"
    },
    "languageMaps": {
      "description": "Language mapping configuration for translating area and iteration path names between different language versions of TFS.",
      "type": "string"
    },
    "name": {
      "description": "missing XML code comments",
      "type": "string"
    },
    "project": {
      "description": "Name of the TFS project within the collection to connect to. This is the project that will be used for migration operations.",
      "type": "string"
    },
    "reflectedWorkItemIdField": {
      "description": "Name of the custom field used to store the reflected work item ID for tracking migrated items. Typically \"Custom.ReflectedWorkItemId\".",
      "type": "string"
    }
  }
}
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