Tfs Endpoint
This document provides an overview of the Tfs Endpoint used in the Azure DevOps Migration Tools, including its configuration and usage.
missing XML code comments
Options
topSamples
topSample
Sample
{
"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
Defaults
{
"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
Classic
{
"$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"
}
}
Metadata
topSchema
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.tfsendpoint.json",
"title": "TfsEndpoint",
"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"
}
}
}
In this article
Project Information
Azure DevOps Marketplace
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