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: June 25, 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
Enabled Boolean If set to true then the tool will run. Set to false and the processor will not run. missing XML code comments
ExportBasePath String AttachmentMigration is set to true then you need to specify a working path for attachments to be saved locally. C:\temp\Migration\
MaxAttachmentSize Int32 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). 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

Metadata

Class Name
TfsAttachmentTool
Status
Missing XML Code Comments
Processing Target
missing XML code comments
Type
Tools
Previous String Manipulator Tool
Next Tfs Change Set Mapping Tool
Project Information
Azure DevOps Marketplace
Visual Studio Marketplace Stars View Extension
YouTube Channel
Youtube Subscribers Youtube Views
Maintainer

Created and maintained by Martin Hinshelwood of nkdagility.com

Documentation Versions
Production Azure DevOps Migration Tools Release Version
Preview Azure DevOps Migration Tools Preview Version
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