Export-TfsWorkItemType
Exports an XML work item type definition from a team project.
Table of Contents
Syntax
Export to file
Export-TfsWorkItemType
[-Type <string>]
[-Collection <object>]
[-Destination <string>]
[-Encoding <string>]
[-Force]
[-IncludeGlobalLists]
[-Project <object>]
[-Server <object>]
Export to output stream
Export-TfsWorkItemType
[-Type <string>]
-AsXml
[-Collection <object>]
[-IncludeGlobalLists]
[-Project <object>]
[-Server <object>]
Parameters
Exports the saved query to the standard output stream as a string-encoded XML document.
| Type | SwitchParameter |
| Position | (Named) |
| Default Value | (N/A) |
| Accept pipeline input | False |
| Accept wildcard characters | False |
-Collection (Aliases: Organization)
Specifies the URL to the Team Project Collection or Azure DevOps Organization to connect to, a TfsTeamProjectCollection object (Windows PowerShell only), or a VssConnection object. You can also connect to an Azure DevOps Services organizations by simply providing its name instead of the full URL. For more details, see the Get-TfsTeamProjectCollection cmdlet. When omitted, it defaults to the connection set by Connect-TfsTeamProjectCollection (if any).
| Type | object |
| Position | (Named) |
| Default Value | (N/A) |
| Accept pipeline input | False |
| Accept wildcard characters | False |
Specifies the path to the folder where exported types are saved.
| Type | string |
| Position | (Named) |
| Default Value | (N/A) |
| Accept pipeline input | False |
| Accept wildcard characters | False |
Specifies the encoding for the exported XML files. When omitted, defaults to UTF-8.
| Type | string |
| Position | (Named) |
| Default Value | UTF-8 |
| Accept pipeline input | False |
| Accept wildcard characters | False |
Allows the cmdlet to overwrite an existing file in the destination folder.
| Type | SwitchParameter |
| Position | (Named) |
| Default Value | (N/A) |
| Accept pipeline input | False |
| Accept wildcard characters | False |
Exports the definitions of referenced global lists. When omitted, global list definitions are not included in the exported XML document.
| Type | SwitchParameter |
| Position | (Named) |
| Default Value | (N/A) |
| Accept pipeline input | False |
| Accept wildcard characters | False |
Specifies the name of the Team Project, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.TeamProject object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeamProject (if any). For more details, see the Get-TfsTeamProject cmdlet.
| Type | object |
| Position | (Named) |
| Default Value | (N/A) |
| Accept pipeline input | True (byvalue) |
| Accept wildcard characters | False |
Specifies the URL to the Team Foundation Server to connect to, a TfsConfigurationServer object (Windows PowerShell only), or a VssConnection object. When omitted, it defaults to the connection set by Connect-TfsConfiguration (if any). For more details, see the Get-TfsConfigurationServer cmdlet.
| Type | object |
| Position | (Named) |
| Default Value | (N/A) |
| Accept pipeline input | False |
| Accept wildcard characters | False |
Specifies one or more work item types to export. Wildcards are supported. When omitted, all work item types in the given project are exported
| Type | string |
| Position | 0 |
| Default Value | * |
| Accept pipeline input | False |
| Accept wildcard characters | False |
Inputs
System.Object
Specifies the name of the Team Project, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.TeamProject object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeamProject (if any). For more details, see the Get-TfsTeamProject cmdlet.