Endpoints : TfsEndpoint

Ref

  

Less than 1 minute to read

  

2025-06-19 13:46:05 +0000

draft

This page is in draft and may include errors or omissions. Please check the discussions for any pending updates and changes to the content or to suggest your own changes.

missing XML code comments

Options

Parameter name	Type	Description	Default Value
Authentication	TfsAuthenticationOptions	Authentication configuration for connecting to the TFS server. Supports various authentication modes including Windows authentication and access tokens.	missing XML code comments
Collection	Uri	URI of the TFS collection (e.g., "http://tfsserver:8080/tfs/DefaultCollection"). Must be a valid absolute URL pointing to the TFS collection.	missing XML code comments
LanguageMaps	TfsLanguageMapOptions	Language mapping configuration for translating area and iteration path names between different language versions of TFS.	missing XML code comments
Project	String	Name of the TFS project within the collection to connect to. This is the project that will be used for migration operations.	missing XML code comments
ReflectedWorkItemIdField	String	Name of the custom field used to store the reflected work item ID for tracking migrated items. Typically "Custom.ReflectedWorkItemId".	missing XML code comments

Examples

sample

This is an example of what your config might look like once configured.

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

defaults

These are the default values for this configuration. If you do not set it in your config the default always applies. You can overide by adding a diferent value in your config.

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

classic

We have moved to a new config format, and you will need to update your old configs. This entry is a strate seralisation of the object and is here for legacy, and may provide value for debugging issues.

    {
  "$type": "TfsEndpointOptions",
  "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"
  }
}