Endpoints : TfsEndpoint

Ref

  

Less than 1 minute to read

  

2024-12-04 17:20:47 +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	missing XML code comments	missing XML code comments
Collection	Uri	missing XML code comments	missing XML code comments
LanguageMaps	TfsLanguageMapOptions	missing XML code comments	missing XML code comments
Project	String	missing XML code comments	missing XML code comments
ReflectedWorkItemIdField	String	missing XML code comments	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"
  }
}