Tfs Attachment Tool

Tool for processing and migrating work item attachments between Team Foundation Server instances, handling file downloads, uploads, and attachment metadata.

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

Tool for processing and migrating work item attachments between Team Foundation Server instances, handling file downloads, uploads, and attachment metadata.

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:
ExportBasePath
Type:
String
Description:
AttachmentMigration is set to true then you need to specify a working path for attachments to be saved locally.
Default Value:
C:\temp\Migration\
Parameter:
MaxAttachmentSize
Type:
Int32
Description:
AttachmentMigration is set to true then you need to specify a max file size for upload in bites. For Azure DevOps Services the default is 480,000,000 bites (60mb), for TFS its 32,000,000 bites (4mb).
Default Value:
480000000
top

Samples

top

Sample

Sample

{
  "MigrationTools": {
    "Version": "16.0",
    "CommonTools": {
      "TfsAttachmentTool": {
        "Enabled": "True",
        "ExportBasePath": "c:\\temp\\WorkItemAttachmentExport",
        "MaxAttachmentSize": "480000000",
        "RefName": "TfsAttachmentTool"
      }
    }
  }
}
top

Defaults

Defaults

{
  "MigrationTools": {
    "Version": "16.0",
    "CommonTools": {
      "TfsAttachmentTool": {
        "Enabled": "True",
        "ExportBasePath": "c:\\temp\\WorkItemAttachmentExport",
        "MaxAttachmentSize": "480000000",
        "RefName": "TfsAttachmentTool"
      }
    }
  }
}
top

Classic

Classic

{
  "$type": "TfsAttachmentToolOptions",
  "Enabled": true,
  "ExportBasePath": "c:\\temp\\WorkItemAttachmentExport",
  "MaxAttachmentSize": 480000000
}
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.tfsattachmenttool.json",
  "title": "TfsAttachmentTool",
  "description": "Tool for processing and migrating work item attachments between Team Foundation Server instances, handling file downloads, uploads, and attachment metadata.",
  "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"
    },
    "exportBasePath": {
      "description": "`AttachmentMigration` is set to true then you need to specify a working path for attachments to be saved locally.",
      "type": "string",
      "default": "C:\\temp\\Migration\\"
    },
    "maxAttachmentSize": {
      "description": "`AttachmentMigration` is set to true then you need to specify a max file size for upload in bites. For Azure DevOps Services the default is 480,000,000 bites (60mb), for TFS its 32,000,000 bites (4mb).",
      "type": "integer",
      "default": "480000000"
    }
  }
}
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