TfsCmdlets.PSCore.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <!-- Cmdlet: Get-TfsArea --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="WorkItem.AreasIterations"> <command:details> <command:name>Get-TfsArea</command:name> <command:verb>Get</command:verb> <command:noun>TfsArea</command:noun> <maml:description> <maml:para>Gets one or more Work Item Areas from a given Team Project.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Get-TfsArea</maml:name> <!-- Parameter: Node --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Path,Area"> <maml:name>Node</maml:name> <maml:description> <maml:para>Specifies the name, URI or path of a Work Area. Wildcards are supported. When omitted, all Areas in the given Team Project are returned. To supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional. When supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>\**</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Node --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Path,Area"> <maml:name>Node</maml:name> <maml:description> <maml:para>Specifies the name, URI or path of a Work Area. Wildcards are supported. When omitted, all Areas in the given Team Project are returned. To supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional. When supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>\**</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Path,Area"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the name, URI or path of a Work Area. Wildcards are supported. When omitted, all Areas in the given Team Project are returned. To supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional. When supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> <maml:para>This is an alias of the Node parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>\**</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Path,Area"> <maml:name>Area</maml:name> <maml:description> <maml:para>Specifies the name, URI or path of a Work Area. Wildcards are supported. When omitted, all Areas in the given Team Project are returned. To supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional. When supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> <maml:para>This is an alias of the Node parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>\**</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>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.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: WorkItemClassificationNode --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemClassificationNode</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS> Get-TfsArea</dev:code> <dev:remarks> <maml:para>Returns all area paths in the currently connected Team Project (as defined by a previous call to Connect-TfsTeamProject)</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS> Get-TfsArea '\**\Support' -Project Tailspin</dev:code> <dev:remarks> <maml:para>Performs a recursive search and returns all area paths named 'Support' that may exist in a team project called Tailspin</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/WorkItem/AreasIterations/Get-TfsArea</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Move-TfsArea --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="WorkItem.AreasIterations"> <command:details> <command:name>Move-TfsArea</command:name> <command:verb>Move</command:verb> <command:noun>TfsArea</command:noun> <maml:description> <maml:para>Gets one or more Work Item Areas from a given Team Project.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Move-TfsArea</maml:name> <!-- Parameter: Node --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Path,Area"> <maml:name>Node</maml:name> <maml:description> <maml:para>Specifies the name, URI or path of a Work Area. Wildcards are supported. When omitted, all Areas in the given Team Project are returned. To supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional. When supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>\**</dev:defaultValue> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1" aliases="MoveTo"> <maml:name>Destination</maml:name> <maml:description> <maml:para>Specifies the name and/or path of the destination parent node.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Allows the cmdlet to create destination parent node(s) if they're missing.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Node --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Path,Area"> <maml:name>Node</maml:name> <maml:description> <maml:para>Specifies the name, URI or path of a Work Area. Wildcards are supported. When omitted, all Areas in the given Team Project are returned. To supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional. When supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>\**</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Path,Area"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the name, URI or path of a Work Area. Wildcards are supported. When omitted, all Areas in the given Team Project are returned. To supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional. When supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> <maml:para>This is an alias of the Node parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>\**</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Path,Area"> <maml:name>Area</maml:name> <maml:description> <maml:para>Specifies the name, URI or path of a Work Area. Wildcards are supported. When omitted, all Areas in the given Team Project are returned. To supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional. When supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> <maml:para>This is an alias of the Node parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>\**</dev:defaultValue> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1" aliases="MoveTo"> <maml:name>Destination</maml:name> <maml:description> <maml:para>Specifies the name and/or path of the destination parent node.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="1" aliases="MoveTo"> <maml:name>MoveTo</maml:name> <maml:description> <maml:para>Specifies the name and/or path of the destination parent node.</maml:para> <maml:para>This is an alias of the Destination parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Allows the cmdlet to create destination parent node(s) if they're missing.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the name, URI or path of a Work Area. Wildcards are supported. When omitted, all Areas in the given Team Project are returned. To supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional. When supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: WorkItemClassificationNode --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemClassificationNode</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/WorkItem/AreasIterations/Move-TfsArea</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-TfsArea --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="WorkItem.AreasIterations"> <command:details> <command:name>New-TfsArea</command:name> <command:verb>New</command:verb> <command:noun>TfsArea</command:noun> <maml:description> <maml:para>Creates a new Work Item Area in the given Team Project.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>New-TfsArea</maml:name> <!-- Parameter: Node --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Area,Path"> <maml:name>Node</maml:name> <maml:description> <maml:para>Specifies the path of the new Area. When supplying a path, use a backslash ("\\") between the path segments. Leading and trailing backslashes are optional. The last segment in the path will be the area name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Allows the cmdlet to create parent nodes if they're missing.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Node --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Area,Path"> <maml:name>Node</maml:name> <maml:description> <maml:para>Specifies the path of the new Area. When supplying a path, use a backslash ("\\") between the path segments. Leading and trailing backslashes are optional. The last segment in the path will be the area name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Area,Path"> <maml:name>Area</maml:name> <maml:description> <maml:para>Specifies the path of the new Area. When supplying a path, use a backslash ("\\") between the path segments. Leading and trailing backslashes are optional. The last segment in the path will be the area name.</maml:para> <maml:para>This is an alias of the Node parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Area,Path"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the path of the new Area. When supplying a path, use a backslash ("\\") between the path segments. Leading and trailing backslashes are optional. The last segment in the path will be the area name.</maml:para> <maml:para>This is an alias of the Node parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Allows the cmdlet to create parent nodes if they're missing.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the path of the new Area. When supplying a path, use a backslash ("\\") between the path segments. Leading and trailing backslashes are optional. The last segment in the path will be the area name.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: WorkItemClassificationNode --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemClassificationNode</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/WorkItem/AreasIterations/New-TfsArea</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-TfsArea --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="WorkItem.AreasIterations"> <command:details> <command:name>Remove-TfsArea</command:name> <command:verb>Remove</command:verb> <command:noun>TfsArea</command:noun> <maml:description> <maml:para>Deletes one or more Work Item Areas from a given Team Project.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Remove-TfsArea</maml:name> <!-- Parameter: Node --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Path,Area"> <maml:name>Node</maml:name> <maml:description> <maml:para>Specifies the name, URI or path of a Work Area. Wildcards are supported. When omitted, all Areas in the given Team Project are returned. To supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional. When supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MoveTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1" aliases="NewPath"> <maml:name>MoveTo</maml:name> <maml:description> <maml:para>Specifies the new parent node for the work items currently assigned to the node being deleted, if any. When omitted, defaults to the root node (the "\" node, at the team project level).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>\</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Recurse --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>Removes node(s) recursively.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Node --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Path,Area"> <maml:name>Node</maml:name> <maml:description> <maml:para>Specifies the name, URI or path of a Work Area. Wildcards are supported. When omitted, all Areas in the given Team Project are returned. To supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional. When supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Path,Area"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the name, URI or path of a Work Area. Wildcards are supported. When omitted, all Areas in the given Team Project are returned. To supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional. When supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> <maml:para>This is an alias of the Node parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Path,Area"> <maml:name>Area</maml:name> <maml:description> <maml:para>Specifies the name, URI or path of a Work Area. Wildcards are supported. When omitted, all Areas in the given Team Project are returned. To supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional. When supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> <maml:para>This is an alias of the Node parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MoveTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1" aliases="NewPath"> <maml:name>MoveTo</maml:name> <maml:description> <maml:para>Specifies the new parent node for the work items currently assigned to the node being deleted, if any. When omitted, defaults to the root node (the "\" node, at the team project level).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>\</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="1" aliases="NewPath"> <maml:name>NewPath</maml:name> <maml:description> <maml:para>Specifies the new parent node for the work items currently assigned to the node being deleted, if any. When omitted, defaults to the root node (the "\" node, at the team project level).</maml:para> <maml:para>This is an alias of the MoveTo parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>\</dev:defaultValue> </command:parameter> <!-- Parameter: Recurse --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>Removes node(s) recursively.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the name, URI or path of a Work Area. Wildcards are supported. When omitted, all Areas in the given Team Project are returned. To supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional. When supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: WorkItemClassificationNode --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemClassificationNode</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/WorkItem/AreasIterations/Remove-TfsArea</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Rename-TfsArea --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="WorkItem.AreasIterations"> <command:details> <command:name>Rename-TfsArea</command:name> <command:verb>Rename</command:verb> <command:noun>TfsArea</command:noun> <maml:description> <maml:para>Renames a Work Area.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Rename-TfsArea</maml:name> <!-- Parameter: Node --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Path,Area"> <maml:name>Node</maml:name> <maml:description> <maml:para>Specifies the name, URI or path of a Work Area. Wildcards are supported. When omitted, all Areas in the given Team Project are returned. To supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional. When supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NewName</maml:name> <maml:description> <maml:para>Specifies the new name of the item. Enter only a name - i.e., for items that support paths, do not enter a path and name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Node --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Path,Area"> <maml:name>Node</maml:name> <maml:description> <maml:para>Specifies the name, URI or path of a Work Area. Wildcards are supported. When omitted, all Areas in the given Team Project are returned. To supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional. When supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Path,Area"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the name, URI or path of a Work Area. Wildcards are supported. When omitted, all Areas in the given Team Project are returned. To supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional. When supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> <maml:para>This is an alias of the Node parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Path,Area"> <maml:name>Area</maml:name> <maml:description> <maml:para>Specifies the name, URI or path of a Work Area. Wildcards are supported. When omitted, all Areas in the given Team Project are returned. To supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional. When supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> <maml:para>This is an alias of the Node parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NewName</maml:name> <maml:description> <maml:para>Specifies the new name of the item. Enter only a name - i.e., for items that support paths, do not enter a path and name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the name, URI or path of a Work Area. Wildcards are supported. When omitted, all Areas in the given Team Project are returned. To supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional. When supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: WorkItemClassificationNode --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemClassificationNode</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/WorkItem/AreasIterations/Rename-TfsArea</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Test-TfsArea --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="WorkItem.AreasIterations"> <command:details> <command:name>Test-TfsArea</command:name> <command:verb>Test</command:verb> <command:noun>TfsArea</command:noun> <maml:description> <maml:para>Determines whether the specified Work Area exist.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Test-TfsArea</maml:name> <!-- Parameter: Node --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Area,Path"> <maml:name>Node</maml:name> <maml:description> <maml:para>Specifies the name, URI or path of a Work Area. Wildcards are supported. When omitted, all Areas in the given Team Project are returned. To supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional. When supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Node --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Area,Path"> <maml:name>Node</maml:name> <maml:description> <maml:para>Specifies the name, URI or path of a Work Area. Wildcards are supported. When omitted, all Areas in the given Team Project are returned. To supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional. When supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Area,Path"> <maml:name>Area</maml:name> <maml:description> <maml:para>Specifies the name, URI or path of a Work Area. Wildcards are supported. When omitted, all Areas in the given Team Project are returned. To supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional. When supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> <maml:para>This is an alias of the Node parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Area,Path"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the name, URI or path of a Work Area. Wildcards are supported. When omitted, all Areas in the given Team Project are returned. To supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional. When supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> <maml:para>This is an alias of the Node parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the name, URI or path of a Work Area. Wildcards are supported. When omitted, all Areas in the given Team Project are returned. To supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional. When supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/WorkItem/AreasIterations/Test-TfsArea</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-TfsBuildDefinitionFolder --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="Pipeline.Build"> <command:details> <command:name>Get-TfsBuildDefinitionFolder</command:name> <command:verb>Get</command:verb> <command:noun>TfsBuildDefinitionFolder</command:noun> <maml:description> <maml:para>Gets one or more build/pipeline definition folders in a team project.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Get-TfsBuildDefinitionFolder</maml:name> <!-- Parameter: Folder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Path"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Specifies the folder path. Wildcards are supported. When omitted, all build/pipeline folders in the supplied team project are returned.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>**</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: QueryOrder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>QueryOrder</maml:name> <maml:description> <maml:para>Specifies the query order. When omitted, defaults to None.</maml:para> <maml:para>Possible values: None, FolderAscending, FolderDescending</maml:para> </maml:description> <command:parameterValue required="true">FolderQueryOrder</command:parameterValue> <dev:type> <maml:name>Microsoft.TeamFoundation.Build.WebApi.FolderQueryOrder</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">FolderAscending</command:parameterValue> <command:parameterValue required="false" variableLength="false">FolderDescending</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Folder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Path"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Specifies the folder path. Wildcards are supported. When omitted, all build/pipeline folders in the supplied team project are returned.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>**</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Path"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the folder path. Wildcards are supported. When omitted, all build/pipeline folders in the supplied team project are returned.</maml:para> <maml:para>This is an alias of the Folder parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>**</dev:defaultValue> </command:parameter> <!-- Parameter: QueryOrder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>QueryOrder</maml:name> <maml:description> <maml:para>Specifies the query order. When omitted, defaults to None.</maml:para> <maml:para>Possible values: None, FolderAscending, FolderDescending</maml:para> </maml:description> <command:parameterValue required="true">FolderQueryOrder</command:parameterValue> <dev:type> <maml:name>Microsoft.TeamFoundation.Build.WebApi.FolderQueryOrder</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">FolderAscending</command:parameterValue> <command:parameterValue required="false" variableLength="false">FolderDescending</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>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.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Folder --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.Build.WebApi.Folder</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/Pipeline/Build/Get-TfsBuildDefinitionFolder</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-TfsBuildDefinitionFolder --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="Pipeline.Build"> <command:details> <command:name>New-TfsBuildDefinitionFolder</command:name> <command:verb>New</command:verb> <command:noun>TfsBuildDefinitionFolder</command:noun> <maml:description> <maml:para>Creates a new build/pipeline definition folder</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Folders are created recursively - i.e. when specifying a path like '\foo\bar\baz', if any of the parent folders (foo, foo\bar) does not exist, it is automatically created before creating any child folders.</maml:para> </maml:description> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>New-TfsBuildDefinitionFolder</maml:name> <!-- Parameter: Folder --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Path"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Specifies the path of the new pipeline/build folder, including its name, separated by backslashes (\).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description of the new build/pipeline folder.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Folder --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Path"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Specifies the path of the new pipeline/build folder, including its name, separated by backslashes (\).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Path"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the path of the new pipeline/build folder, including its name, separated by backslashes (\).</maml:para> <maml:para>This is an alias of the Folder parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description of the new build/pipeline folder.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the path of the new pipeline/build folder, including its name, separated by backslashes (\).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Folder --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.Build.WebApi.Folder</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/Pipeline/Build/New-TfsBuildDefinitionFolder</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-TfsBuildDefinitionFolder --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="Pipeline.Build"> <command:details> <command:name>Remove-TfsBuildDefinitionFolder</command:name> <command:verb>Remove</command:verb> <command:noun>TfsBuildDefinitionFolder</command:noun> <maml:description> <maml:para>Deletes one or more build/pipeline definition folders.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Remove-TfsBuildDefinitionFolder</maml:name> <!-- Parameter: Folder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Path"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Specifies the path of the pipeline/build folder to delete, including its name, separated by backslashes (\). Wildcards are supperted.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the exclusion of folders containing build/pipelines definitions. When omitted, only empty folders can be deleted.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Recurse --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>Removes folders recursively. When omitted, folders with subfolders cannot be deleted.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Folder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Path"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Specifies the path of the pipeline/build folder to delete, including its name, separated by backslashes (\). Wildcards are supperted.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Path"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the path of the pipeline/build folder to delete, including its name, separated by backslashes (\). Wildcards are supperted.</maml:para> <maml:para>This is an alias of the Folder parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Recurse --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>Removes folders recursively. When omitted, folders with subfolders cannot be deleted.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the exclusion of folders containing build/pipelines definitions. When omitted, only empty folders can be deleted.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the path of the pipeline/build folder to delete, including its name, separated by backslashes (\). Wildcards are supperted.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Folder --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.Build.WebApi.Folder</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/Pipeline/Build/Remove-TfsBuildDefinitionFolder</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Connect-TfsConfigurationServer --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="Connection"> <command:details> <command:name>Connect-TfsConfigurationServer</command:name> <command:verb>Connect</command:verb> <command:noun>TfsConfigurationServer</command:noun> <maml:description> <maml:para>Connects to a configuration server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>A TFS Configuration Server represents the server that is running Team Foundation Server. On a database level, it is represented by the Tfs_Configuration database. Operations that should be performed on a server level (such as setting server-level permissions) require a connection to a TFS configuration server. Internally, this connection is represented by an instance of the Microsoft.TeamFoundation.Client.TfsConfigurationServer. NOTE: Currently it is only supported in Windows PowerShell.</maml:para> </maml:description> <command:syntax> <!-- Parameter Set: Cached credentials --> <command:syntaxItem tfscmdlets:parameterSet="Cached credentials"> <maml:name>Connect-TfsConfigurationServer</maml:name> <!-- Parameter: Server --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies either a URL/name of the Team Foundation Server to connect to, or a previously initialized TfsConfigurationServer object. When using a URL, it must be fully qualified. To connect to a Team Foundation Server instance by using its name, it must have been previously registered.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Cached --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Cached</maml:name> <maml:description> <maml:para>Specifies that cached (default) credentials should be used when possible/available.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter Set: User name and password --> <command:syntaxItem tfscmdlets:parameterSet="User name and password"> <maml:name>Connect-TfsConfigurationServer</maml:name> <!-- Parameter: Server --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies either a URL/name of the Team Foundation Server to connect to, or a previously initialized TfsConfigurationServer object. When using a URL, it must be fully qualified. To connect to a Team Foundation Server instance by using its name, it must have been previously registered.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>UserName</maml:name> <maml:description> <maml:para>Specifies a user name for authentication modes (such as Basic) that support username/password-based credentials. Must be used in conjunction with the -Password argument</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Password --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies a password for authentication modes (such as Basic) that support username/password-based credentials. Must be used in conjunction with the -UserName argument</maml:para> </maml:description> <command:parameterValue required="true">SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter Set: Credential object --> <command:syntaxItem tfscmdlets:parameterSet="Credential object"> <maml:name>Connect-TfsConfigurationServer</maml:name> <!-- Parameter: Server --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies either a URL/name of the Team Foundation Server to connect to, or a previously initialized TfsConfigurationServer object. When using a URL, it must be fully qualified. To connect to a Team Foundation Server instance by using its name, it must have been previously registered.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies a user account that has permission to perform this action. To provide a user name and password, a Personal Access Token, and/or to open a input dialog to enter your credentials, call Get-TfsCredential with the appropriate arguments and pass its return to this argument.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter Set: Personal Access Token --> <command:syntaxItem tfscmdlets:parameterSet="Personal Access Token"> <maml:name>Connect-TfsConfigurationServer</maml:name> <!-- Parameter: Server --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies either a URL/name of the Team Foundation Server to connect to, or a previously initialized TfsConfigurationServer object. When using a URL, it must be fully qualified. To connect to a Team Foundation Server instance by using its name, it must have been previously registered.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PersonalAccessToken --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="Pat"> <maml:name>PersonalAccessToken</maml:name> <maml:description> <maml:para>Specifies a personal access token, used as an alternate credential, to authenticate to Azure DevOps</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter Set: Prompt for credential --> <command:syntaxItem tfscmdlets:parameterSet="Prompt for credential"> <maml:name>Connect-TfsConfigurationServer</maml:name> <!-- Parameter: Server --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies either a URL/name of the Team Foundation Server to connect to, or a previously initialized TfsConfigurationServer object. When using a URL, it must be fully qualified. To connect to a Team Foundation Server instance by using its name, it must have been previously registered.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Interactive --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Interactive</maml:name> <maml:description> <maml:para>Prompts for user credentials. Can be used for any Team Foundation Server or Azure DevOps account - the proper login dialog is automatically selected. Should only be used in an interactive PowerShell session (i.e., a PowerShell terminal window), never in an unattended script (such as those executed during an automated build). Currently it is only supported in Windows PowerShell.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Server --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies either a URL/name of the Team Foundation Server to connect to, or a previously initialized TfsConfigurationServer object. When using a URL, it must be fully qualified. To connect to a Team Foundation Server instance by using its name, it must have been previously registered.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Cached --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Cached</maml:name> <maml:description> <maml:para>Specifies that cached (default) credentials should be used when possible/available.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UserName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>UserName</maml:name> <maml:description> <maml:para>Specifies a user name for authentication modes (such as Basic) that support username/password-based credentials. Must be used in conjunction with the -Password argument</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Password --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies a password for authentication modes (such as Basic) that support username/password-based credentials. Must be used in conjunction with the -UserName argument</maml:para> </maml:description> <command:parameterValue required="true">SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies a user account that has permission to perform this action. To provide a user name and password, a Personal Access Token, and/or to open a input dialog to enter your credentials, call Get-TfsCredential with the appropriate arguments and pass its return to this argument.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PersonalAccessToken --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="Pat"> <maml:name>PersonalAccessToken</maml:name> <maml:description> <maml:para>Specifies a personal access token, used as an alternate credential, to authenticate to Azure DevOps</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="Pat"> <maml:name>Pat</maml:name> <maml:description> <maml:para>Specifies a personal access token, used as an alternate credential, to authenticate to Azure DevOps</maml:para> <maml:para>This is an alias of the PersonalAccessToken parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Interactive --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Interactive</maml:name> <maml:description> <maml:para>Prompts for user credentials. Can be used for any Team Foundation Server or Azure DevOps account - the proper login dialog is automatically selected. Should only be used in an interactive PowerShell session (i.e., a PowerShell terminal window), never in an unattended script (such as those executed during an automated build). Currently it is only supported in Windows PowerShell.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies either a URL/name of the Team Foundation Server to connect to, or a previously initialized TfsConfigurationServer object. When using a URL, it must be fully qualified. To connect to a Team Foundation Server instance by using its name, it must have been previously registered.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: TfsConfigurationServer --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.Client.TfsConfigurationServer</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS> Connect-TfsConfigurationServer -Server http://vsalm:8080/tfs</dev:code> <dev:remarks> <maml:para>Connects to the TFS server specified by the URL in the Server argument</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS> Connect-TfsConfigurationServer -Server vsalm</dev:code> <dev:remarks> <maml:para>Connects to a previously registered TFS server by its user-defined name "vsalm". For more information, see Get-TfsRegisteredConfigurationServer</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/Connection/Connect-TfsConfigurationServer</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Disconnect-TfsConfigurationServer --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="Connection"> <command:details> <command:name>Disconnect-TfsConfigurationServer</command:name> <command:verb>Disconnect</command:verb> <command:noun>TfsConfigurationServer</command:noun> <maml:description> <maml:para>Disconnects from the currently connected configuration server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Disconnect-TfsConfigurationServer cmdlet removes the connection previously set by its counterpart Connect-TfsConfigurationServer. Therefore, cmdlets relying on a "default server" as provided by "Get-TfsConfigurationServer -Current" will no longer work after a call to this cmdlet, unless their -Server argument is provided or a new call to Connect-TfsConfigurationServer is made.</maml:para> </maml:description> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Disconnect-TfsConfigurationServer</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/Connection/Disconnect-TfsConfigurationServer</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-TfsConfigurationServer --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="ConfigServer"> <command:details> <command:name>Get-TfsConfigurationServer</command:name> <command:verb>Get</command:verb> <command:noun>TfsConfigurationServer</command:noun> <maml:description> <maml:para>Gets information about a configuration server.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: Get by server --> <command:syntaxItem tfscmdlets:parameterSet="Get by server"> <maml:name>Get-TfsConfigurationServer</maml:name> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Server</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies a user account that has permission to perform this action. To provide a user name and password, a Personal Access Token, and/or to open a input dialog to enter your credentials, call Get-TfsCredential with the appropriate arguments and pass its return to this argument.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter Set: Get current --> <command:syntaxItem tfscmdlets:parameterSet="Get current"> <maml:name>Get-TfsConfigurationServer</maml:name> <!-- Parameter: Current --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Current</maml:name> <maml:description> <maml:para>Returns the configuration server specified in the last call to Connect-TfsConfigurationServer (i.e. the "current" configuration server)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Server</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Current --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Current</maml:name> <maml:description> <maml:para>Returns the configuration server specified in the last call to Connect-TfsConfigurationServer (i.e. the "current" configuration server)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies a user account that has permission to perform this action. To provide a user name and password, a Personal Access Token, and/or to open a input dialog to enter your credentials, call Get-TfsCredential with the appropriate arguments and pass its return to this argument.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>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.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: TfsConfigurationServer --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.Client.TfsConfigurationServer</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/ConfigServer/Get-TfsConfigurationServer</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-TfsConfigurationServerConnectionString --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="Admin"> <command:details> <command:name>Get-TfsConfigurationServerConnectionString</command:name> <command:verb>Get</command:verb> <command:noun>TfsConfigurationServerConnectionString</command:noun> <maml:description> <maml:para>Gets the configuration server database connection string.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: Use computer name --> <command:syntaxItem tfscmdlets:parameterSet="Use computer name"> <maml:name>Get-TfsConfigurationServerConnectionString</maml:name> <!-- Parameter: ComputerName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>Specifies the name of a Team Foundation Server application tier from which to retrieve the connection string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>localhost</dev:defaultValue> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The user credentials to be used to access a remote machine. Those credentials must have the required permission to execute a PowerShell Remote session on that computer.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Management.Automation.PSCredential</dev:defaultValue> </command:parameter> <!-- Parameter: Version --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Version</maml:name> <maml:description> <maml:para>The TFS version number, represented by the year in its name. For e.g. TFS 2015, use "2015". When omitted, will default to the newest installed version of TFS / Azure DevOps Server</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter Set: Use session --> <command:syntaxItem tfscmdlets:parameterSet="Use session"> <maml:name>Get-TfsConfigurationServerConnectionString</maml:name> <!-- Parameter: Session --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The machine name of the server where the TFS component is installed. It must be properly configured for PowerShell Remoting in case it's a remote machine. Optionally, a System.Management.Automation.Runspaces.PSSession object pointing to a previously opened PowerShell Remote session can be provided instead. When omitted, defaults to the local machine where the script is being run</maml:para> </maml:description> <command:parameterValue required="true">PSSession</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.Runspaces.PSSession</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The user credentials to be used to access a remote machine. Those credentials must have the required permission to execute a PowerShell Remote session on that computer.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Management.Automation.PSCredential</dev:defaultValue> </command:parameter> <!-- Parameter: Version --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Version</maml:name> <maml:description> <maml:para>The TFS version number, represented by the year in its name. For e.g. TFS 2015, use "2015". When omitted, will default to the newest installed version of TFS / Azure DevOps Server</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ComputerName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>Specifies the name of a Team Foundation Server application tier from which to retrieve the connection string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>localhost</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The machine name of the server where the TFS component is installed. It must be properly configured for PowerShell Remoting in case it's a remote machine. Optionally, a System.Management.Automation.Runspaces.PSSession object pointing to a previously opened PowerShell Remote session can be provided instead. When omitted, defaults to the local machine where the script is being run</maml:para> </maml:description> <command:parameterValue required="true">PSSession</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.Runspaces.PSSession</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Version --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Version</maml:name> <maml:description> <maml:para>The TFS version number, represented by the year in its name. For e.g. TFS 2015, use "2015". When omitted, will default to the newest installed version of TFS / Azure DevOps Server</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The user credentials to be used to access a remote machine. Those credentials must have the required permission to execute a PowerShell Remote session on that computer.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Management.Automation.PSCredential</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: String --> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/Admin/Get-TfsConfigurationServerConnectionString</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/admin/get-tfsconfigurationserverconnectionstring/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TfsInstallationPath</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-TfsCredential --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="Connection"> <command:details> <command:name>New-TfsCredential</command:name> <command:verb>New</command:verb> <command:noun>TfsCredential</command:noun> <maml:description> <maml:para>Provides credentials to use when you connect to a Team Foundation Server or Azure DevOps organization.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: Cached credentials --> <command:syntaxItem tfscmdlets:parameterSet="Cached credentials"> <maml:name>New-TfsCredential</maml:name> <!-- Parameter: Url --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Url</maml:name> <maml:description> <maml:para>Specifies the URL of the server, collection or organization to connect to.</maml:para> </maml:description> <command:parameterValue required="true">Uri</command:parameterValue> <dev:type> <maml:name>System.Uri</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Cached --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Cached</maml:name> <maml:description> <maml:para>Specifies that cached (default) credentials should be used when possible/available.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter Set: User name and password --> <command:syntaxItem tfscmdlets:parameterSet="User name and password"> <maml:name>New-TfsCredential</maml:name> <!-- Parameter: Url --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Url</maml:name> <maml:description> <maml:para>Specifies the URL of the server, collection or organization to connect to.</maml:para> </maml:description> <command:parameterValue required="true">Uri</command:parameterValue> <dev:type> <maml:name>System.Uri</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>UserName</maml:name> <maml:description> <maml:para>Specifies a user name for authentication modes (such as Basic) that support username/password-based credentials. Must be used in conjunction with the -Password argument</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Password --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies a password for authentication modes (such as Basic) that support username/password-based credentials. Must be used in conjunction with the -UserName argument</maml:para> </maml:description> <command:parameterValue required="true">SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter Set: Credential object --> <command:syntaxItem tfscmdlets:parameterSet="Credential object"> <maml:name>New-TfsCredential</maml:name> <!-- Parameter: Url --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Url</maml:name> <maml:description> <maml:para>Specifies the URL of the server, collection or organization to connect to.</maml:para> </maml:description> <command:parameterValue required="true">Uri</command:parameterValue> <dev:type> <maml:name>System.Uri</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies a user account that has permission to perform this action. To provide a user name and password, a Personal Access Token, and/or to open a input dialog to enter your credentials, call Get-TfsCredential with the appropriate arguments and pass its return to this argument.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter Set: Personal Access Token --> <command:syntaxItem tfscmdlets:parameterSet="Personal Access Token"> <maml:name>New-TfsCredential</maml:name> <!-- Parameter: Url --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Url</maml:name> <maml:description> <maml:para>Specifies the URL of the server, collection or organization to connect to.</maml:para> </maml:description> <command:parameterValue required="true">Uri</command:parameterValue> <dev:type> <maml:name>System.Uri</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PersonalAccessToken --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="Pat"> <maml:name>PersonalAccessToken</maml:name> <maml:description> <maml:para>Specifies a personal access token, used as an alternate credential, to authenticate to Azure DevOps</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter Set: Prompt for credential --> <command:syntaxItem tfscmdlets:parameterSet="Prompt for credential"> <maml:name>New-TfsCredential</maml:name> <!-- Parameter: Url --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Url</maml:name> <maml:description> <maml:para>Specifies the URL of the server, collection or organization to connect to.</maml:para> </maml:description> <command:parameterValue required="true">Uri</command:parameterValue> <dev:type> <maml:name>System.Uri</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Interactive --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Interactive</maml:name> <maml:description> <maml:para>Prompts for user credentials. Can be used for any Team Foundation Server or Azure DevOps account - the proper login dialog is automatically selected. Should only be used in an interactive PowerShell session (i.e., a PowerShell terminal window), never in an unattended script (such as those executed during an automated build). Currently it is only supported in Windows PowerShell.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Url --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Url</maml:name> <maml:description> <maml:para>Specifies the URL of the server, collection or organization to connect to.</maml:para> </maml:description> <command:parameterValue required="true">Uri</command:parameterValue> <dev:type> <maml:name>System.Uri</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Cached --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Cached</maml:name> <maml:description> <maml:para>Specifies that cached (default) credentials should be used when possible/available.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UserName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>UserName</maml:name> <maml:description> <maml:para>Specifies a user name for authentication modes (such as Basic) that support username/password-based credentials. Must be used in conjunction with the -Password argument</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Password --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies a password for authentication modes (such as Basic) that support username/password-based credentials. Must be used in conjunction with the -UserName argument</maml:para> </maml:description> <command:parameterValue required="true">SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies a user account that has permission to perform this action. To provide a user name and password, a Personal Access Token, and/or to open a input dialog to enter your credentials, call Get-TfsCredential with the appropriate arguments and pass its return to this argument.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PersonalAccessToken --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="Pat"> <maml:name>PersonalAccessToken</maml:name> <maml:description> <maml:para>Specifies a personal access token, used as an alternate credential, to authenticate to Azure DevOps</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="Pat"> <maml:name>Pat</maml:name> <maml:description> <maml:para>Specifies a personal access token, used as an alternate credential, to authenticate to Azure DevOps</maml:para> <maml:para>This is an alias of the PersonalAccessToken parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Interactive --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Interactive</maml:name> <maml:description> <maml:para>Prompts for user credentials. Can be used for any Team Foundation Server or Azure DevOps account - the proper login dialog is automatically selected. Should only be used in an interactive PowerShell session (i.e., a PowerShell terminal window), never in an unattended script (such as those executed during an automated build). Currently it is only supported in Windows PowerShell.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: VssCredentials --> <command:returnValue> <dev:type> <maml:name>Microsoft.VisualStudio.Services.Common.VssCredentials</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/Connection/New-TfsCredential</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-TfsGitBranch --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="Git.Branch"> <command:details> <command:name>Get-TfsGitBranch</command:name> <command:verb>Get</command:verb> <command:noun>TfsGitBranch</command:noun> <maml:description> <maml:para>Gets information from one or more branches in a remote Git repository.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: Get by name --> <command:syntaxItem tfscmdlets:parameterSet="Get by name"> <maml:name>Get-TfsGitBranch</maml:name> <!-- Parameter: Branch --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="RefName"> <maml:name>Branch</maml:name> <maml:description> <maml:para>Specifies the name of a branch in the supplied Git repository. Wildcards are supported. When omitted, all branches are returned.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Repository --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Repository</maml:name> <maml:description> <maml:para>Specifies the target Git repository. Valid values are the name of the repository, its ID (a GUID), or a Microsoft.TeamFoundation.SourceControl.WebApi.GitRepository object obtained by e.g. a call to Get-TfsGitRepository. When omitted, it default to the team project name (i.e. the default repository).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter Set: Get default --> <command:syntaxItem tfscmdlets:parameterSet="Get default"> <maml:name>Get-TfsGitBranch</maml:name> <!-- Parameter: Default --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Default</maml:name> <maml:description> <maml:para>Returns the default branch in the given repository.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Repository --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Repository</maml:name> <maml:description> <maml:para>Specifies the target Git repository. Valid values are the name of the repository, its ID (a GUID), or a Microsoft.TeamFoundation.SourceControl.WebApi.GitRepository object obtained by e.g. a call to Get-TfsGitRepository. When omitted, it default to the team project name (i.e. the default repository).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Branch --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="RefName"> <maml:name>Branch</maml:name> <maml:description> <maml:para>Specifies the name of a branch in the supplied Git repository. Wildcards are supported. When omitted, all branches are returned.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="RefName"> <maml:name>RefName</maml:name> <maml:description> <maml:para>Specifies the name of a branch in the supplied Git repository. Wildcards are supported. When omitted, all branches are returned.</maml:para> <maml:para>This is an alias of the Branch parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: Default --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Default</maml:name> <maml:description> <maml:para>Returns the default branch in the given repository.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Repository --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Repository</maml:name> <maml:description> <maml:para>Specifies the target Git repository. Valid values are the name of the repository, its ID (a GUID), or a Microsoft.TeamFoundation.SourceControl.WebApi.GitRepository object obtained by e.g. a call to Get-TfsGitRepository. When omitted, it default to the team project name (i.e. the default repository).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the target Git repository. Valid values are the name of the repository, its ID (a GUID), or a Microsoft.TeamFoundation.SourceControl.WebApi.GitRepository object obtained by e.g. a call to Get-TfsGitRepository. When omitted, it default to the team project name (i.e. the default repository).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: GitBranchStats --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.SourceControl.WebApi.GitBranchStats</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/Git/Branch/Get-TfsGitBranch</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-TfsGitBranchPolicy --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="Git.Policy"> <command:details> <command:name>Get-TfsGitBranchPolicy</command:name> <command:verb>Get</command:verb> <command:noun>TfsGitBranchPolicy</command:noun> <maml:description> <maml:para>Gets the Git branch policy configuration of the given Git branches.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Get-TfsGitBranchPolicy</maml:name> <!-- Parameter: PolicyType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>PolicyType</maml:name> <maml:description> <maml:para>Specifies the policy type of the branch policy to return. Wildcards are supported. When omitted, all branch policies defined for the given branch are returned.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: Branch --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="RefName"> <maml:name>Branch</maml:name> <maml:description> <maml:para>Specifies the name of the branch to query for branch policies. When omitted, the default branch in the given repository is queried.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Repository --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Repository</maml:name> <maml:description> <maml:para>Specifies the target Git repository. Valid values are the name of the repository, its ID (a GUID), or a Microsoft.TeamFoundation.SourceControl.WebApi.GitRepository object obtained by e.g. a call to Get-TfsGitRepository. When omitted, it default to the team project name (i.e. the default repository).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: PolicyType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>PolicyType</maml:name> <maml:description> <maml:para>Specifies the policy type of the branch policy to return. Wildcards are supported. When omitted, all branch policies defined for the given branch are returned.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: Branch --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="RefName"> <maml:name>Branch</maml:name> <maml:description> <maml:para>Specifies the name of the branch to query for branch policies. When omitted, the default branch in the given repository is queried.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="RefName"> <maml:name>RefName</maml:name> <maml:description> <maml:para>Specifies the name of the branch to query for branch policies. When omitted, the default branch in the given repository is queried.</maml:para> <maml:para>This is an alias of the Branch parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Repository --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Repository</maml:name> <maml:description> <maml:para>Specifies the target Git repository. Valid values are the name of the repository, its ID (a GUID), or a Microsoft.TeamFoundation.SourceControl.WebApi.GitRepository object obtained by e.g. a call to Get-TfsGitRepository. When omitted, it default to the team project name (i.e. the default repository).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the name of the branch to query for branch policies. When omitted, the default branch in the given repository is queried.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: PolicyConfiguration --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.Policy.WebApi.PolicyConfiguration</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/Git/Policy/Get-TfsGitBranchPolicy</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-TfsGitPolicyType --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="Git.Policy"> <command:details> <command:name>Get-TfsGitPolicyType</command:name> <command:verb>Get</command:verb> <command:noun>TfsGitPolicyType</command:noun> <maml:description> <maml:para>Gets one or more Git branch policies supported by the given team project.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Get-TfsGitPolicyType</maml:name> <!-- Parameter: PolicyType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>PolicyType</maml:name> <maml:description> <maml:para>Specifies the display name or ID of the policy type. Wildcards are supported. When omitted, all policy types supported by the given team project are returned.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: PolicyType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>PolicyType</maml:name> <maml:description> <maml:para>Specifies the display name or ID of the policy type. Wildcards are supported. When omitted, all policy types supported by the given team project are returned.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the display name or ID of the policy type. Wildcards are supported. When omitted, all policy types supported by the given team project are returned.</maml:para> <maml:para>This is an alias of the PolicyType parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>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.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: PolicyType --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.Policy.WebApi.PolicyType</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/Git/Policy/Get-TfsGitPolicyType</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-TfsGitRepository --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="Git"> <command:details> <command:name>Get-TfsGitRepository</command:name> <command:verb>Get</command:verb> <command:noun>TfsGitRepository</command:noun> <maml:description> <maml:para>Gets information from one or more Git repositories in a team project.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Get-TfsGitRepository</maml:name> <!-- Parameter: Repository --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Repository</maml:name> <maml:description> <maml:para>Specifies the name or ID of a Git repository. Wildcards are supported. When omitted, all Git repositories in the supplied team project are returned.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Repository --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Repository</maml:name> <maml:description> <maml:para>Specifies the name or ID of a Git repository. Wildcards are supported. When omitted, all Git repositories in the supplied team project are returned.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name or ID of a Git repository. Wildcards are supported. When omitted, all Git repositories in the supplied team project are returned.</maml:para> <maml:para>This is an alias of the Repository parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>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.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: GitRepository --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.SourceControl.WebApi.GitRepository</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/Git/Get-TfsGitRepository</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-TfsGitRepository --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="Git"> <command:details> <command:name>New-TfsGitRepository</command:name> <command:verb>New</command:verb> <command:noun>TfsGitRepository</command:noun> <maml:description> <maml:para>Creates a new Git repository in a team project.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>New-TfsGitRepository</maml:name> <!-- Parameter: Repository --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Name"> <maml:name>Repository</maml:name> <maml:description> <maml:para>Specifies the name of the new repository</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Repository --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Name"> <maml:name>Repository</maml:name> <maml:description> <maml:para>Specifies the name of the new repository</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the new repository</maml:para> <maml:para>This is an alias of the Repository parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the name of the new repository</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: GitRepository --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.SourceControl.WebApi.GitRepository</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/Git/New-TfsGitRepository</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-TfsGitRepository --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="Git"> <command:details> <command:name>Remove-TfsGitRepository</command:name> <command:verb>Remove</command:verb> <command:noun>TfsGitRepository</command:noun> <maml:description> <maml:para>Deletes one or more Git repositories from a team project.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Remove-TfsGitRepository</maml:name> <!-- Parameter: Repository --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Name"> <maml:name>Repository</maml:name> <maml:description> <maml:para>Specifies the repository to be deleted. Value can be the name or ID of a Git repository, as well as a Microsoft.TeamFoundation.SourceControl.WebApi.GitRepository object representing a Git repository.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Repository --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Name"> <maml:name>Repository</maml:name> <maml:description> <maml:para>Specifies the repository to be deleted. Value can be the name or ID of a Git repository, as well as a Microsoft.TeamFoundation.SourceControl.WebApi.GitRepository object representing a Git repository.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the repository to be deleted. Value can be the name or ID of a Git repository, as well as a Microsoft.TeamFoundation.SourceControl.WebApi.GitRepository object representing a Git repository.</maml:para> <maml:para>This is an alias of the Repository parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the repository to be deleted. Value can be the name or ID of a Git repository, as well as a Microsoft.TeamFoundation.SourceControl.WebApi.GitRepository object representing a Git repository.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/Git/Remove-TfsGitRepository</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Rename-TfsGitRepository --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="Git"> <command:details> <command:name>Rename-TfsGitRepository</command:name> <command:verb>Rename</command:verb> <command:noun>TfsGitRepository</command:noun> <maml:description> <maml:para>Renames a Git repository in a team project.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Rename-TfsGitRepository</maml:name> <!-- Parameter: Repository --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Repository</maml:name> <maml:description> <maml:para>Specifies the repository to be renamed. Value can be the name or ID of a Git repository, as well as a Microsoft.TeamFoundation.SourceControl.WebApi.GitRepository object representing a Git repository.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NewName</maml:name> <maml:description> <maml:para>Specifies the new name of the item. Enter only a name, not a path and name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Repository --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Repository</maml:name> <maml:description> <maml:para>Specifies the repository to be renamed. Value can be the name or ID of a Git repository, as well as a Microsoft.TeamFoundation.SourceControl.WebApi.GitRepository object representing a Git repository.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NewName</maml:name> <maml:description> <maml:para>Specifies the new name of the item. Enter only a name, not a path and name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the repository to be renamed. Value can be the name or ID of a Git repository, as well as a Microsoft.TeamFoundation.SourceControl.WebApi.GitRepository object representing a Git repository.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: GitRepository --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.SourceControl.WebApi.GitRepository</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/Git/Rename-TfsGitRepository</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Export-TfsGlobalList --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="GlobalList"> <command:details> <command:name>Export-TfsGlobalList</command:name> <command:verb>Export</command:verb> <command:noun>TfsGlobalList</command:noun> <maml:description> <maml:para>Exports the contents of one or more Global Lists to XML.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlets generates an XML containing one or more global lists and their respective items, in the same format used by witadmin. It is functionally equivalent to "witadmin exportgloballist"</maml:para> </maml:description> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Export-TfsGlobalList</maml:name> <!-- Parameter: GlobalList --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>GlobalList</maml:name> <maml:description> <maml:para>Specifies the name of the global list to be exported. Wildcards are supported. When omitted, it defaults to all global lists in the supplied team project collection. When using wilcards, a single XML document will be producer containing all matching global lists.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: GlobalList --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>GlobalList</maml:name> <maml:description> <maml:para>Specifies the name of the global list to be exported. Wildcards are supported. When omitted, it defaults to all global lists in the supplied team project collection. When using wilcards, a single XML document will be producer containing all matching global lists.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the global list to be exported. Wildcards are supported. When omitted, it defaults to all global lists in the supplied team project collection. When using wilcards, a single XML document will be producer containing all matching global lists.</maml:para> <maml:para>This is an alias of the GlobalList parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>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).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: String --> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS> Export-TfsGlobalList | Out-File "gl.xml"</dev:code> <dev:remarks> <maml:para>Exports all global lists in the current project collection to a file called gl.xml.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS> Export-TfsGlobalList -Name "Builds - *"</dev:code> <dev:remarks> <maml:para>Exports all build-related global lists (with names starting with "Build - ") and return the resulting XML document.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/GlobalList/Export-TfsGlobalList</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-TfsGlobalList --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="GlobalList"> <command:details> <command:name>Get-TfsGlobalList</command:name> <command:verb>Get</command:verb> <command:noun>TfsGlobalList</command:noun> <maml:description> <maml:para>Gets the contents of one or more Global Lists.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Get-TfsGlobalList</maml:name> <!-- Parameter: GlobalList --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>GlobalList</maml:name> <maml:description> <maml:para>Specifies the name of the global list. Wildcards are supported. When omitted, defaults to all global lists in the supplied team project collection.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: GlobalList --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>GlobalList</maml:name> <maml:description> <maml:para>Specifies the name of the global list. Wildcards are supported. When omitted, defaults to all global lists in the supplied team project collection.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the global list. Wildcards are supported. When omitted, defaults to all global lists in the supplied team project collection.</maml:para> <maml:para>This is an alias of the GlobalList parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>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).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: GlobalList --> <command:returnValue> <dev:type> <maml:name>TfsCmdlets.Models.GlobalList</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/GlobalList/Get-TfsGlobalList</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Import-TfsGlobalList --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="GlobalList"> <command:details> <command:name>Import-TfsGlobalList</command:name> <command:verb>Import</command:verb> <command:noun>TfsGlobalList</command:noun> <maml:description> <maml:para>Imports one or more Global Lists from an XML document</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdletsimports an XML containing one or more global lists and their respective items, in the same format used by witadmin. It is functionally equivalent to "witadmin importgloballist"</maml:para> </maml:description> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Import-TfsGlobalList</maml:name> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Xml"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>XML document object containing one or more global list definitions.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Allows the cmdlet to import a global list that already exists.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Xml"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>XML document object containing one or more global list definitions.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Xml"> <maml:name>Xml</maml:name> <maml:description> <maml:para>XML document object containing one or more global list definitions.</maml:para> <maml:para>This is an alias of the InputObject parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Allows the cmdlet to import a global list that already exists.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>XML document object containing one or more global list definitions.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS> Get-Content gl.xml | Import-GlobalList</dev:code> <dev:remarks> <maml:para>Imports the contents of an XML document called gl.xml to the current project collection</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/GlobalList/Import-TfsGlobalList</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-TfsGlobalList --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="GlobalList"> <command:details> <command:name>New-TfsGlobalList</command:name> <command:verb>New</command:verb> <command:noun>TfsGlobalList</command:noun> <maml:description> <maml:para>Creates a new Global List.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>New-TfsGlobalList</maml:name> <!-- Parameter: GlobalList --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="Name"> <maml:name>GlobalList</maml:name> <maml:description> <maml:para>Specifies the name of the new global list.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Items --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Items</maml:name> <maml:description> <maml:para>Specifies the contents (items) of the new global list.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Allows the cmdlet to overwrite an existing global list.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: GlobalList --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="Name"> <maml:name>GlobalList</maml:name> <maml:description> <maml:para>Specifies the name of the new global list.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the new global list.</maml:para> <maml:para>This is an alias of the GlobalList parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Items --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Items</maml:name> <maml:description> <maml:para>Specifies the contents (items) of the new global list.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Allows the cmdlet to overwrite an existing global list.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the name of the new global list.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the contents (items) of the new global list.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: PSCustomObject --> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/GlobalList/New-TfsGlobalList</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-TfsGlobalList --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="GlobalList"> <command:details> <command:name>Remove-TfsGlobalList</command:name> <command:verb>Remove</command:verb> <command:noun>TfsGlobalList</command:noun> <maml:description> <maml:para>Deletes one or more Global Lists.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Remove-TfsGlobalList</maml:name> <!-- Parameter: GlobalList --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="Name"> <maml:name>GlobalList</maml:name> <maml:description> <maml:para>Specifies the name of global list to be deleted. Wildcards are supported.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: GlobalList --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="Name"> <maml:name>GlobalList</maml:name> <maml:description> <maml:para>Specifies the name of global list to be deleted. Wildcards are supported.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of global list to be deleted. Wildcards are supported.</maml:para> <maml:para>This is an alias of the GlobalList parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the name of global list to be deleted. Wildcards are supported.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/GlobalList/Remove-TfsGlobalList</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Rename-TfsGlobalList --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="GlobalList"> <command:details> <command:name>Rename-TfsGlobalList</command:name> <command:verb>Rename</command:verb> <command:noun>TfsGlobalList</command:noun> <maml:description> <maml:para>Changes either the name or the contents of a Global List.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Rename-TfsGlobalList</maml:name> <!-- Parameter: GlobalList --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="Name"> <maml:name>GlobalList</maml:name> <maml:description> <maml:para>Specifies the name of the global lsit to be renamed.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NewName</maml:name> <maml:description> <maml:para>Specifies the new name of the item. Enter only a name - i.e., for items that support paths, do not enter a path and name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: GlobalList --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="Name"> <maml:name>GlobalList</maml:name> <maml:description> <maml:para>Specifies the name of the global lsit to be renamed.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the global lsit to be renamed.</maml:para> <maml:para>This is an alias of the GlobalList parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NewName</maml:name> <maml:description> <maml:para>Specifies the new name of the item. Enter only a name - i.e., for items that support paths, do not enter a path and name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the name of the global lsit to be renamed.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/GlobalList/Rename-TfsGlobalList</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-TfsGlobalList --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="GlobalList"> <command:details> <command:name>Set-TfsGlobalList</command:name> <command:verb>Set</command:verb> <command:noun>TfsGlobalList</command:noun> <maml:description> <maml:para>Changes the contents of a Global List.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: Edit list items --> <command:syntaxItem tfscmdlets:parameterSet="Edit list items"> <maml:name>Set-TfsGlobalList</maml:name> <!-- Parameter: GlobalList --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Name"> <maml:name>GlobalList</maml:name> <maml:description> <maml:para>Specifies the name of the global list to be changed.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Add --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Add</maml:name> <maml:description> <maml:para>Specifies a list of items to be added to the global list.</maml:para> </maml:description> <command:parameterValue required="true">IEnumerable`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.IEnumerable`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Creates a new list if the specified one does not exist.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Remove --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Remove</maml:name> <maml:description> <maml:para>Specifies a list of items to be removed from the global list.</maml:para> </maml:description> <command:parameterValue required="true">IEnumerable`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.IEnumerable`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: GlobalList --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Name"> <maml:name>GlobalList</maml:name> <maml:description> <maml:para>Specifies the name of the global list to be changed.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the global list to be changed.</maml:para> <maml:para>This is an alias of the GlobalList parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Add --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Add</maml:name> <maml:description> <maml:para>Specifies a list of items to be added to the global list.</maml:para> </maml:description> <command:parameterValue required="true">IEnumerable`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.IEnumerable`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Remove --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Remove</maml:name> <maml:description> <maml:para>Specifies a list of items to be removed from the global list.</maml:para> </maml:description> <command:parameterValue required="true">IEnumerable`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.IEnumerable`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Creates a new list if the specified one does not exist.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the name of the global list to be changed.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/GlobalList/Set-TfsGlobalList</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Add-TfsGroupMember --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="Identity.Group"> <command:details> <command:name>Add-TfsGroupMember</command:name> <command:verb>Add</command:verb> <command:noun>TfsGroupMember</command:noun> <maml:description> <maml:para>Adds group members to an Azure DevOps group.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Add-TfsGroupMember</maml:name> <!-- Parameter: Member --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Member</maml:name> <maml:description> <maml:para>Specifies the member (user or group) to add to the given group.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Group --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Group</maml:name> <maml:description> <maml:para>Specifies the group to which the member is added.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Member --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Member</maml:name> <maml:description> <maml:para>Specifies the member (user or group) to add to the given group.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Group --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Group</maml:name> <maml:description> <maml:para>Specifies the group to which the member is added.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the member (user or group) to add to the given group.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/Identity/Group/Add-TfsGroupMember</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-TfsGroupMember --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="Identity.Group"> <command:details> <command:name>Get-TfsGroupMember</command:name> <command:verb>Get</command:verb> <command:noun>TfsGroupMember</command:noun> <maml:description> <maml:para>Gets the members of a Azure DevOps group</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Get-TfsGroupMember</maml:name> <!-- Parameter: Group --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Group</maml:name> <maml:description> <maml:para>Specifies the group fom which to get its members.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Member --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Member</maml:name> <maml:description> <maml:para>Specifies the member (user or group) to get from the given group. Wildcards are supported. When omitted, all group members are returned.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Recurse --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>Recursively expands all member groups, returning the users and/or groups contained in them</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Group --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Group</maml:name> <maml:description> <maml:para>Specifies the group fom which to get its members.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Member --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Member</maml:name> <maml:description> <maml:para>Specifies the member (user or group) to get from the given group. Wildcards are supported. When omitted, all group members are returned.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: Recurse --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>Recursively expands all member groups, returning the users and/or groups contained in them</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the group fom which to get its members.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Identity --> <command:returnValue> <dev:type> <maml:name>Microsoft.VisualStudio.Services.Identity.Identity</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/Identity/Group/Get-TfsGroupMember</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-TfsGroupMember --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="Identity.Group"> <command:details> <command:name>Remove-TfsGroupMember</command:name> <command:verb>Remove</command:verb> <command:noun>TfsGroupMember</command:noun> <maml:description> <maml:para>Removes a member from an Azure DevOps group.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Remove-TfsGroupMember</maml:name> <!-- Parameter: Member --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Member</maml:name> <maml:description> <maml:para>Specifies the member (user or group) to remove from the given group.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Group --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Group</maml:name> <maml:description> <maml:para>Specifies the group from which the member is removed.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Member --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Member</maml:name> <maml:description> <maml:para>Specifies the member (user or group) to remove from the given group.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Group --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Group</maml:name> <maml:description> <maml:para>Specifies the group from which the member is removed.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the member (user or group) to remove from the given group.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/Identity/Group/Remove-TfsGroupMember</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-TfsIdentity --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="Identity"> <command:details> <command:name>Get-TfsIdentity</command:name> <command:verb>Get</command:verb> <command:noun>TfsIdentity</command:noun> <maml:description> <maml:para>Gets one or more identities that represents either users or groups in Azure DevOps.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: Get Identity --> <command:syntaxItem tfscmdlets:parameterSet="Get Identity"> <maml:name>Get-TfsIdentity</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specifies the user or group to be retrieved. Supported values are: User/group name, email, or ID</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: QueryMembership --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>QueryMembership</maml:name> <maml:description> <maml:para>Specifies how group membership information should be processed when the returned identity is a group. "Direct" fetches direct members (both users and groups) of the group. "Expanded" expands contained groups recursively and returns their contained users. "None" is the fastest option as it fetches no membership information. When omitted, defaults to Direct.</maml:para> <maml:para>Possible values: None, Direct, Expanded, ExpandedUp, ExpandedDown</maml:para> </maml:description> <command:parameterValue required="true">QueryMembership</command:parameterValue> <dev:type> <maml:name>Microsoft.VisualStudio.Services.Identity.QueryMembership</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Direct</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Direct</command:parameterValue> <command:parameterValue required="false" variableLength="false">Expanded</command:parameterValue> <command:parameterValue required="false" variableLength="false">ExpandedUp</command:parameterValue> <command:parameterValue required="false" variableLength="false">ExpandedDown</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter Set: Get current user --> <command:syntaxItem tfscmdlets:parameterSet="Get current user"> <maml:name>Get-TfsIdentity</maml:name> <!-- Parameter: Current --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Current</maml:name> <maml:description> <maml:para>Returns an identity representing the user currently logged in to the Azure DevOps / TFS instance</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specifies the user or group to be retrieved. Supported values are: User/group name, email, or ID</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: QueryMembership --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>QueryMembership</maml:name> <maml:description> <maml:para>Specifies how group membership information should be processed when the returned identity is a group. "Direct" fetches direct members (both users and groups) of the group. "Expanded" expands contained groups recursively and returns their contained users. "None" is the fastest option as it fetches no membership information. When omitted, defaults to Direct.</maml:para> <maml:para>Possible values: None, Direct, Expanded, ExpandedUp, ExpandedDown</maml:para> </maml:description> <command:parameterValue required="true">QueryMembership</command:parameterValue> <dev:type> <maml:name>Microsoft.VisualStudio.Services.Identity.QueryMembership</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Direct</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Direct</command:parameterValue> <command:parameterValue required="false" variableLength="false">Expanded</command:parameterValue> <command:parameterValue required="false" variableLength="false">ExpandedUp</command:parameterValue> <command:parameterValue required="false" variableLength="false">ExpandedDown</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Current --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Current</maml:name> <maml:description> <maml:para>Returns an identity representing the user currently logged in to the Azure DevOps / TFS instance</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>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.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Identity --> <command:returnValue> <dev:type> <maml:name>Microsoft.VisualStudio.Services.Identity.Identity</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/Identity/Get-TfsIdentity</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Start-TfsIdentitySync --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="Admin"> <command:details> <command:name>Start-TfsIdentitySync</command:name> <command:verb>Start</command:verb> <command:noun>TfsIdentitySync</command:noun> <maml:description> <maml:para>Triggers an Identity Sync server job.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Start-TfsIdentitySync</maml:name> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Server</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies a user account that has permission to perform this action. To provide a user name and password, a Personal Access Token, and/or to open a input dialog to enter your credentials, call Get-TfsCredential with the appropriate arguments and pass its return to this argument.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Wait --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Wait</maml:name> <maml:description> <maml:para>Waits until the job finishes running. If omitted, the identity sync job will run asynchronously.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Server</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Wait --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Wait</maml:name> <maml:description> <maml:para>Waits until the job finishes running. If omitted, the identity sync job will run asynchronously.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies a user account that has permission to perform this action. To provide a user name and password, a Personal Access Token, and/or to open a input dialog to enter your credentials, call Get-TfsCredential with the appropriate arguments and pass its return to this argument.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>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.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/Admin/Start-TfsIdentitySync</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-TfsInstallationPath --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="Admin"> <command:details> <command:name>Get-TfsInstallationPath</command:name> <command:verb>Get</command:verb> <command:noun>TfsInstallationPath</command:noun> <maml:description> <maml:para>Gets the installation path of a given Team Foundation Server component.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Many times a Team Foundation Server admin needs to retrieve the location where TFS is actually installed. That can be useful, for instance, to locate tools like TfsSecurity or TfsServiceControl. That information is recorded at setup time, in a well-known location in the Windows Registry of the server where TFS is installed.</maml:para> </maml:description> <command:syntax> <!-- Parameter Set: Use computer name --> <command:syntaxItem tfscmdlets:parameterSet="Use computer name"> <maml:name>Get-TfsInstallationPath</maml:name> <!-- Parameter: Component --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Component</maml:name> <maml:description> <maml:para>Indicates the TFS component whose installation path is being searched for. For the main TFS installation directory, use BaseInstallation. When omitted, defaults to BaseInstallation.</maml:para> <maml:para>Possible values: BaseInstallation, ApplicationTier, SharePointExtensions, TeamBuild, Tools, VersionControlProxy</maml:para> </maml:description> <command:parameterValue required="true">TfsComponent</command:parameterValue> <dev:type> <maml:name>TfsCmdlets.TfsComponent</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>BaseInstallation</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">BaseInstallation</command:parameterValue> <command:parameterValue required="false" variableLength="false">ApplicationTier</command:parameterValue> <command:parameterValue required="false" variableLength="false">SharePointExtensions</command:parameterValue> <command:parameterValue required="false" variableLength="false">TeamBuild</command:parameterValue> <command:parameterValue required="false" variableLength="false">Tools</command:parameterValue> <command:parameterValue required="false" variableLength="false">VersionControlProxy</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ComputerName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>The machine name of the server where the TFS component is installed. It must be properly configured for PowerShell Remoting in case it's a remote machine. Optionally, a System.Management.Automation.Runspaces.PSSession object pointing to a previously opened PowerShell Remote session can be provided instead. When omitted, defaults to the local machine where the script is being run</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>localhost</dev:defaultValue> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The user credentials to be used to access a remote machine. Those credentials must have the required permission to execute a PowerShell Remote session on that computer and also the permission to access the Windows Registry.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Management.Automation.PSCredential</dev:defaultValue> </command:parameter> <!-- Parameter: Version --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Version</maml:name> <maml:description> <maml:para>The TFS version number, represented by the year in its name. For e.g. TFS 2015, use "2015". When omitted, will default to the newest installed version of TFS / Azure DevOps Server</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter Set: Use session --> <command:syntaxItem tfscmdlets:parameterSet="Use session"> <maml:name>Get-TfsInstallationPath</maml:name> <!-- Parameter: Session --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The machine name of the server where the TFS component is installed. It must be properly configured for PowerShell Remoting in case it's a remote machine. Optionally, a System.Management.Automation.Runspaces.PSSession object pointing to a previously opened PowerShell Remote session can be provided instead. When omitted, defaults to the local machine where the script is being run</maml:para> </maml:description> <command:parameterValue required="true">PSSession</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.Runspaces.PSSession</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Component --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Component</maml:name> <maml:description> <maml:para>Indicates the TFS component whose installation path is being searched for. For the main TFS installation directory, use BaseInstallation. When omitted, defaults to BaseInstallation.</maml:para> <maml:para>Possible values: BaseInstallation, ApplicationTier, SharePointExtensions, TeamBuild, Tools, VersionControlProxy</maml:para> </maml:description> <command:parameterValue required="true">TfsComponent</command:parameterValue> <dev:type> <maml:name>TfsCmdlets.TfsComponent</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>BaseInstallation</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">BaseInstallation</command:parameterValue> <command:parameterValue required="false" variableLength="false">ApplicationTier</command:parameterValue> <command:parameterValue required="false" variableLength="false">SharePointExtensions</command:parameterValue> <command:parameterValue required="false" variableLength="false">TeamBuild</command:parameterValue> <command:parameterValue required="false" variableLength="false">Tools</command:parameterValue> <command:parameterValue required="false" variableLength="false">VersionControlProxy</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The user credentials to be used to access a remote machine. Those credentials must have the required permission to execute a PowerShell Remote session on that computer and also the permission to access the Windows Registry.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Management.Automation.PSCredential</dev:defaultValue> </command:parameter> <!-- Parameter: Version --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Version</maml:name> <maml:description> <maml:para>The TFS version number, represented by the year in its name. For e.g. TFS 2015, use "2015". When omitted, will default to the newest installed version of TFS / Azure DevOps Server</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ComputerName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>The machine name of the server where the TFS component is installed. It must be properly configured for PowerShell Remoting in case it's a remote machine. Optionally, a System.Management.Automation.Runspaces.PSSession object pointing to a previously opened PowerShell Remote session can be provided instead. When omitted, defaults to the local machine where the script is being run</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>localhost</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The machine name of the server where the TFS component is installed. It must be properly configured for PowerShell Remoting in case it's a remote machine. Optionally, a System.Management.Automation.Runspaces.PSSession object pointing to a previously opened PowerShell Remote session can be provided instead. When omitted, defaults to the local machine where the script is being run</maml:para> </maml:description> <command:parameterValue required="true">PSSession</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.Runspaces.PSSession</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Component --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Component</maml:name> <maml:description> <maml:para>Indicates the TFS component whose installation path is being searched for. For the main TFS installation directory, use BaseInstallation. When omitted, defaults to BaseInstallation.</maml:para> <maml:para>Possible values: BaseInstallation, ApplicationTier, SharePointExtensions, TeamBuild, Tools, VersionControlProxy</maml:para> </maml:description> <command:parameterValue required="true">TfsComponent</command:parameterValue> <dev:type> <maml:name>TfsCmdlets.TfsComponent</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>BaseInstallation</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">BaseInstallation</command:parameterValue> <command:parameterValue required="false" variableLength="false">ApplicationTier</command:parameterValue> <command:parameterValue required="false" variableLength="false">SharePointExtensions</command:parameterValue> <command:parameterValue required="false" variableLength="false">TeamBuild</command:parameterValue> <command:parameterValue required="false" variableLength="false">Tools</command:parameterValue> <command:parameterValue required="false" variableLength="false">VersionControlProxy</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Version --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Version</maml:name> <maml:description> <maml:para>The TFS version number, represented by the year in its name. For e.g. TFS 2015, use "2015". When omitted, will default to the newest installed version of TFS / Azure DevOps Server</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The user credentials to be used to access a remote machine. Those credentials must have the required permission to execute a PowerShell Remote session on that computer and also the permission to access the Windows Registry.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Management.Automation.PSCredential</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: String --> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS> Get-TfsInstallationPath -Version 2017</dev:code> <dev:remarks> <maml:para>Gets the root folder (the BaseInstallationPath) of TFS in the local server where the cmdlet is being run</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS> Get-TfsInstallationPath -Computer SPTFSSRV -Version 2015 -Component SharepointExtensions -Credentials (Get-Credentials)</dev:code> <dev:remarks> <maml:para>Gets the location where the SharePoint Extensions have been installed in the remote server SPTFSSRV, prompting for admin credentials to be used for establishing a PS Remoting session to the server</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/Admin/Get-TfsInstallationPath</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-TfsIteration --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="WorkItem.AreasIterations"> <command:details> <command:name>Get-TfsIteration</command:name> <command:verb>Get</command:verb> <command:noun>TfsIteration</command:noun> <maml:description> <maml:para>Gets one or more Iterations from a given Team Project.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Get-TfsIteration</maml:name> <!-- Parameter: Node --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Path,Iteration"> <maml:name>Node</maml:name> <maml:description> <maml:para>Specifies the name, URI or path of an Iteration. Wildcards are supported. When omitted, all Iterations in the given Team Project are returned.nnTo supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional.nnWhen supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>\**</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Node --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Path,Iteration"> <maml:name>Node</maml:name> <maml:description> <maml:para>Specifies the name, URI or path of an Iteration. Wildcards are supported. When omitted, all Iterations in the given Team Project are returned.nnTo supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional.nnWhen supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>\**</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Path,Iteration"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the name, URI or path of an Iteration. Wildcards are supported. When omitted, all Iterations in the given Team Project are returned.nnTo supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional.nnWhen supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> <maml:para>This is an alias of the Node parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>\**</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Path,Iteration"> <maml:name>Iteration</maml:name> <maml:description> <maml:para>Specifies the name, URI or path of an Iteration. Wildcards are supported. When omitted, all Iterations in the given Team Project are returned.nnTo supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional.nnWhen supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> <maml:para>This is an alias of the Node parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>\**</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>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.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: WorkItemClassificationNode --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemClassificationNode</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS> Get-TfsIteration</dev:code> <dev:remarks> <maml:para>Returns all iterations in the currently connected Team Project (as defined by a previous call to Connect-TfsTeamProject)</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS> Get-TfsIteration '\**\Support' -Project Tailspin</dev:code> <dev:remarks> <maml:para>Performs a recursive search and returns all iterations named 'Support' that may exist in a team project called Tailspin</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/WorkItem/AreasIterations/Get-TfsIteration</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Move-TfsIteration --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="WorkItem.AreasIterations"> <command:details> <command:name>Move-TfsIteration</command:name> <command:verb>Move</command:verb> <command:noun>TfsIteration</command:noun> <maml:description> <maml:para>Gets one or more Iterations from a given Team Project.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Move-TfsIteration</maml:name> <!-- Parameter: Node --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Path,Iteration"> <maml:name>Node</maml:name> <maml:description> <maml:para>Specifies the name, URI or path of an Iteration. Wildcards are supported. When omitted, all Iterations in the given Team Project are returned.nnTo supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional.nnWhen supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>\**</dev:defaultValue> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1" aliases="MoveTo"> <maml:name>Destination</maml:name> <maml:description> <maml:para>Specifies the name and/or path of the destination parent node.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Allows the cmdlet to create destination parent node(s) if they're missing.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Node --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Path,Iteration"> <maml:name>Node</maml:name> <maml:description> <maml:para>Specifies the name, URI or path of an Iteration. Wildcards are supported. When omitted, all Iterations in the given Team Project are returned.nnTo supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional.nnWhen supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>\**</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Path,Iteration"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the name, URI or path of an Iteration. Wildcards are supported. When omitted, all Iterations in the given Team Project are returned.nnTo supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional.nnWhen supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> <maml:para>This is an alias of the Node parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>\**</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Path,Iteration"> <maml:name>Iteration</maml:name> <maml:description> <maml:para>Specifies the name, URI or path of an Iteration. Wildcards are supported. When omitted, all Iterations in the given Team Project are returned.nnTo supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional.nnWhen supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> <maml:para>This is an alias of the Node parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>\**</dev:defaultValue> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1" aliases="MoveTo"> <maml:name>Destination</maml:name> <maml:description> <maml:para>Specifies the name and/or path of the destination parent node.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="1" aliases="MoveTo"> <maml:name>MoveTo</maml:name> <maml:description> <maml:para>Specifies the name and/or path of the destination parent node.</maml:para> <maml:para>This is an alias of the Destination parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Allows the cmdlet to create destination parent node(s) if they're missing.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the name, URI or path of an Iteration. Wildcards are supported. When omitted, all Iterations in the given Team Project are returned.nnTo supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional.nnWhen supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: WorkItemClassificationNode --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemClassificationNode</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS> Get-TfsIteration</dev:code> <dev:remarks> <maml:para>Returns all aiterations in the currently connected Team Project (as defined by a previous call to Connect-TfsTeamProject)</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS> Get-TfsIteration '\\**\\Support' -Project Tailspin</dev:code> <dev:remarks> <maml:para>Performs a recursive search and returns all iterations named 'Support' that may exist in a team project called Tailspin</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/WorkItem/AreasIterations/Move-TfsIteration</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-TfsIteration --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="WorkItem.AreasIterations"> <command:details> <command:name>New-TfsIteration</command:name> <command:verb>New</command:verb> <command:noun>TfsIteration</command:noun> <maml:description> <maml:para>Creates a new Iteration in the given Team Project.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>New-TfsIteration</maml:name> <!-- Parameter: Node --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Iteration,Path"> <maml:name>Node</maml:name> <maml:description> <maml:para>Specifies the path of the new Iteration. When supplying a path, use a backslash ("\\") between the path segments. Leading and trailing backslashes are optional. The last segment in the path will be the iteration name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Allows the cmdlet to create parent nodes if they're missing.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Node --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Iteration,Path"> <maml:name>Node</maml:name> <maml:description> <maml:para>Specifies the path of the new Iteration. When supplying a path, use a backslash ("\\") between the path segments. Leading and trailing backslashes are optional. The last segment in the path will be the iteration name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Iteration,Path"> <maml:name>Iteration</maml:name> <maml:description> <maml:para>Specifies the path of the new Iteration. When supplying a path, use a backslash ("\\") between the path segments. Leading and trailing backslashes are optional. The last segment in the path will be the iteration name.</maml:para> <maml:para>This is an alias of the Node parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Iteration,Path"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the path of the new Iteration. When supplying a path, use a backslash ("\\") between the path segments. Leading and trailing backslashes are optional. The last segment in the path will be the iteration name.</maml:para> <maml:para>This is an alias of the Node parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Allows the cmdlet to create parent nodes if they're missing.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the path of the new Iteration. When supplying a path, use a backslash ("\\") between the path segments. Leading and trailing backslashes are optional. The last segment in the path will be the iteration name.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: WorkItemClassificationNode --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemClassificationNode</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/WorkItem/AreasIterations/New-TfsIteration</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-TfsIteration --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="WorkItem.AreasIterations"> <command:details> <command:name>Remove-TfsIteration</command:name> <command:verb>Remove</command:verb> <command:noun>TfsIteration</command:noun> <maml:description> <maml:para>Deletes one or more Iterations from a given Team Project.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Remove-TfsIteration</maml:name> <!-- Parameter: Node --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Path,Iteration"> <maml:name>Node</maml:name> <maml:description> <maml:para>Specifies the name, URI or path of an Iteration. Wildcards are supported. When omitted, all Iterations in the given Team Project are returned.nnTo supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional.nnWhen supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MoveTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1" aliases="NewPath"> <maml:name>MoveTo</maml:name> <maml:description> <maml:para>Specifies the new parent node for the work items currently assigned to the node being deleted, if any. When omitted, defaults to the root node (the "\" node, at the team project level).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>\</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Recurse --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>Removes node(s) recursively.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Node --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Path,Iteration"> <maml:name>Node</maml:name> <maml:description> <maml:para>Specifies the name, URI or path of an Iteration. Wildcards are supported. When omitted, all Iterations in the given Team Project are returned.nnTo supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional.nnWhen supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Path,Iteration"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the name, URI or path of an Iteration. Wildcards are supported. When omitted, all Iterations in the given Team Project are returned.nnTo supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional.nnWhen supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> <maml:para>This is an alias of the Node parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Path,Iteration"> <maml:name>Iteration</maml:name> <maml:description> <maml:para>Specifies the name, URI or path of an Iteration. Wildcards are supported. When omitted, all Iterations in the given Team Project are returned.nnTo supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional.nnWhen supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> <maml:para>This is an alias of the Node parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MoveTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1" aliases="NewPath"> <maml:name>MoveTo</maml:name> <maml:description> <maml:para>Specifies the new parent node for the work items currently assigned to the node being deleted, if any. When omitted, defaults to the root node (the "\" node, at the team project level).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>\</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="1" aliases="NewPath"> <maml:name>NewPath</maml:name> <maml:description> <maml:para>Specifies the new parent node for the work items currently assigned to the node being deleted, if any. When omitted, defaults to the root node (the "\" node, at the team project level).</maml:para> <maml:para>This is an alias of the MoveTo parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>\</dev:defaultValue> </command:parameter> <!-- Parameter: Recurse --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>Removes node(s) recursively.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the name, URI or path of an Iteration. Wildcards are supported. When omitted, all Iterations in the given Team Project are returned.nnTo supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional.nnWhen supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: WorkItemClassificationNode --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemClassificationNode</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/WorkItem/AreasIterations/Remove-TfsIteration</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Rename-TfsIteration --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="WorkItem.AreasIterations"> <command:details> <command:name>Rename-TfsIteration</command:name> <command:verb>Rename</command:verb> <command:noun>TfsIteration</command:noun> <maml:description> <maml:para>Renames a Iteration.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Rename-TfsIteration</maml:name> <!-- Parameter: Node --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Path,Iteration"> <maml:name>Node</maml:name> <maml:description> <maml:para>Specifies the name, URI or path of an Iteration. Wildcards are supported. When omitted, all Iterations in the given Team Project are returned.nnTo supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional.nnWhen supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NewName</maml:name> <maml:description> <maml:para>Specifies the new name of the item. Enter only a name - i.e., for items that support paths, do not enter a path and name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Node --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Path,Iteration"> <maml:name>Node</maml:name> <maml:description> <maml:para>Specifies the name, URI or path of an Iteration. Wildcards are supported. When omitted, all Iterations in the given Team Project are returned.nnTo supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional.nnWhen supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Path,Iteration"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the name, URI or path of an Iteration. Wildcards are supported. When omitted, all Iterations in the given Team Project are returned.nnTo supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional.nnWhen supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> <maml:para>This is an alias of the Node parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Path,Iteration"> <maml:name>Iteration</maml:name> <maml:description> <maml:para>Specifies the name, URI or path of an Iteration. Wildcards are supported. When omitted, all Iterations in the given Team Project are returned.nnTo supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional.nnWhen supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> <maml:para>This is an alias of the Node parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NewName</maml:name> <maml:description> <maml:para>Specifies the new name of the item. Enter only a name - i.e., for items that support paths, do not enter a path and name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the name, URI or path of an Iteration. Wildcards are supported. When omitted, all Iterations in the given Team Project are returned.nnTo supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional.nnWhen supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: WorkItemClassificationNode --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemClassificationNode</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/WorkItem/AreasIterations/Rename-TfsIteration</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-TfsIteration --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="WorkItem.AreasIterations"> <command:details> <command:name>Set-TfsIteration</command:name> <command:verb>Set</command:verb> <command:noun>TfsIteration</command:noun> <maml:description> <maml:para>Modifies the dates of an iteration.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Set-TfsIteration</maml:name> <!-- Parameter: Node --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Path,Iteration"> <maml:name>Node</maml:name> <maml:description> <maml:para>Specifies the name, URI or path of an Iteration. Wildcards are supported. When omitted, all Iterations in the given Team Project are returned.nnTo supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional.nnWhen supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FinishDate --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FinishDate</maml:name> <maml:description> <maml:para>Sets the finish date of the iteration. To clear the finish date, set it to $null. Note that when clearing a date, both must be cleared at the same time (i.e. setting both StartDate and FinishDate to $null).</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StartDate --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>StartDate</maml:name> <maml:description> <maml:para>Specifies the start date of the iteration. To clear the start date, set it to $null. Note that when clearing a date, both must be cleared at the same time (i.e. setting both StartDate and FinishDate to $null).</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Node --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Path,Iteration"> <maml:name>Node</maml:name> <maml:description> <maml:para>Specifies the name, URI or path of an Iteration. Wildcards are supported. When omitted, all Iterations in the given Team Project are returned.nnTo supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional.nnWhen supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Path,Iteration"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the name, URI or path of an Iteration. Wildcards are supported. When omitted, all Iterations in the given Team Project are returned.nnTo supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional.nnWhen supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> <maml:para>This is an alias of the Node parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Path,Iteration"> <maml:name>Iteration</maml:name> <maml:description> <maml:para>Specifies the name, URI or path of an Iteration. Wildcards are supported. When omitted, all Iterations in the given Team Project are returned.nnTo supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional.nnWhen supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> <maml:para>This is an alias of the Node parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StartDate --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>StartDate</maml:name> <maml:description> <maml:para>Specifies the start date of the iteration. To clear the start date, set it to $null. Note that when clearing a date, both must be cleared at the same time (i.e. setting both StartDate and FinishDate to $null).</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FinishDate --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FinishDate</maml:name> <maml:description> <maml:para>Sets the finish date of the iteration. To clear the finish date, set it to $null. Note that when clearing a date, both must be cleared at the same time (i.e. setting both StartDate and FinishDate to $null).</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the name, URI or path of an Iteration. Wildcards are supported. When omitted, all Iterations in the given Team Project are returned.nnTo supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional.nnWhen supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: WorkItemClassificationNode --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemClassificationNode</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/WorkItem/AreasIterations/Set-TfsIteration</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Test-TfsIteration --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="WorkItem.AreasIterations"> <command:details> <command:name>Test-TfsIteration</command:name> <command:verb>Test</command:verb> <command:noun>TfsIteration</command:noun> <maml:description> <maml:para>Determines whether the specified Iteration exist.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Test-TfsIteration</maml:name> <!-- Parameter: Node --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Iteration,Path"> <maml:name>Node</maml:name> <maml:description> <maml:para>Specifies the name, URI or path of an Iteration. Wildcards are supported. When omitted, all Iterations in the given Team Project are returned.nnTo supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional.nnWhen supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Node --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Iteration,Path"> <maml:name>Node</maml:name> <maml:description> <maml:para>Specifies the name, URI or path of an Iteration. Wildcards are supported. When omitted, all Iterations in the given Team Project are returned.nnTo supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional.nnWhen supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Iteration,Path"> <maml:name>Iteration</maml:name> <maml:description> <maml:para>Specifies the name, URI or path of an Iteration. Wildcards are supported. When omitted, all Iterations in the given Team Project are returned.nnTo supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional.nnWhen supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> <maml:para>This is an alias of the Node parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Iteration,Path"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the name, URI or path of an Iteration. Wildcards are supported. When omitted, all Iterations in the given Team Project are returned.nnTo supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional.nnWhen supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> <maml:para>This is an alias of the Node parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the name, URI or path of an Iteration. Wildcards are supported. When omitted, all Iterations in the given Team Project are returned.nnTo supply a path, use a backslash ('\') between the path segments. Leading and trailing backslashes are optional.nnWhen supplying a URI, use URIs in the form of 'vstfs:///Classification/Node/{GUID}' (where {GUID} is the unique identifier of the given node).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/WorkItem/AreasIterations/Test-TfsIteration</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Export-TfsProcessTemplate --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="ProcessTemplate"> <command:details> <command:name>Export-TfsProcessTemplate</command:name> <command:verb>Export</command:verb> <command:noun>TfsProcessTemplate</command:noun> <maml:description> <maml:para>Exports a XML-based process template definition to disk.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet offers a functional replacement to the "Export Process Template" feature found in Team Explorer. All files pertaining to the specified process template (work item defininitons, reports, saved queries, process configuration and so on) are downloaded from the given Team Project Collection and saved in a local directory, preserving the directory structure required to later re-import it. This is specially handy to do small changes to a process template or to create a new process template based on an existing one.</maml:para> </maml:description> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Export-TfsProcessTemplate</maml:name> <!-- Parameter: ProcessTemplate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>ProcessTemplate</maml:name> <maml:description> <maml:para>Specifies the name of the process template(s) to be exported. Wildcards are supported. When omitted, all process templates in the given project collection are exported.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DestinationPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DestinationPath</maml:name> <maml:description> <maml:para>Path to the target directory where the exported process template (and related files) will be saved. A folder with the process template name will be created under this path. When omitted, templates are exported in the current directory.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Allows the cmdlet to overwrite an existing destination folder.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: NewDescription --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewDescription</maml:name> <maml:description> <maml:para>Saves the exported process template with a new description. Useful when exporting a base template which will be used as a basis for a new process template. When omitted, the original description is used.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>Saves the exported process template with a new name. Useful when exporting a base template which will be used as a basis for a new process template. When omitted, the original name is used.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ProcessTemplate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>ProcessTemplate</maml:name> <maml:description> <maml:para>Specifies the name of the process template(s) to be exported. Wildcards are supported. When omitted, all process templates in the given project collection are exported.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: DestinationPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DestinationPath</maml:name> <maml:description> <maml:para>Path to the target directory where the exported process template (and related files) will be saved. A folder with the process template name will be created under this path. When omitted, templates are exported in the current directory.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>Saves the exported process template with a new name. Useful when exporting a base template which will be used as a basis for a new process template. When omitted, the original name is used.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewDescription --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewDescription</maml:name> <maml:description> <maml:para>Saves the exported process template with a new description. Useful when exporting a base template which will be used as a basis for a new process template. When omitted, the original description is used.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Allows the cmdlet to overwrite an existing destination folder.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>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).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS> Export-TfsProcessTemplate -Process "Scrum" -DestinationPath C:\PT -Collection http://vsalm:8080/tfs/DefaultCollection</dev:code> <dev:remarks> <maml:para>Exports the Scrum process template from the DefaultCollection project collection in the VSALM server, saving the template files to the C:\PT\Scrum directory in the local computer.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS> Export-TfsProcessTemplate -Process "Scrum" -DestinationPath C:\PT -Collection http://vsalm:8080/tfs/DefaultCollection -NewName "MyScrum" -NewDescription "A customized version of the Scrum process template"</dev:code> <dev:remarks> <maml:para>Exports the Scrum process template from the DefaultCollection project collection in the VSALM server, saving the template files to the C:\PT\MyScrum directory in the local computer. Notice that the process template is being renamed from Scrum to MyScrum, so that it can be later reimported as a new process template instead of overwriting the original one.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/ProcessTemplate/Export-TfsProcessTemplate</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-TfsProcessTemplate --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="ProcessTemplate"> <command:details> <command:name>Get-TfsProcessTemplate</command:name> <command:verb>Get</command:verb> <command:noun>TfsProcessTemplate</command:noun> <maml:description> <maml:para>Gets information from one or more process templates.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Get-TfsProcessTemplate</maml:name> <!-- Parameter: ProcessTemplate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>ProcessTemplate</maml:name> <maml:description> <maml:para>Specifies the name of the process template(s) to be returned. Wildcards are supported. When omitted, all process templates in the given project collection are returned.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ProcessTemplate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>ProcessTemplate</maml:name> <maml:description> <maml:para>Specifies the name of the process template(s) to be returned. Wildcards are supported. When omitted, all process templates in the given project collection are returned.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the process template(s) to be returned. Wildcards are supported. When omitted, all process templates in the given project collection are returned.</maml:para> <maml:para>This is an alias of the ProcessTemplate parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Process --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.Core.WebApi.Process</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/ProcessTemplate/Get-TfsProcessTemplate</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Import-TfsProcessTemplate --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="ProcessTemplate"> <command:details> <command:name>Import-TfsProcessTemplate</command:name> <command:verb>Import</command:verb> <command:noun>TfsProcessTemplate</command:noun> <maml:description> <maml:para>Imports a process template definition from disk.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Import-TfsProcessTemplate</maml:name> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the folder containing the process template to be imported. This folder must contain the file ProcessTemplate.xml</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: State --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>State</maml:name> <maml:description> <maml:para>Specifies the state of the template after it is imported. When set to Invisible, the process template will not be listed in the server UI.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Visible</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the folder containing the process template to be imported. This folder must contain the file ProcessTemplate.xml</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: State --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>State</maml:name> <maml:description> <maml:para>Specifies the state of the template after it is imported. When set to Invisible, the process template will not be listed in the server UI.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Visible</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the folder containing the process template to be imported. This folder must contain the file ProcessTemplate.xml</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/ProcessTemplate/Import-TfsProcessTemplate</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-TfsProcessTemplate --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="ProcessTemplate"> <command:details> <command:name>New-TfsProcessTemplate</command:name> <command:verb>New</command:verb> <command:noun>TfsProcessTemplate</command:noun> <maml:description> <maml:para>Creates a new inherited process.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>New-TfsProcessTemplate</maml:name> <!-- Parameter: ProcessTemplate --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>ProcessTemplate</maml:name> <maml:description> <maml:para>Specifies the name of the process to create.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description of the new process.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Allows the cmdlet to overwrite an existing process.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Parent --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Parent</maml:name> <maml:description> <maml:para>Specifies the name of the parent process from which the new process will inherit.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReferenceName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReferenceName</maml:name> <maml:description> <maml:para>Specifies the reference name of the new process. When omitted, a random name will be automatically generated and assigned by the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ProcessTemplate --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>ProcessTemplate</maml:name> <maml:description> <maml:para>Specifies the name of the process to create.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the process to create.</maml:para> <maml:para>This is an alias of the ProcessTemplate parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description of the new process.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReferenceName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReferenceName</maml:name> <maml:description> <maml:para>Specifies the reference name of the new process. When omitted, a random name will be automatically generated and assigned by the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Parent --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Parent</maml:name> <maml:description> <maml:para>Specifies the name of the parent process from which the new process will inherit.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Allows the cmdlet to overwrite an existing process.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Process --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.Core.WebApi.Process</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/ProcessTemplate/New-TfsProcessTemplate</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-TfsRegisteredConfigurationServer --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="ConfigServer"> <command:details> <command:name>Get-TfsRegisteredConfigurationServer</command:name> <command:verb>Get</command:verb> <command:noun>TfsRegisteredConfigurationServer</command:noun> <maml:description> <maml:para>Gets one or more Team Foundation Server addresses registered in the current computer.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Get-TfsRegisteredConfigurationServer</maml:name> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Name"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the name of a registered server. Wildcards are supported. When omitted, all registered servers are returned.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Name"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the name of a registered server. Wildcards are supported. When omitted, all registered servers are returned.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of a registered server. Wildcards are supported. When omitted, all registered servers are returned.</maml:para> <maml:para>This is an alias of the Server parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the name of a registered server. Wildcards are supported. When omitted, all registered servers are returned.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: RegisteredConfigurationServer --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.Client.RegisteredConfigurationServer</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/ConfigServer/Get-TfsRegisteredConfigurationServer</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-TfsRegisteredTeamProjectCollection --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="TeamProjectCollection"> <command:details> <command:name>Get-TfsRegisteredTeamProjectCollection</command:name> <command:verb>Get</command:verb> <command:noun>TfsRegisteredTeamProjectCollection</command:noun> <maml:description> <maml:para>Gets one or more Team Project Collection addresses registered in the current computer.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Get-TfsRegisteredTeamProjectCollection</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/TeamProjectCollection/Get-TfsRegisteredTeamProjectCollection</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-TfsReleaseDefinition --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="Pipeline.ReleaseManagement"> <command:details> <command:name>Get-TfsReleaseDefinition</command:name> <command:verb>Get</command:verb> <command:noun>TfsReleaseDefinition</command:noun> <maml:description> <maml:para>Gets information from one or more release definitions in a team project.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Get-TfsReleaseDefinition</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <!-- OutputType: ReleaseDefinition --> <command:returnValue> <dev:type> <maml:name>Microsoft.VisualStudio.Services.ReleaseManagement.WebApi.ReleaseDefinition</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/Pipeline/ReleaseManagement/Get-TfsReleaseDefinition</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-TfsReleaseDefinitionFolder --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="Pipeline.ReleaseManagement"> <command:details> <command:name>Get-TfsReleaseDefinitionFolder</command:name> <command:verb>Get</command:verb> <command:noun>TfsReleaseDefinitionFolder</command:noun> <maml:description> <maml:para>Gets one or more Release/pipeline definition folders in a team project.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Get-TfsReleaseDefinitionFolder</maml:name> <!-- Parameter: Folder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Path"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Specifies the folder path. Wildcards are supported. When omitted, all Release/pipeline folders in the supplied team project are returned.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>**</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: QueryOrder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>QueryOrder</maml:name> <maml:description> <maml:para>Specifies the query order. When omitted, defaults to None.</maml:para> <maml:para>Possible values: None, Ascending, Descending</maml:para> </maml:description> <command:parameterValue required="true">FolderPathQueryOrder</command:parameterValue> <dev:type> <maml:name>Microsoft.VisualStudio.Services.ReleaseManagement.WebApi.FolderPathQueryOrder</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Ascending</command:parameterValue> <command:parameterValue required="false" variableLength="false">Descending</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Folder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Path"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Specifies the folder path. Wildcards are supported. When omitted, all Release/pipeline folders in the supplied team project are returned.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>**</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Path"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the folder path. Wildcards are supported. When omitted, all Release/pipeline folders in the supplied team project are returned.</maml:para> <maml:para>This is an alias of the Folder parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>**</dev:defaultValue> </command:parameter> <!-- Parameter: QueryOrder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>QueryOrder</maml:name> <maml:description> <maml:para>Specifies the query order. When omitted, defaults to None.</maml:para> <maml:para>Possible values: None, Ascending, Descending</maml:para> </maml:description> <command:parameterValue required="true">FolderPathQueryOrder</command:parameterValue> <dev:type> <maml:name>Microsoft.VisualStudio.Services.ReleaseManagement.WebApi.FolderPathQueryOrder</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Ascending</command:parameterValue> <command:parameterValue required="false" variableLength="false">Descending</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>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.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Folder --> <command:returnValue> <dev:type> <maml:name>Microsoft.VisualStudio.Services.ReleaseManagement.WebApi.Folder</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/Pipeline/ReleaseManagement/Get-TfsReleaseDefinitionFolder</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-TfsReleaseDefinitionFolder --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="Pipeline.ReleaseManagement"> <command:details> <command:name>New-TfsReleaseDefinitionFolder</command:name> <command:verb>New</command:verb> <command:noun>TfsReleaseDefinitionFolder</command:noun> <maml:description> <maml:para>Creates a new release definition folder.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>New-TfsReleaseDefinitionFolder</maml:name> <!-- Parameter: Folder --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Path"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Specifies the folder path. Wildcards are supported. When omitted, all Release/pipeline folders in the supplied team project are returned.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>**</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description of the new build/pipeline folder.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Folder --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Path"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Specifies the folder path. Wildcards are supported. When omitted, all Release/pipeline folders in the supplied team project are returned.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>**</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Path"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the folder path. Wildcards are supported. When omitted, all Release/pipeline folders in the supplied team project are returned.</maml:para> <maml:para>This is an alias of the Folder parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>**</dev:defaultValue> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description of the new build/pipeline folder.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the folder path. Wildcards are supported. When omitted, all Release/pipeline folders in the supplied team project are returned.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Folder --> <command:returnValue> <dev:type> <maml:name>Microsoft.VisualStudio.Services.ReleaseManagement.WebApi.Folder</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/Pipeline/ReleaseManagement/New-TfsReleaseDefinitionFolder</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-TfsReleaseDefinitionFolder --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="Pipeline.ReleaseManagement"> <command:details> <command:name>Remove-TfsReleaseDefinitionFolder</command:name> <command:verb>Remove</command:verb> <command:noun>TfsReleaseDefinitionFolder</command:noun> <maml:description> <maml:para>Deletes one or more release definition folders.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Remove-TfsReleaseDefinitionFolder</maml:name> <!-- Parameter: Folder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Path"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Specifies the path of the release folder to delete. Wildcards are supported.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the exclusion of folders containing release definitions definitions. When omitted, only empty folders can be deleted.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Recurse --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>Removes folders recursively. When omitted, folders with subfolders cannot be deleted.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Folder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Path"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Specifies the path of the release folder to delete. Wildcards are supported.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Path"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the path of the release folder to delete. Wildcards are supported.</maml:para> <maml:para>This is an alias of the Folder parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Recurse --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>Removes folders recursively. When omitted, folders with subfolders cannot be deleted.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the exclusion of folders containing release definitions definitions. When omitted, only empty folders can be deleted.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the path of the release folder to delete. Wildcards are supported.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Folder --> <command:returnValue> <dev:type> <maml:name>Microsoft.VisualStudio.Services.ReleaseManagement.WebApi.Folder</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/Pipeline/ReleaseManagement/Remove-TfsReleaseDefinitionFolder</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Invoke-TfsRestApi --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="RestApi"> <command:details> <command:name>Invoke-TfsRestApi</command:name> <command:verb>Invoke</command:verb> <command:noun>TfsRestApi</command:noun> <maml:description> <maml:para>Invoke an Azure DevOps REST API.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Invoke-TfsRestApi can automatically parse an example URL from https://docs.microsoft.com/en-us/rest/api/azure/devops/ and replace its various tokens (such as {organization}, {project} and {team}) as long as collection / project / team information are available via either the their respective arguments in this command or the corresponding Connect-Tfs* cmdlet. HTTP method and API version are also automatically extracted from the supplied example, when available.</maml:para> </maml:description> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Invoke-TfsRestApi</maml:name> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the path of the REST API to call. Tipically it is the portion of the URL after the name of the collection/organization, i.e. in the URL https://dev.azure.com/{organization}/_apis/projects?api-version=5.1 the path is "/_apis/projects".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AdditionalHeaders --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AdditionalHeaders</maml:name> <maml:description> <maml:para>Specifies a hashtable with additional HTTP headers to send to the API endpoint.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ApiVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApiVersion</maml:name> <maml:description> <maml:para>Specifies the desired API version. When omitted, defaults to "4.1".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>4.1</dev:defaultValue> </command:parameter> <!-- Parameter: AsTask --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsTask</maml:name> <maml:description> <maml:para>Returns the System.Threading.Tasks.Task object used to issue the asynchronous call to the API. The caller is responsible for finishing the asynchronous call by e.g. accessing the Result property.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Body --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Content"> <maml:name>Body</maml:name> <maml:description> <maml:para>Specifies the request body to send to the API endpoint. Tipically contains the JSON payload required by the API.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Method --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Method</maml:name> <maml:description> <maml:para>Specifies the HTTP method to call the API endpoint. When omitted, defaults to "GET".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>GET</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: QueryParameters --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>QueryParameters</maml:name> <maml:description> <maml:para>Specifies a hashtable with additional query parameters to send to the API endpoint.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Raw --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Returns the API response as an unparsed string. If omitted, JSON responses will be parsed, converted and returned as objects (via ConvertFrom-Json).</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: RequestContentType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestContentType</maml:name> <maml:description> <maml:para>Specifies the request body content type to send to the API. When omitted, defaults to "application/json".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>application/json</dev:defaultValue> </command:parameter> <!-- Parameter: ResponseContentType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResponseContentType</maml:name> <maml:description> <maml:para>Specifies the response body content type returned by the API. When omitted, defaults to "application/json".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>application/json</dev:defaultValue> </command:parameter> <!-- Parameter: Team --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeam (if any). For more details, see the Get-TfsTeam cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UseHost --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseHost</maml:name> <maml:description> <maml:para>Specifies an alternate host name for APIs not hosted in "dev.azure.com", e.g. "vsaex.dev.azure.com" or "vssps.dev.azure.com".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the path of the REST API to call. Tipically it is the portion of the URL after the name of the collection/organization, i.e. in the URL https://dev.azure.com/{organization}/_apis/projects?api-version=5.1 the path is "/_apis/projects".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Method --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Method</maml:name> <maml:description> <maml:para>Specifies the HTTP method to call the API endpoint. When omitted, defaults to "GET".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>GET</dev:defaultValue> </command:parameter> <!-- Parameter: Body --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Content"> <maml:name>Body</maml:name> <maml:description> <maml:para>Specifies the request body to send to the API endpoint. Tipically contains the JSON payload required by the API.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Content"> <maml:name>Content</maml:name> <maml:description> <maml:para>Specifies the request body to send to the API endpoint. Tipically contains the JSON payload required by the API.</maml:para> <maml:para>This is an alias of the Body parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequestContentType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestContentType</maml:name> <maml:description> <maml:para>Specifies the request body content type to send to the API. When omitted, defaults to "application/json".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>application/json</dev:defaultValue> </command:parameter> <!-- Parameter: ResponseContentType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResponseContentType</maml:name> <maml:description> <maml:para>Specifies the response body content type returned by the API. When omitted, defaults to "application/json".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>application/json</dev:defaultValue> </command:parameter> <!-- Parameter: AdditionalHeaders --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AdditionalHeaders</maml:name> <maml:description> <maml:para>Specifies a hashtable with additional HTTP headers to send to the API endpoint.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: QueryParameters --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>QueryParameters</maml:name> <maml:description> <maml:para>Specifies a hashtable with additional query parameters to send to the API endpoint.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ApiVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApiVersion</maml:name> <maml:description> <maml:para>Specifies the desired API version. When omitted, defaults to "4.1".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>4.1</dev:defaultValue> </command:parameter> <!-- Parameter: UseHost --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseHost</maml:name> <maml:description> <maml:para>Specifies an alternate host name for APIs not hosted in "dev.azure.com", e.g. "vsaex.dev.azure.com" or "vssps.dev.azure.com".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Raw --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Returns the API response as an unparsed string. If omitted, JSON responses will be parsed, converted and returned as objects (via ConvertFrom-Json).</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: AsTask --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsTask</maml:name> <maml:description> <maml:para>Returns the System.Threading.Tasks.Task object used to issue the asynchronous call to the API. The caller is responsible for finishing the asynchronous call by e.g. accessing the Result property.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Team --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeam (if any). For more details, see the Get-TfsTeam cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS> Invoke-TfsRestApi -Method GET -Path /_apis/projects -ApiVersion 4.1 -Collection DefaultCollection</dev:code> <dev:remarks> <maml:para>Calls a REST API that lists all team projects in a TFS collection named DefaultCollection</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS> Invoke-TfsRestApi 'GET https://extmgmt.dev.azure.com/{organization}/_apis/extensionmanagement/installedextensions?api-version=5.1-preview.1'</dev:code> <dev:remarks> <maml:para>Calls the API described by an example extracted from the docs.microsoft.com web site. HTTP method, host name and API version are all set based on the supplied values; Tokens {organization}, {project} and {team} are properly replaced with the corresponding values provided by the current connection context (via previous calls to Connect-TfsTeamProjectCollection, Connect-TfsTeamProject and/or Connect-TfsTeam).</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS> Invoke-TfsRestApi 'GET https://{instance}/{collection}/_apis/process/processes?api-version=4.1' -Collection http://vsalm:8080/tfs/DefaultCollection</dev:code> <dev:remarks> <maml:para>Calls an API in a TFS instance, parsing the example provided by the docs.microsoft.com web site.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/RestApi/Invoke-TfsRestApi</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-TfsRestClient --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="RestApi"> <command:details> <command:name>Get-TfsRestClient</command:name> <command:verb>Get</command:verb> <command:noun>TfsRestClient</command:noun> <maml:description> <maml:para>Gets an Azure DevOps HTTP Client object instance.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Connection objects (Microsoft.VisualStudio.Services.Client.VssConnection in PowerShell Core, Microsoft.TeamFoundation.Client.TfsTeamProjectCollection in Windows PowerShell) provide access to many HTTP client objects such as Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClient that wrap many of the REST APIs exposed by Azure DevOps. Those clients inherit the authentication information supplied by their parent connection object and can be used as a more convenient mechanism to issue API calls.</maml:para> </maml:description> <command:syntax> <!-- Parameter Set: Get by collection --> <command:syntaxItem tfscmdlets:parameterSet="Get by collection"> <maml:name>Get-TfsRestClient</maml:name> <!-- Parameter: TypeName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Type"> <maml:name>TypeName</maml:name> <maml:description> <maml:para>Specifies the full type name (optionally including its assembly name) of the HTTP Client class to return.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter Set: Get by server --> <command:syntaxItem tfscmdlets:parameterSet="Get by server"> <maml:name>Get-TfsRestClient</maml:name> <!-- Parameter: TypeName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Type"> <maml:name>TypeName</maml:name> <maml:description> <maml:para>Specifies the full type name (optionally including its assembly name) of the HTTP Client class to return.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Server --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: TypeName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Type"> <maml:name>TypeName</maml:name> <maml:description> <maml:para>Specifies the full type name (optionally including its assembly name) of the HTTP Client class to return.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Type"> <maml:name>Type</maml:name> <maml:description> <maml:para>Specifies the full type name (optionally including its assembly name) of the HTTP Client class to return.</maml:para> <maml:para>This is an alias of the TypeName parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Server --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: VssHttpClientBase --> <command:returnValue> <dev:type> <maml:name>Microsoft.VisualStudio.Services.WebApi.VssHttpClientBase</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/RestApi/Get-TfsRestClient</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-TfsServiceHookConsumer --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="ServiceHook"> <command:details> <command:name>Get-TfsServiceHookConsumer</command:name> <command:verb>Get</command:verb> <command:noun>TfsServiceHookConsumer</command:noun> <maml:description> <maml:para>Gets one or more service hook consumers.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Service hook consumers are the services that can consume (receive) notifications triggered by Azure DevOps. Examples of consumers available out-of-box with Azure DevOps are Microsoft Teams, Slack, Trello ou the generic WebHook consumer. Use this cmdlet to list the available consumers and get the ID of the desired one to be able to manage service hook subscriptions.</maml:para> </maml:description> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Get-TfsServiceHookConsumer</maml:name> <!-- Parameter: Consumer --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name,Id"> <maml:name>Consumer</maml:name> <maml:description> <maml:para>Specifies the name or ID of the service hook consumer to return. Wildcards are supported. When omitted, all service hook consumers registered in the given project collection/organization are returned.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Consumer --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name,Id"> <maml:name>Consumer</maml:name> <maml:description> <maml:para>Specifies the name or ID of the service hook consumer to return. Wildcards are supported. When omitted, all service hook consumers registered in the given project collection/organization are returned.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name,Id"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name or ID of the service hook consumer to return. Wildcards are supported. When omitted, all service hook consumers registered in the given project collection/organization are returned.</maml:para> <maml:para>This is an alias of the Consumer parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name,Id"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the name or ID of the service hook consumer to return. Wildcards are supported. When omitted, all service hook consumers registered in the given project collection/organization are returned.</maml:para> <maml:para>This is an alias of the Consumer parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Consumer --> <command:returnValue> <dev:type> <maml:name>Microsoft.VisualStudio.Services.ServiceHooks.WebApi.Consumer</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/ServiceHook/Get-TfsServiceHookConsumer</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-TfsServiceHookNotificationHistory --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="ServiceHook"> <command:details> <command:name>Get-TfsServiceHookNotificationHistory</command:name> <command:verb>Get</command:verb> <command:noun>TfsServiceHookNotificationHistory</command:noun> <maml:description> <maml:para>Gets the notification history for a given service hook subscription</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Get-TfsServiceHookNotificationHistory</maml:name> <!-- Parameter: Subscription --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Subscription</maml:name> <maml:description> <maml:para>Specifies the subscription to get the notification history from.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: From --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>From</maml:name> <maml:description> <maml:para>Specifies the beginning of a date interval to filter notifications on.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Status --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Status</maml:name> <maml:description> <maml:para>Specifies the notification status to filter on.</maml:para> <maml:para>Possible values: Queued, Processing, RequestInProgress, Completed</maml:para> </maml:description> <command:parameterValue required="true">NotificationStatus</command:parameterValue> <dev:type> <maml:name>Microsoft.VisualStudio.Services.ServiceHooks.WebApi.NotificationStatus</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Queued</command:parameterValue> <command:parameterValue required="false" variableLength="false">Processing</command:parameterValue> <command:parameterValue required="false" variableLength="false">RequestInProgress</command:parameterValue> <command:parameterValue required="false" variableLength="false">Completed</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: To --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>To</maml:name> <maml:description> <maml:para>Specifies the end of a date interval to filter notifications on.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Subscription --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Subscription</maml:name> <maml:description> <maml:para>Specifies the subscription to get the notification history from.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: From --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>From</maml:name> <maml:description> <maml:para>Specifies the beginning of a date interval to filter notifications on.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: To --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>To</maml:name> <maml:description> <maml:para>Specifies the end of a date interval to filter notifications on.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Status --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Status</maml:name> <maml:description> <maml:para>Specifies the notification status to filter on.</maml:para> <maml:para>Possible values: Queued, Processing, RequestInProgress, Completed</maml:para> </maml:description> <command:parameterValue required="true">NotificationStatus</command:parameterValue> <dev:type> <maml:name>Microsoft.VisualStudio.Services.ServiceHooks.WebApi.NotificationStatus</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Queued</command:parameterValue> <command:parameterValue required="false" variableLength="false">Processing</command:parameterValue> <command:parameterValue required="false" variableLength="false">RequestInProgress</command:parameterValue> <command:parameterValue required="false" variableLength="false">Completed</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the subscription to get the notification history from.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Notification --> <command:returnValue> <dev:type> <maml:name>Microsoft.VisualStudio.Services.ServiceHooks.WebApi.Notification</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/ServiceHook/Get-TfsServiceHookNotificationHistory</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-TfsServiceHookPublisher --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="ServiceHook"> <command:details> <command:name>Get-TfsServiceHookPublisher</command:name> <command:verb>Get</command:verb> <command:noun>TfsServiceHookPublisher</command:noun> <maml:description> <maml:para>Gets one or more service hook publishers.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Service hook publishers are the components inside of Azure DevOps that can publish (send) notifications triggered by event such as "work item changed" or "build queued". Use this cmdlet to list the available publishers and get the ID of the desired one to be able to manage service hook subscriptions.</maml:para> </maml:description> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Get-TfsServiceHookPublisher</maml:name> <!-- Parameter: Publisher --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name,Id"> <maml:name>Publisher</maml:name> <maml:description> <maml:para>Specifies the name or ID of the service hook publisher to return. Wildcards are supported. When omitted, returns all service hook consumers currently supported the current by Azure DevOps organization / TFS collection.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Publisher --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name,Id"> <maml:name>Publisher</maml:name> <maml:description> <maml:para>Specifies the name or ID of the service hook publisher to return. Wildcards are supported. When omitted, returns all service hook consumers currently supported the current by Azure DevOps organization / TFS collection.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name,Id"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name or ID of the service hook publisher to return. Wildcards are supported. When omitted, returns all service hook consumers currently supported the current by Azure DevOps organization / TFS collection.</maml:para> <maml:para>This is an alias of the Publisher parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name,Id"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the name or ID of the service hook publisher to return. Wildcards are supported. When omitted, returns all service hook consumers currently supported the current by Azure DevOps organization / TFS collection.</maml:para> <maml:para>This is an alias of the Publisher parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Publisher --> <command:returnValue> <dev:type> <maml:name>Microsoft.VisualStudio.Services.ServiceHooks.WebApi.Publisher</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/ServiceHook/Get-TfsServiceHookPublisher</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-TfsServiceHookSubscription --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="ServiceHook"> <command:details> <command:name>Get-TfsServiceHookSubscription</command:name> <command:verb>Get</command:verb> <command:noun>TfsServiceHookSubscription</command:noun> <maml:description> <maml:para>Gets one or more service hook subscriptions</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Get-TfsServiceHookSubscription</maml:name> <!-- Parameter: Subscription --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Subscription</maml:name> <maml:description> <maml:para>Specifies the name ("action description") of the subscription. Wildcards are supported. When omitted, returns all service hook subscriptions in the given team project collection.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Consumer --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Consumer</maml:name> <maml:description> <maml:para>Specifies the name or ID of the service hook consumer to filter subscriptions by. When omitted, returns all subscriptions regardless of their consumers.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EventType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EventType</maml:name> <maml:description> <maml:para>Specifies the event type to filter subscriptions by. When omitted, returns all subscriptions regardless of their event types.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Publisher --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Publisher</maml:name> <maml:description> <maml:para>Specifies the name or ID of the service hook publisher to filter subscriptions by. When omitted, returns all subscriptions regardless of their publishers.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Subscription --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Subscription</maml:name> <maml:description> <maml:para>Specifies the name ("action description") of the subscription. Wildcards are supported. When omitted, returns all service hook subscriptions in the given team project collection.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name ("action description") of the subscription. Wildcards are supported. When omitted, returns all service hook subscriptions in the given team project collection.</maml:para> <maml:para>This is an alias of the Subscription parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: Publisher --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Publisher</maml:name> <maml:description> <maml:para>Specifies the name or ID of the service hook publisher to filter subscriptions by. When omitted, returns all subscriptions regardless of their publishers.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Consumer --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Consumer</maml:name> <maml:description> <maml:para>Specifies the name or ID of the service hook consumer to filter subscriptions by. When omitted, returns all subscriptions regardless of their consumers.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EventType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EventType</maml:name> <maml:description> <maml:para>Specifies the event type to filter subscriptions by. When omitted, returns all subscriptions regardless of their event types.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Subscription --> <command:returnValue> <dev:type> <maml:name>Microsoft.VisualStudio.Services.ServiceHooks.WebApi.Subscription</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/ServiceHook/Get-TfsServiceHookSubscription</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Enter-TfsShell --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="Shell"> <command:details> <command:name>Enter-TfsShell</command:name> <command:verb>Enter</command:verb> <command:noun>TfsShell</command:noun> <maml:description> <maml:para>Activates the Azure DevOps Shell</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Enter-TfsShell</maml:name> <!-- Parameter: DoNotClearHost --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DoNotClearHost</maml:name> <maml:description> <maml:para>Do not clear the host screen when activating the Azure DevOps Shell. When set, the prompt is enabled without clearing the screen.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoLogo</maml:name> <maml:description> <maml:para>Do not show the version banner when activating the Azure DevOps Shell.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: WindowTitle --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WindowTitle</maml:name> <maml:description> <maml:para>Specifies the shell window title. If omitted, defaults to "Azure DevOps Shell".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Azure DevOps Shell</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: WindowTitle --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WindowTitle</maml:name> <maml:description> <maml:para>Specifies the shell window title. If omitted, defaults to "Azure DevOps Shell".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Azure DevOps Shell</dev:defaultValue> </command:parameter> <!-- Parameter: DoNotClearHost --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DoNotClearHost</maml:name> <maml:description> <maml:para>Do not clear the host screen when activating the Azure DevOps Shell. When set, the prompt is enabled without clearing the screen.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoLogo</maml:name> <maml:description> <maml:para>Do not show the version banner when activating the Azure DevOps Shell.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/Shell/Enter-TfsShell</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Exit-TfsShell --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="Shell"> <command:details> <command:name>Exit-TfsShell</command:name> <command:verb>Exit</command:verb> <command:noun>TfsShell</command:noun> <maml:description> <maml:para>Deactivates the Azure DevOps Shell</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Exit-TfsShell</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/Shell/Exit-TfsShell</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Connect-TfsTeam --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="Connection"> <command:details> <command:name>Connect-TfsTeam</command:name> <command:verb>Connect</command:verb> <command:noun>TfsTeam</command:noun> <maml:description> <maml:para>Connects to a team.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: Cached credentials --> <command:syntaxItem tfscmdlets:parameterSet="Cached credentials"> <maml:name>Connect-TfsTeam</maml:name> <!-- Parameter: Team --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. For more details, see the Get-TfsTeam cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Cached --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Cached</maml:name> <maml:description> <maml:para>Specifies that cached (default) credentials should be used when possible/available.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter Set: User name and password --> <command:syntaxItem tfscmdlets:parameterSet="User name and password"> <maml:name>Connect-TfsTeam</maml:name> <!-- Parameter: Team --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. For more details, see the Get-TfsTeam cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>UserName</maml:name> <maml:description> <maml:para>Specifies a user name for authentication modes (such as Basic) that support username/password-based credentials. Must be used in conjunction with the -Password argument</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Password --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies a password for authentication modes (such as Basic) that support username/password-based credentials. Must be used in conjunction with the -UserName argument</maml:para> </maml:description> <command:parameterValue required="true">SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter Set: Credential object --> <command:syntaxItem tfscmdlets:parameterSet="Credential object"> <maml:name>Connect-TfsTeam</maml:name> <!-- Parameter: Team --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. For more details, see the Get-TfsTeam cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies a user account that has permission to perform this action. To provide a user name and password, a Personal Access Token, and/or to open a input dialog to enter your credentials, call Get-TfsCredential with the appropriate arguments and pass its return to this argument.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter Set: Personal Access Token --> <command:syntaxItem tfscmdlets:parameterSet="Personal Access Token"> <maml:name>Connect-TfsTeam</maml:name> <!-- Parameter: Team --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. For more details, see the Get-TfsTeam cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PersonalAccessToken --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="Pat"> <maml:name>PersonalAccessToken</maml:name> <maml:description> <maml:para>Specifies a personal access token, used as an alternate credential, to authenticate to Azure DevOps</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter Set: Prompt for credential --> <command:syntaxItem tfscmdlets:parameterSet="Prompt for credential"> <maml:name>Connect-TfsTeam</maml:name> <!-- Parameter: Team --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. For more details, see the Get-TfsTeam cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Interactive --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Interactive</maml:name> <maml:description> <maml:para>Prompts for user credentials. Can be used for any Team Foundation Server or Azure DevOps account - the proper login dialog is automatically selected. Should only be used in an interactive PowerShell session (i.e., a PowerShell terminal window), never in an unattended script (such as those executed during an automated build). Currently it is only supported in Windows PowerShell.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Team --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. For more details, see the Get-TfsTeam cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Cached --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Cached</maml:name> <maml:description> <maml:para>Specifies that cached (default) credentials should be used when possible/available.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UserName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>UserName</maml:name> <maml:description> <maml:para>Specifies a user name for authentication modes (such as Basic) that support username/password-based credentials. Must be used in conjunction with the -Password argument</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Password --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies a password for authentication modes (such as Basic) that support username/password-based credentials. Must be used in conjunction with the -UserName argument</maml:para> </maml:description> <command:parameterValue required="true">SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies a user account that has permission to perform this action. To provide a user name and password, a Personal Access Token, and/or to open a input dialog to enter your credentials, call Get-TfsCredential with the appropriate arguments and pass its return to this argument.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PersonalAccessToken --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="Pat"> <maml:name>PersonalAccessToken</maml:name> <maml:description> <maml:para>Specifies a personal access token, used as an alternate credential, to authenticate to Azure DevOps</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="Pat"> <maml:name>Pat</maml:name> <maml:description> <maml:para>Specifies a personal access token, used as an alternate credential, to authenticate to Azure DevOps</maml:para> <maml:para>This is an alias of the PersonalAccessToken parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Interactive --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Interactive</maml:name> <maml:description> <maml:para>Prompts for user credentials. Can be used for any Team Foundation Server or Azure DevOps account - the proper login dialog is automatically selected. Should only be used in an interactive PowerShell session (i.e., a PowerShell terminal window), never in an unattended script (such as those executed during an automated build). Currently it is only supported in Windows PowerShell.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. For more details, see the Get-TfsTeam cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: WebApiTeam --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.Core.WebApi.WebApiTeam</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/Connection/Connect-TfsTeam</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Disconnect-TfsTeam --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="Connection"> <command:details> <command:name>Disconnect-TfsTeam</command:name> <command:verb>Disconnect</command:verb> <command:noun>TfsTeam</command:noun> <maml:description> <maml:para>Disconnects from the currently connected team.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Disconnect-TfsTeam cmdlet removes the connection previously set by its counterpart Connect-TfsTeam. Therefore, cmdlets relying on a "default team" as provided by "Get-TfsTeam -Current" will no longer work after a call to this cmdlet, unless their -Team argument is provided or a new call to Connect-TfsTeam is made.</maml:para> </maml:description> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Disconnect-TfsTeam</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/Connection/Disconnect-TfsTeam</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-TfsTeam --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="Team"> <command:details> <command:name>Get-TfsTeam</command:name> <command:verb>Get</command:verb> <command:noun>TfsTeam</command:noun> <maml:description> <maml:para>Gets information about one or more teams.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: Get by team --> <command:syntaxItem tfscmdlets:parameterSet="Get by team"> <maml:name>Get-TfsTeam</maml:name> <!-- Parameter: Team --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specifies the team to return. Accepted values are its name, its ID, or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object. Wildcards are supported. When omitted, all teams in the given team project are returned.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IncludeSettings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeSettings</maml:name> <maml:description> <maml:para>Gets the team's backlog settings (fills the Settings property with a Microsoft.TeamFoundation.Work.WebApi.TeamSetting object)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: QueryMembership --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>QueryMembership</maml:name> <maml:description> <maml:para>Get team members (fills the Members property with a list of Microsoft.VisualStudio.Services.WebApi.TeamMember objects). When omitted, only basic team information (such as name, description and ID) are returned.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter Set: Get current --> <command:syntaxItem tfscmdlets:parameterSet="Get current"> <maml:name>Get-TfsTeam</maml:name> <!-- Parameter: Current --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Current</maml:name> <maml:description> <maml:para>Returns the team specified in the last call to Connect-TfsTeam (i.e. the "current" team)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IncludeSettings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeSettings</maml:name> <maml:description> <maml:para>Gets the team's backlog settings (fills the Settings property with a Microsoft.TeamFoundation.Work.WebApi.TeamSetting object)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: QueryMembership --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>QueryMembership</maml:name> <maml:description> <maml:para>Get team members (fills the Members property with a list of Microsoft.VisualStudio.Services.WebApi.TeamMember objects). When omitted, only basic team information (such as name, description and ID) are returned.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter Set: Get default team --> <command:syntaxItem tfscmdlets:parameterSet="Get default team"> <maml:name>Get-TfsTeam</maml:name> <!-- Parameter: Default --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Default</maml:name> <maml:description> <maml:para>Returns the default team in the given team project.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IncludeSettings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeSettings</maml:name> <maml:description> <maml:para>Gets the team's backlog settings (fills the Settings property with a Microsoft.TeamFoundation.Work.WebApi.TeamSetting object)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: QueryMembership --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>QueryMembership</maml:name> <maml:description> <maml:para>Get team members (fills the Members property with a list of Microsoft.VisualStudio.Services.WebApi.TeamMember objects). When omitted, only basic team information (such as name, description and ID) are returned.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Team --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specifies the team to return. Accepted values are its name, its ID, or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object. Wildcards are supported. When omitted, all teams in the given team project are returned.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the team to return. Accepted values are its name, its ID, or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object. Wildcards are supported. When omitted, all teams in the given team project are returned.</maml:para> <maml:para>This is an alias of the Team parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: QueryMembership --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>QueryMembership</maml:name> <maml:description> <maml:para>Get team members (fills the Members property with a list of Microsoft.VisualStudio.Services.WebApi.TeamMember objects). When omitted, only basic team information (such as name, description and ID) are returned.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IncludeSettings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeSettings</maml:name> <maml:description> <maml:para>Gets the team's backlog settings (fills the Settings property with a Microsoft.TeamFoundation.Work.WebApi.TeamSetting object)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Current --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Current</maml:name> <maml:description> <maml:para>Returns the team specified in the last call to Connect-TfsTeam (i.e. the "current" team)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Default --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Default</maml:name> <maml:description> <maml:para>Returns the default team in the given team project.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>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.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: WebApiTeam --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.Core.WebApi.WebApiTeam</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/Team/Get-TfsTeam</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-TfsTeam --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="Team"> <command:details> <command:name>New-TfsTeam</command:name> <command:verb>New</command:verb> <command:noun>TfsTeam</command:noun> <maml:description> <maml:para>Creates a new team.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>New-TfsTeam</maml:name> <!-- Parameter: Team --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Name"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specifies the name of the new team.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BacklogIteration --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BacklogIteration</maml:name> <maml:description> <maml:para>Specifies the team's backlog iteration path. When omitted, defaults to the team project's root iteration.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>\</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DefaultAreaPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="TeamFieldValue"> <maml:name>DefaultAreaPath</maml:name> <maml:description> <maml:para>Specifies the team's default area path (or "team field"). The default area path is assigned automatically to all work items created in a team's backlog and/or board. When omitted, an area path may still be associated to this team depending on whether NoAutomaticAreaPath is set</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DefaultIterationMacro --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DefaultIterationMacro</maml:name> <maml:description> <maml:para>Specifies the default iteration macro. When omitted, defaults to "@CurrentIteration".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>@CurrentIteration</dev:defaultValue> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a description of the new team.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IterationPaths --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IterationPaths</maml:name> <maml:description> <maml:para>Specifies the backlog iteration paths that are associated with this team. Provide a list of iteration paths in the form '/path1/path2'.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NoBacklogIteration --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoBacklogIteration</maml:name> <maml:description> <maml:para>Do not associate an iteration path automatically to the new team. When omitted, an iteration path is created (if needed) and then is set as the default backlog iteration</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: NoDefaultArea --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoDefaultArea</maml:name> <maml:description> <maml:para>Do not associate an area path automatically to the new team. When omitted, an area path is created (if needed) and then is set as the default area path / team field</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Team --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Name"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specifies the name of the new team.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the new team.</maml:para> <maml:para>This is an alias of the Team parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DefaultAreaPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="TeamFieldValue"> <maml:name>DefaultAreaPath</maml:name> <maml:description> <maml:para>Specifies the team's default area path (or "team field"). The default area path is assigned automatically to all work items created in a team's backlog and/or board. When omitted, an area path may still be associated to this team depending on whether NoAutomaticAreaPath is set</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="TeamFieldValue"> <maml:name>TeamFieldValue</maml:name> <maml:description> <maml:para>Specifies the team's default area path (or "team field"). The default area path is assigned automatically to all work items created in a team's backlog and/or board. When omitted, an area path may still be associated to this team depending on whether NoAutomaticAreaPath is set</maml:para> <maml:para>This is an alias of the DefaultAreaPath parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NoDefaultArea --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoDefaultArea</maml:name> <maml:description> <maml:para>Do not associate an area path automatically to the new team. When omitted, an area path is created (if needed) and then is set as the default area path / team field</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: BacklogIteration --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BacklogIteration</maml:name> <maml:description> <maml:para>Specifies the team's backlog iteration path. When omitted, defaults to the team project's root iteration.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>\</dev:defaultValue> </command:parameter> <!-- Parameter: IterationPaths --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IterationPaths</maml:name> <maml:description> <maml:para>Specifies the backlog iteration paths that are associated with this team. Provide a list of iteration paths in the form '/path1/path2'.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DefaultIterationMacro --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DefaultIterationMacro</maml:name> <maml:description> <maml:para>Specifies the default iteration macro. When omitted, defaults to "@CurrentIteration".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>@CurrentIteration</dev:defaultValue> </command:parameter> <!-- Parameter: NoBacklogIteration --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoBacklogIteration</maml:name> <maml:description> <maml:para>Do not associate an iteration path automatically to the new team. When omitted, an iteration path is created (if needed) and then is set as the default backlog iteration</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a description of the new team.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the name of the new team.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: WebApiTeam --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.Core.WebApi.WebApiTeam</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/Team/New-TfsTeam</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-TfsTeam --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="Team"> <command:details> <command:name>Remove-TfsTeam</command:name> <command:verb>Remove</command:verb> <command:noun>TfsTeam</command:noun> <maml:description> <maml:para>Deletes a team.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Remove-TfsTeam</maml:name> <!-- Parameter: Team --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Name"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeam (if any). For more details, see the Get-TfsTeam cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Team --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Name"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeam (if any). For more details, see the Get-TfsTeam cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeam (if any). For more details, see the Get-TfsTeam cmdlet.</maml:para> <maml:para>This is an alias of the Team parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeam (if any). For more details, see the Get-TfsTeam cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: WebApiTeam --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.Core.WebApi.WebApiTeam</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/Team/Remove-TfsTeam</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Rename-TfsTeam --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="Team"> <command:details> <command:name>Rename-TfsTeam</command:name> <command:verb>Rename</command:verb> <command:noun>TfsTeam</command:noun> <maml:description> <maml:para>Renames a team.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Rename-TfsTeam</maml:name> <!-- Parameter: Team --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Name"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeam (if any). For more details, see the Get-TfsTeam cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NewName</maml:name> <maml:description> <maml:para>Specifies the new name of the item. Enter only a name - i.e., for items that support paths, do not enter a path and name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Team --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Name"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeam (if any). For more details, see the Get-TfsTeam cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeam (if any). For more details, see the Get-TfsTeam cmdlet.</maml:para> <maml:para>This is an alias of the Team parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NewName</maml:name> <maml:description> <maml:para>Specifies the new name of the item. Enter only a name - i.e., for items that support paths, do not enter a path and name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeam (if any). For more details, see the Get-TfsTeam cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: WebApiTeam --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.Core.WebApi.WebApiTeam</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/Team/Rename-TfsTeam</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-TfsTeam --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="Team"> <command:details> <command:name>Set-TfsTeam</command:name> <command:verb>Set</command:verb> <command:noun>TfsTeam</command:noun> <maml:description> <maml:para>Changes the details of a team.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Set-TfsTeam</maml:name> <!-- Parameter: Team --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Name"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeam (if any). For more details, see the Get-TfsTeam cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AreaPaths --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AreaPaths</maml:name> <maml:description> <maml:para>Specifies the backlog area paths that are associated with this team. Provide a list of area paths in the form '/path1/path2/[*]'. When the path ends with an asterisk, all child area path will be included recursively. Otherwise, only the area itself (without its children) will be included.</maml:para> </maml:description> <command:parameterValue required="true">IEnumerable`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.IEnumerable`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BacklogIteration --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BacklogIteration</maml:name> <maml:description> <maml:para>Specifies the team's backlog iteration path. When omitted, defaults to the team project's root iteration.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>\</dev:defaultValue> </command:parameter> <!-- Parameter: BacklogVisibilities --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BacklogVisibilities</maml:name> <maml:description> <maml:para>Specifies which backlog levels (e.g. Epics, Features, Stories) should be visible.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BugsBehavior --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BugsBehavior</maml:name> <maml:description> <maml:para>Specifies how bugs should behave when added to a board.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Default --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Default</maml:name> <maml:description> <maml:para>Sets the supplied team as the default team project team.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DefaultAreaPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="TeamFieldValue"> <maml:name>DefaultAreaPath</maml:name> <maml:description> <maml:para>Specifies the team's default area path (or "team field"). The default area path is assigned automatically to all work items created in a team's backlog and/or board.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DefaultIterationMacro --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DefaultIterationMacro</maml:name> <maml:description> <maml:para>Specifies the default iteration macro. When omitted, defaults to "@CurrentIteration".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>@CurrentIteration</dev:defaultValue> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a new description</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IterationPaths --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IterationPaths</maml:name> <maml:description> <maml:para>Specifies the backlog iteration paths that are associated with this team. Provide a list of iteration paths in the form '/path1/path2'.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: WorkingDays --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WorkingDays</maml:name> <maml:description> <maml:para>Specifies the team's Working Days. When omitted, defaults to Monday thru Friday</maml:para> </maml:description> <command:parameterValue required="true">IEnumerable`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.IEnumerable`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>monday, tuesday, wednesday, thursday, friday</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Team --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Name"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeam (if any). For more details, see the Get-TfsTeam cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeam (if any). For more details, see the Get-TfsTeam cmdlet.</maml:para> <maml:para>This is an alias of the Team parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a new description</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DefaultAreaPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="TeamFieldValue"> <maml:name>DefaultAreaPath</maml:name> <maml:description> <maml:para>Specifies the team's default area path (or "team field"). The default area path is assigned automatically to all work items created in a team's backlog and/or board.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="TeamFieldValue"> <maml:name>TeamFieldValue</maml:name> <maml:description> <maml:para>Specifies the team's default area path (or "team field"). The default area path is assigned automatically to all work items created in a team's backlog and/or board.</maml:para> <maml:para>This is an alias of the DefaultAreaPath parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AreaPaths --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AreaPaths</maml:name> <maml:description> <maml:para>Specifies the backlog area paths that are associated with this team. Provide a list of area paths in the form '/path1/path2/[*]'. When the path ends with an asterisk, all child area path will be included recursively. Otherwise, only the area itself (without its children) will be included.</maml:para> </maml:description> <command:parameterValue required="true">IEnumerable`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.IEnumerable`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BacklogIteration --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BacklogIteration</maml:name> <maml:description> <maml:para>Specifies the team's backlog iteration path. When omitted, defaults to the team project's root iteration.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>\</dev:defaultValue> </command:parameter> <!-- Parameter: IterationPaths --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IterationPaths</maml:name> <maml:description> <maml:para>Specifies the backlog iteration paths that are associated with this team. Provide a list of iteration paths in the form '/path1/path2'.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DefaultIterationMacro --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DefaultIterationMacro</maml:name> <maml:description> <maml:para>Specifies the default iteration macro. When omitted, defaults to "@CurrentIteration".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>@CurrentIteration</dev:defaultValue> </command:parameter> <!-- Parameter: BugsBehavior --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BugsBehavior</maml:name> <maml:description> <maml:para>Specifies how bugs should behave when added to a board.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BacklogVisibilities --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BacklogVisibilities</maml:name> <maml:description> <maml:para>Specifies which backlog levels (e.g. Epics, Features, Stories) should be visible.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Default --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Default</maml:name> <maml:description> <maml:para>Sets the supplied team as the default team project team.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: WorkingDays --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WorkingDays</maml:name> <maml:description> <maml:para>Specifies the team's Working Days. When omitted, defaults to Monday thru Friday</maml:para> </maml:description> <command:parameterValue required="true">IEnumerable`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.IEnumerable`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>monday, tuesday, wednesday, thursday, friday</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeam (if any). For more details, see the Get-TfsTeam cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: WebApiTeam --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.Core.WebApi.WebApiTeam</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/Team/Set-TfsTeam</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Add-TfsTeamAdmin --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="Team.TeamAdmin"> <command:details> <command:name>Add-TfsTeamAdmin</command:name> <command:verb>Add</command:verb> <command:noun>TfsTeamAdmin</command:noun> <maml:description> <maml:para>Adds a new administrator to a team.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Add-TfsTeamAdmin</maml:name> <!-- Parameter: Admin --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Admin</maml:name> <maml:description> <maml:para>Specifies the administrator to add to the given team.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Team --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeam (if any). For more details, see the Get-TfsTeam cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Admin --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Admin</maml:name> <maml:description> <maml:para>Specifies the administrator to add to the given team.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Team --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeam (if any). For more details, see the Get-TfsTeam cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the administrator to add to the given team.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: TeamAdmins --> <command:returnValue> <dev:type> <maml:name>TfsCmdlets.HttpClient.TeamAdmins</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/Team/TeamAdmin/Add-TfsTeamAdmin</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-TfsTeamAdmin --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="Team.TeamAdmin"> <command:details> <command:name>Get-TfsTeamAdmin</command:name> <command:verb>Get</command:verb> <command:noun>TfsTeamAdmin</command:noun> <maml:description> <maml:para>Gets the administrators of a team.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Get-TfsTeamAdmin</maml:name> <!-- Parameter: Team --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeam (if any). For more details, see the Get-TfsTeam cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Admin --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Admin</maml:name> <maml:description> <maml:para>Specifies the administrator to get from the given team. Wildcards are supported. When omitted, all administrators are returned.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Team --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeam (if any). For more details, see the Get-TfsTeam cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Admin --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Admin</maml:name> <maml:description> <maml:para>Specifies the administrator to get from the given team. Wildcards are supported. When omitted, all administrators are returned.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeam (if any). For more details, see the Get-TfsTeam cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Identity --> <command:returnValue> <dev:type> <maml:name>Microsoft.VisualStudio.Services.Identity.Identity</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/Team/TeamAdmin/Get-TfsTeamAdmin</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-TfsTeamAdmin --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="Team.TeamAdmin"> <command:details> <command:name>Remove-TfsTeamAdmin</command:name> <command:verb>Remove</command:verb> <command:noun>TfsTeamAdmin</command:noun> <maml:description> <maml:para>Removes an administrator from a team.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Remove-TfsTeamAdmin</maml:name> <!-- Parameter: Admin --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Admin</maml:name> <maml:description> <maml:para>Specifies the administrator to remove from the team.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Team --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeam (if any). For more details, see the Get-TfsTeam cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Admin --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Admin</maml:name> <maml:description> <maml:para>Specifies the administrator to remove from the team.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Team --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeam (if any). For more details, see the Get-TfsTeam cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the administrator to remove from the team.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: TeamAdmins --> <command:returnValue> <dev:type> <maml:name>TfsCmdlets.HttpClient.TeamAdmins</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/Team/TeamAdmin/Remove-TfsTeamAdmin</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-TfsTeamBacklogLevel --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="Team.Backlog"> <command:details> <command:name>Get-TfsTeamBacklogLevel</command:name> <command:verb>Get</command:verb> <command:noun>TfsTeamBacklogLevel</command:noun> <maml:description> <maml:para>Gets information about one or more backlog levels of a given team.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Get-TfsTeamBacklogLevel</maml:name> <!-- Parameter: Backlog --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Backlog</maml:name> <maml:description> <maml:para>Specifies one or more backlog level configurations to be returned. Valid values are the name (e.g. "Stories") or the ID (e.g. "Microsoft.RequirementCategory") of the backlog level to return. Wilcards are supported. When omitted, returns all backlogs levels of the given team.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Team --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeam (if any). For more details, see the Get-TfsTeam cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Backlog --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Backlog</maml:name> <maml:description> <maml:para>Specifies one or more backlog level configurations to be returned. Valid values are the name (e.g. "Stories") or the ID (e.g. "Microsoft.RequirementCategory") of the backlog level to return. Wilcards are supported. When omitted, returns all backlogs levels of the given team.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies one or more backlog level configurations to be returned. Valid values are the name (e.g. "Stories") or the ID (e.g. "Microsoft.RequirementCategory") of the backlog level to return. Wilcards are supported. When omitted, returns all backlogs levels of the given team.</maml:para> <maml:para>This is an alias of the Backlog parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: Team --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeam (if any). For more details, see the Get-TfsTeam cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeam (if any). For more details, see the Get-TfsTeam cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: BacklogLevelConfiguration --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.Work.WebApi.BacklogLevelConfiguration</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/Team/Backlog/Get-TfsTeamBacklogLevel</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-TfsTeamBoard --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="Team.Board"> <command:details> <command:name>Get-TfsTeamBoard</command:name> <command:verb>Get</command:verb> <command:noun>TfsTeamBoard</command:noun> <maml:description> <maml:para>Gets one or more team boards.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Get-TfsTeamBoard</maml:name> <!-- Parameter: Board --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Board</maml:name> <maml:description> <maml:para>Specifies the board name. Wildcards are supported. When omitted, returns all boards in the given team.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Team --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeam (if any). For more details, see the Get-TfsTeam cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Board --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Board</maml:name> <maml:description> <maml:para>Specifies the board name. Wildcards are supported. When omitted, returns all boards in the given team.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the board name. Wildcards are supported. When omitted, returns all boards in the given team.</maml:para> <maml:para>This is an alias of the Board parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: Team --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeam (if any). For more details, see the Get-TfsTeam cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeam (if any). For more details, see the Get-TfsTeam cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Board --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.Work.WebApi.Board</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/Team/Board/Get-TfsTeamBoard</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-TfsTeamBoardCardRule --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="Team.Board"> <command:details> <command:name>Get-TfsTeamBoardCardRule</command:name> <command:verb>Get</command:verb> <command:noun>TfsTeamBoardCardRule</command:noun> <maml:description> <maml:para>Gets one or more team board card rules.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Get-TfsTeamBoardCardRule</maml:name> <!-- Parameter: Rule --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Rule</maml:name> <maml:description> <maml:para>Specifies the rule name. Wildcards are supported. When omitted, returns all card rules in the given board.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: Board --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Board</maml:name> <maml:description> <maml:para>Specifies the board name.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RuleType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RuleType</maml:name> <maml:description> <maml:para>Specifies the kind of rule to return. When omitted, returns both rule types (card color and tag color).</maml:para> <maml:para>Possible values: CardColor, TagColor, All</maml:para> </maml:description> <command:parameterValue required="true">CardRuleType</command:parameterValue> <dev:type> <maml:name>TfsCmdlets.CardRuleType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">CardColor</command:parameterValue> <command:parameterValue required="false" variableLength="false">TagColor</command:parameterValue> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Team --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeam (if any). For more details, see the Get-TfsTeam cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Rule --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Rule</maml:name> <maml:description> <maml:para>Specifies the rule name. Wildcards are supported. When omitted, returns all card rules in the given board.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: RuleType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RuleType</maml:name> <maml:description> <maml:para>Specifies the kind of rule to return. When omitted, returns both rule types (card color and tag color).</maml:para> <maml:para>Possible values: CardColor, TagColor, All</maml:para> </maml:description> <command:parameterValue required="true">CardRuleType</command:parameterValue> <dev:type> <maml:name>TfsCmdlets.CardRuleType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">CardColor</command:parameterValue> <command:parameterValue required="false" variableLength="false">TagColor</command:parameterValue> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Board --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Board</maml:name> <maml:description> <maml:para>Specifies the board name.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Team --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeam (if any). For more details, see the Get-TfsTeam cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the board name.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Rule --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.Work.WebApi.Rule</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/Team/Board/Get-TfsTeamBoardCardRule</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-TfsTeamBoardCardRuleSetting --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="Team.Board"> <command:details> <command:name>Set-TfsTeamBoardCardRuleSetting</command:name> <command:verb>Set</command:verb> <command:noun>TfsTeamBoardCardRuleSetting</command:noun> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Set-TfsTeamBoardCardRuleSetting</maml:name> <!-- Parameter: Board --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Board</maml:name> <maml:description> <maml:para>Specifies the board name. Wildcards are supported. When omitted, returns card rules for all boards in the given team.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Team --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeam (if any). For more details, see the Get-TfsTeam cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Board --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Board</maml:name> <maml:description> <maml:para>Specifies the board name. Wildcards are supported. When omitted, returns card rules for all boards in the given team.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: Team --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeam (if any). For more details, see the Get-TfsTeam cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeam (if any). For more details, see the Get-TfsTeam cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: BoardCardRuleSettings --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.Work.WebApi.BoardCardRuleSettings</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Add-TfsTeamMember --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="Team.TeamMember"> <command:details> <command:name>Add-TfsTeamMember</command:name> <command:verb>Add</command:verb> <command:noun>TfsTeamMember</command:noun> <maml:description> <maml:para>Adds new members to a team.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Add-TfsTeamMember</maml:name> <!-- Parameter: Member --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Member</maml:name> <maml:description> <maml:para>Specifies the member (user or group) to add to the given team.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Team --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specifies the team to which the member is added.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Member --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Member</maml:name> <maml:description> <maml:para>Specifies the member (user or group) to add to the given team.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Team --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specifies the team to which the member is added.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the member (user or group) to add to the given team.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: TeamAdmins --> <command:returnValue> <dev:type> <maml:name>TfsCmdlets.HttpClient.TeamAdmins</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/Team/TeamMember/Add-TfsTeamMember</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-TfsTeamMember --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="Team.TeamMember"> <command:details> <command:name>Get-TfsTeamMember</command:name> <command:verb>Get</command:verb> <command:noun>TfsTeamMember</command:noun> <maml:description> <maml:para>Gets the members of a team.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Get-TfsTeamMember</maml:name> <!-- Parameter: Team --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specifies the team from which to get its members.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Member --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Member</maml:name> <maml:description> <maml:para>Specifies the member (user or group) to get from the given team. Wildcards are supported. When omitted, all team members are returned.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Recurse --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>Recursively expands all member groups, returning the users and/or groups contained in them</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Team --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specifies the team from which to get its members.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Member --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Member</maml:name> <maml:description> <maml:para>Specifies the member (user or group) to get from the given team. Wildcards are supported. When omitted, all team members are returned.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: Recurse --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>Recursively expands all member groups, returning the users and/or groups contained in them</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the team from which to get its members.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Identity --> <command:returnValue> <dev:type> <maml:name>Microsoft.VisualStudio.Services.Identity.Identity</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/Team/TeamMember/Get-TfsTeamMember</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-TfsTeamMember --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="Team.TeamMember"> <command:details> <command:name>Remove-TfsTeamMember</command:name> <command:verb>Remove</command:verb> <command:noun>TfsTeamMember</command:noun> <maml:description> <maml:para>Removes a member from a team.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Remove-TfsTeamMember</maml:name> <!-- Parameter: Member --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Member</maml:name> <maml:description> <maml:para>Specifies the member (user or group) to remove from the given team.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Team --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specifies the team from which the member is removed.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Member --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Member</maml:name> <maml:description> <maml:para>Specifies the member (user or group) to remove from the given team.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Team --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specifies the team from which the member is removed.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the member (user or group) to remove from the given team.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/Team/TeamMember/Remove-TfsTeamMember</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Connect-TfsTeamProject --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="Connection"> <command:details> <command:name>Connect-TfsTeamProject</command:name> <command:verb>Connect</command:verb> <command:noun>TfsTeamProject</command:noun> <maml:description> <maml:para>Connects to a Team Project.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: Prompt for credential --> <command:syntaxItem tfscmdlets:parameterSet="Prompt for credential"> <maml:name>Connect-TfsTeamProject</maml:name> <!-- Parameter: Project --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Project</maml:name> <maml:description> <maml:para>Specifies the name of the Team Project, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.TeamProject object to connect to.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Interactive --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Interactive</maml:name> <maml:description> <maml:para>Prompts for user credentials. Can be used for any Team Foundation Server or Azure DevOps account - the proper login dialog is automatically selected. Should only be used in an interactive PowerShell session (i.e., a PowerShell terminal window), never in an unattended script (such as those executed during an automated build). Currently it is only supported in Windows PowerShell.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter Set: Cached credentials --> <command:syntaxItem tfscmdlets:parameterSet="Cached credentials"> <maml:name>Connect-TfsTeamProject</maml:name> <!-- Parameter: Project --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Project</maml:name> <maml:description> <maml:para>Specifies the name of the Team Project, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.TeamProject object to connect to.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Cached --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Cached</maml:name> <maml:description> <maml:para>Specifies that cached (default) credentials should be used when possible/available.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter Set: User name and password --> <command:syntaxItem tfscmdlets:parameterSet="User name and password"> <maml:name>Connect-TfsTeamProject</maml:name> <!-- Parameter: Project --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Project</maml:name> <maml:description> <maml:para>Specifies the name of the Team Project, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.TeamProject object to connect to.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>UserName</maml:name> <maml:description> <maml:para>Specifies a user name for authentication modes (such as Basic) that support username/password-based credentials. Must be used in conjunction with the -Password argument</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Password --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies a password for authentication modes (such as Basic) that support username/password-based credentials. Must be used in conjunction with the -UserName argument</maml:para> </maml:description> <command:parameterValue required="true">SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter Set: Credential object --> <command:syntaxItem tfscmdlets:parameterSet="Credential object"> <maml:name>Connect-TfsTeamProject</maml:name> <!-- Parameter: Project --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Project</maml:name> <maml:description> <maml:para>Specifies the name of the Team Project, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.TeamProject object to connect to.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies a user account that has permission to perform this action. To provide a user name and password, a Personal Access Token, and/or to open a input dialog to enter your credentials, call Get-TfsCredential with the appropriate arguments and pass its return to this argument.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter Set: Personal Access Token --> <command:syntaxItem tfscmdlets:parameterSet="Personal Access Token"> <maml:name>Connect-TfsTeamProject</maml:name> <!-- Parameter: Project --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Project</maml:name> <maml:description> <maml:para>Specifies the name of the Team Project, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.TeamProject object to connect to.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PersonalAccessToken --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="Pat"> <maml:name>PersonalAccessToken</maml:name> <maml:description> <maml:para>Specifies a personal access token, used as an alternate credential, to authenticate to Azure DevOps</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Project</maml:name> <maml:description> <maml:para>Specifies the name of the Team Project, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.TeamProject object to connect to.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Interactive --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Interactive</maml:name> <maml:description> <maml:para>Prompts for user credentials. Can be used for any Team Foundation Server or Azure DevOps account - the proper login dialog is automatically selected. Should only be used in an interactive PowerShell session (i.e., a PowerShell terminal window), never in an unattended script (such as those executed during an automated build). Currently it is only supported in Windows PowerShell.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Cached --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Cached</maml:name> <maml:description> <maml:para>Specifies that cached (default) credentials should be used when possible/available.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UserName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>UserName</maml:name> <maml:description> <maml:para>Specifies a user name for authentication modes (such as Basic) that support username/password-based credentials. Must be used in conjunction with the -Password argument</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Password --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies a password for authentication modes (such as Basic) that support username/password-based credentials. Must be used in conjunction with the -UserName argument</maml:para> </maml:description> <command:parameterValue required="true">SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies a user account that has permission to perform this action. To provide a user name and password, a Personal Access Token, and/or to open a input dialog to enter your credentials, call Get-TfsCredential with the appropriate arguments and pass its return to this argument.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PersonalAccessToken --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="Pat"> <maml:name>PersonalAccessToken</maml:name> <maml:description> <maml:para>Specifies a personal access token, used as an alternate credential, to authenticate to Azure DevOps</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="Pat"> <maml:name>Pat</maml:name> <maml:description> <maml:para>Specifies a personal access token, used as an alternate credential, to authenticate to Azure DevOps</maml:para> <maml:para>This is an alias of the PersonalAccessToken parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the name of the Team Project, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.TeamProject object to connect to.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: TeamProject --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.Core.WebApi.TeamProject</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/Connection/Connect-TfsTeamProject</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Disconnect-TfsTeamProject --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="Connection"> <command:details> <command:name>Disconnect-TfsTeamProject</command:name> <command:verb>Disconnect</command:verb> <command:noun>TfsTeamProject</command:noun> <maml:description> <maml:para>Disconnects from the currently connected team project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Disconnect-TfsTeamProject cmdlet removes the connection previously set by its counterpart Connect-TfsTeamProject. Therefore, cmdlets relying on a "default team project" as provided by "Get-TfsTeamProject -Current" will no longer work after a call to this cmdlet, unless their -Project argument is provided or a new call to Connect-TfsTeamProject is made.</maml:para> </maml:description> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Disconnect-TfsTeamProject</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/Connection/Disconnect-TfsTeamProject</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-TfsTeamProject --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="TeamProject"> <command:details> <command:name>Get-TfsTeamProject</command:name> <command:verb>Get</command:verb> <command:noun>TfsTeamProject</command:noun> <maml:description> <maml:para>Gets information about one or more team projects.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-TfsTeamProject cmdlets gets one or more Team Project objects (an instance of Microsoft.TeamFoundation.Core.WebApi.TeamProject) from the supplied Team Project Collection.</maml:para> </maml:description> <command:syntax> <!-- Parameter Set: Get by project --> <command:syntaxItem tfscmdlets:parameterSet="Get by project"> <maml:name>Get-TfsTeamProject</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Project</maml:name> <maml:description> <maml:para>Specifies the name of a Team Project. Wildcards are supported. When omitted, all team projects in the supplied collection are returned.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Deleted --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Deleted</maml:name> <maml:description> <maml:para>Lists deleted team projects present in the "recycle bin"</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter Set: Get current --> <command:syntaxItem tfscmdlets:parameterSet="Get current"> <maml:name>Get-TfsTeamProject</maml:name> <!-- Parameter: Current --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Current</maml:name> <maml:description> <maml:para>Returns the team project specified in the last call to Connect-TfsTeamProject (i.e. the "current" team project)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Project</maml:name> <maml:description> <maml:para>Specifies the name of a Team Project. Wildcards are supported. When omitted, all team projects in the supplied collection are returned.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: Deleted --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Deleted</maml:name> <maml:description> <maml:para>Lists deleted team projects present in the "recycle bin"</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Current --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Current</maml:name> <maml:description> <maml:para>Returns the team project specified in the last call to Connect-TfsTeamProject (i.e. the "current" team project)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>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).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: TeamProject --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.Core.WebApi.TeamProject</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/TeamProject/Get-TfsTeamProject</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-TfsTeamProject --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="TeamProject"> <command:details> <command:name>New-TfsTeamProject</command:name> <command:verb>New</command:verb> <command:noun>TfsTeamProject</command:noun> <maml:description> <maml:para>Creates a new team project.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>New-TfsTeamProject</maml:name> <!-- Parameter: Project --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Project</maml:name> <maml:description> <maml:para>Specifies the name of the new team project.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a description for the new team project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ProcessTemplate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProcessTemplate</maml:name> <maml:description> <maml:para>Specifies the process template on which the new team project is based. Supported values are the process name or an instance of the Microsoft.TeamFoundation.Core.WebApi.Process class.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceControl --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceControl</maml:name> <maml:description> <maml:para>Specifies the source control type to be provisioned initially with the team project. Supported types are "Git" and "Tfvc".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Project</maml:name> <maml:description> <maml:para>Specifies the name of the new team project.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a description for the new team project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceControl --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceControl</maml:name> <maml:description> <maml:para>Specifies the source control type to be provisioned initially with the team project. Supported types are "Git" and "Tfvc".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProcessTemplate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProcessTemplate</maml:name> <maml:description> <maml:para>Specifies the process template on which the new team project is based. Supported values are the process name or an instance of the Microsoft.TeamFoundation.Core.WebApi.Process class.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: TeamProject --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.Core.WebApi.TeamProject</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/TeamProject/New-TfsTeamProject</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-TfsTeamProject --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="TeamProject"> <command:details> <command:name>Remove-TfsTeamProject</command:name> <command:verb>Remove</command:verb> <command:noun>TfsTeamProject</command:noun> <maml:description> <maml:para>Deletes one or more team projects.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Remove-TfsTeamProject</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Project</maml:name> <maml:description> <maml:para>Specifies the name of a Team Project to delete. Wildcards are supported.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the exclusion of the team project. When omitted, the command prompts for confirmation prior to deleting the team project.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Hard --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Hard</maml:name> <maml:description> <maml:para>Deletes the team project permanently. When omitted, the team project is moved to a "recycle bin" and can be recovered either via UI or by using Undo-TfsTeamProjectRemoval.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Project</maml:name> <maml:description> <maml:para>Specifies the name of a Team Project to delete. Wildcards are supported.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Hard --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Hard</maml:name> <maml:description> <maml:para>Deletes the team project permanently. When omitted, the team project is moved to a "recycle bin" and can be recovered either via UI or by using Undo-TfsTeamProjectRemoval.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the exclusion of the team project. When omitted, the command prompts for confirmation prior to deleting the team project.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the name of a Team Project to delete. Wildcards are supported.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/TeamProject/Remove-TfsTeamProject</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Rename-TfsTeamProject --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="TeamProject"> <command:details> <command:name>Rename-TfsTeamProject</command:name> <command:verb>Rename</command:verb> <command:noun>TfsTeamProject</command:noun> <maml:description> <maml:para>Renames a team project.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Rename-TfsTeamProject</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Project</maml:name> <maml:description> <maml:para>Specifies the name of a Team Project to rename.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NewName</maml:name> <maml:description> <maml:para>Specifies the new name of the item. Enter only a name - i.e., for items that support paths, do not enter a path and name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the renaming of the team project. When omitted, the command prompts for confirmation prior to renaming the team project.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Project</maml:name> <maml:description> <maml:para>Specifies the name of a Team Project to rename.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the renaming of the team project. When omitted, the command prompts for confirmation prior to renaming the team project.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NewName</maml:name> <maml:description> <maml:para>Specifies the new name of the item. Enter only a name - i.e., for items that support paths, do not enter a path and name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the name of a Team Project to rename.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/TeamProject/Rename-TfsTeamProject</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Connect-TfsTeamProjectCollection --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="Connection"> <command:details> <command:name>Connect-TfsTeamProjectCollection</command:name> <command:verb>Connect</command:verb> <command:noun>TfsTeamProjectCollection</command:noun> <maml:description> <maml:para>Connects to a TFS team project collection or Azure DevOps organization.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Connect-TfsTeamProjectCollection cmdlet connects to a TFS Team Project Collection or Azure DevOps organization. That connection can be later reused by other TfsCmdlets commands until it's closed by a call to Disconnect-TfsTeamProjectCollection.</maml:para> </maml:description> <command:syntax> <!-- Parameter Set: Cached credentials --> <command:syntaxItem tfscmdlets:parameterSet="Cached credentials"> <maml:name>Connect-TfsTeamProjectCollection</maml:name> <!-- Parameter: Collection --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Cached --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Cached</maml:name> <maml:description> <maml:para>Specifies that cached (default) credentials should be used when possible/available.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter Set: User name and password --> <command:syntaxItem tfscmdlets:parameterSet="User name and password"> <maml:name>Connect-TfsTeamProjectCollection</maml:name> <!-- Parameter: Collection --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>UserName</maml:name> <maml:description> <maml:para>Specifies a user name for authentication modes (such as Basic) that support username/password-based credentials. Must be used in conjunction with the -Password argument</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Password --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies a password for authentication modes (such as Basic) that support username/password-based credentials. Must be used in conjunction with the -UserName argument</maml:para> </maml:description> <command:parameterValue required="true">SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter Set: Credential object --> <command:syntaxItem tfscmdlets:parameterSet="Credential object"> <maml:name>Connect-TfsTeamProjectCollection</maml:name> <!-- Parameter: Collection --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies a user account that has permission to perform this action. To provide a user name and password, a Personal Access Token, and/or to open a input dialog to enter your credentials, call Get-TfsCredential with the appropriate arguments and pass its return to this argument.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter Set: Personal Access Token --> <command:syntaxItem tfscmdlets:parameterSet="Personal Access Token"> <maml:name>Connect-TfsTeamProjectCollection</maml:name> <!-- Parameter: Collection --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PersonalAccessToken --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="Pat"> <maml:name>PersonalAccessToken</maml:name> <maml:description> <maml:para>Specifies a personal access token, used as an alternate credential, to authenticate to Azure DevOps</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter Set: Prompt for credential --> <command:syntaxItem tfscmdlets:parameterSet="Prompt for credential"> <maml:name>Connect-TfsTeamProjectCollection</maml:name> <!-- Parameter: Collection --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Interactive --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Interactive</maml:name> <maml:description> <maml:para>Prompts for user credentials. Can be used for any Team Foundation Server or Azure DevOps account - the proper login dialog is automatically selected. Should only be used in an interactive PowerShell session (i.e., a PowerShell terminal window), never in an unattended script (such as those executed during an automated build). Currently it is only supported in Windows PowerShell.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Collection --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Cached --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Cached</maml:name> <maml:description> <maml:para>Specifies that cached (default) credentials should be used when possible/available.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UserName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>UserName</maml:name> <maml:description> <maml:para>Specifies a user name for authentication modes (such as Basic) that support username/password-based credentials. Must be used in conjunction with the -Password argument</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Password --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies a password for authentication modes (such as Basic) that support username/password-based credentials. Must be used in conjunction with the -UserName argument</maml:para> </maml:description> <command:parameterValue required="true">SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies a user account that has permission to perform this action. To provide a user name and password, a Personal Access Token, and/or to open a input dialog to enter your credentials, call Get-TfsCredential with the appropriate arguments and pass its return to this argument.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PersonalAccessToken --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="Pat"> <maml:name>PersonalAccessToken</maml:name> <maml:description> <maml:para>Specifies a personal access token, used as an alternate credential, to authenticate to Azure DevOps</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="Pat"> <maml:name>Pat</maml:name> <maml:description> <maml:para>Specifies a personal access token, used as an alternate credential, to authenticate to Azure DevOps</maml:para> <maml:para>This is an alias of the PersonalAccessToken parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Interactive --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Interactive</maml:name> <maml:description> <maml:para>Prompts for user credentials. Can be used for any Team Foundation Server or Azure DevOps account - the proper login dialog is automatically selected. Should only be used in an interactive PowerShell session (i.e., a PowerShell terminal window), never in an unattended script (such as those executed during an automated build). Currently it is only supported in Windows PowerShell.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>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.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: VssConnection --> <command:returnValue> <dev:type> <maml:name>Microsoft.VisualStudio.Services.WebApi.VssConnection</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS> Connect-TfsTeamProjectCollection -Collection http://tfs:8080/tfs/DefaultCollection</dev:code> <dev:remarks> <maml:para>Connects to a collection called "DefaultCollection" in a TF server called "tfs" using the cached credentials of the logged-on user</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS> Connect-TfsTeamProjectCollection -Collection http://tfs:8080/tfs/DefaultCollection -Interactive</dev:code> <dev:remarks> <maml:para>Connects to a collection called "DefaultCollection" in a Team Foundation server called "tfs", firstly prompting the user for credentials (it ignores the cached credentials for the currently logged-in user). It's equivalent to the command: `Connect-TfsTeamProjectCollection -Collection http://tfs:8080/tfs/DefaultCollection -Credential (Get-TfsCredential -Interactive)`</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/Connection/Connect-TfsTeamProjectCollection</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Disconnect-TfsTeamProjectCollection --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="Connection"> <command:details> <command:name>Disconnect-TfsTeamProjectCollection</command:name> <command:verb>Disconnect</command:verb> <command:noun>TfsTeamProjectCollection</command:noun> <maml:description> <maml:para>Disconnects from the currently connected TFS team project collection or Azure DevOps organization.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Disconnect-TfsTeamProjectCollection cmdlet removes the connection previously set by its counterpart Connect-TfsTeamProjectCollection. Therefore, cmdlets relying on a "default collection" as provided by "Get-TfsTeamProjectCollection -Current" will no longer work after a call to this cmdlet, unless their -Collection argument is provided or a new call to Connect-TfsTeam is made.</maml:para> </maml:description> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Disconnect-TfsTeamProjectCollection</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/Connection/Disconnect-TfsTeamProjectCollection</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Dismount-TfsTeamProjectCollection --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="TeamProjectCollection"> <command:details> <command:name>Dismount-TfsTeamProjectCollection</command:name> <command:verb>Dismount</command:verb> <command:noun>TfsTeamProjectCollection</command:noun> <maml:description> <maml:para>Detaches a team project collection database from a Team Foundation Server installation.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Before you move a collection, you must first detach it from the deployment of TFS on which it is running. It's very important that you do not skip this step. When you detach a collection, all jobs and services are stopped, and then the collection database is stopped. In addition, the detach process copies over the collection-specific data from the configuration database and saves it as part of the team project collection database. This configuration data is what allows the collection database to be attached to a different deployment of TFS. If that data is not present, you cannot attach the collection to any deployment of TFS except the one from which it originated. If detachment succeeds, this cmdlets returns the original database connection string. It is required to re-attach the collection to TFS.</maml:para> </maml:description> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Dismount-TfsTeamProjectCollection</maml:name> <!-- Parameter: Collection --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Collection</maml:name> <maml:description> <maml:para>Specifies the collection to detach.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Reason --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Reason</maml:name> <maml:description> <maml:para>Speficies a Servicing Message (optional), to provide a message for users who might try to connect to projects in this collection while it is offline.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Specifies the maximum period of time this cmdlet should wait for the detach procedure to complete. By default, it waits indefinitely until the collection servicing completes.</maml:para> </maml:description> <command:parameterValue required="true">TimeSpan</command:parameterValue> <dev:type> <maml:name>System.TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10675199.02:48:05.4775807</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Collection --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Collection</maml:name> <maml:description> <maml:para>Specifies the collection to detach.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Reason --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Reason</maml:name> <maml:description> <maml:para>Speficies a Servicing Message (optional), to provide a message for users who might try to connect to projects in this collection while it is offline.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Specifies the maximum period of time this cmdlet should wait for the detach procedure to complete. By default, it waits indefinitely until the collection servicing completes.</maml:para> </maml:description> <command:parameterValue required="true">TimeSpan</command:parameterValue> <dev:type> <maml:name>System.TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10675199.02:48:05.4775807</dev:defaultValue> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the collection to detach.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: String --> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS> Dismount-TfsTeamProjectCollection -Collection http://vsalm:8080/tfs/DefaultCollection -Reason "Collection DefaultCollecton is down for maintenance"</dev:code> <dev:remarks> <maml:para>Detaches the project collection specified by the URL provided in the Collection argument, defining a Maintenance Message to be shown to users when they try to connect to that collection while it is detached</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/TeamProjectCollection/Dismount-TfsTeamProjectCollection</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://www.visualstudio.com/en-us/docs/setup-admin/tfs/admin/move-project-collection#1-detach-the-collection</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-TfsTeamProjectCollection --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="TeamProjectCollection"> <command:details> <command:name>Get-TfsTeamProjectCollection</command:name> <command:verb>Get</command:verb> <command:noun>TfsTeamProjectCollection</command:noun> <maml:description> <maml:para>Gets one of more team project collections (organizations in Azure DevOps).</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: Get by collection --> <command:syntaxItem tfscmdlets:parameterSet="Get by collection"> <maml:name>Get-TfsTeamProjectCollection</maml:name> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies a user account that has permission to perform this action. To provide a user name and password, a Personal Access Token, and/or to open a input dialog to enter your credentials, call Get-TfsCredential with the appropriate arguments and pass its return to this argument.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter Set: Get current --> <command:syntaxItem tfscmdlets:parameterSet="Get current"> <maml:name>Get-TfsTeamProjectCollection</maml:name> <!-- Parameter: Current --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Current</maml:name> <maml:description> <maml:para>Returns the team project collection specified in the last call to Connect-TfsTeamProjectCollection (i.e. the "current" project collection)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies a user account that has permission to perform this action. To provide a user name and password, a Personal Access Token, and/or to open a input dialog to enter your credentials, call Get-TfsCredential with the appropriate arguments and pass its return to this argument.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Current --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Current</maml:name> <maml:description> <maml:para>Returns the team project collection specified in the last call to Connect-TfsTeamProjectCollection (i.e. the "current" project collection)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>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.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: VssConnection --> <command:returnValue> <dev:type> <maml:name>Microsoft.VisualStudio.Services.WebApi.VssConnection</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/TeamProjectCollection/Get-TfsTeamProjectCollection</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Mount-TfsTeamProjectCollection --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="TeamProjectCollection"> <command:details> <command:name>Mount-TfsTeamProjectCollection</command:name> <command:verb>Mount</command:verb> <command:noun>TfsTeamProjectCollection</command:noun> <maml:description> <maml:para>Attaches a team project collection database to a Team Foundation Server installation.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: Use database server --> <command:syntaxItem tfscmdlets:parameterSet="Use database server"> <maml:name>Mount-TfsTeamProjectCollection</maml:name> <!-- Parameter: Collection --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Collection</maml:name> <maml:description> <maml:para>Specifies the name of the collection to attach. It can be different from the original name - in that case, it is attached under a new name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DatabaseName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the collection database.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DatabaseServer --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DatabaseServer</maml:name> <maml:description> <maml:para>Specifies the name of the SQL Server instance where the database is stored.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Clone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Clone</maml:name> <maml:description> <maml:para>Changes the internal collection IDs upon attaching to that a "clone" of the original collection can be attached to the same server.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a new description for the collection. When omitted, it retains the original description.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InitialState --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InitialState</maml:name> <maml:description> <maml:para>Specifies whether the collection will be started ou stopped after being attached. When omitted, the collection is automatically started and goes online after being attached.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Started</dev:defaultValue> </command:parameter> <!-- Parameter: PollingInterval --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PollingInterval</maml:name> <maml:description> <maml:para>Specifies the polling interval (in seconds) to get an updated status from the server. When omitted, defaults to 5 seconds.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Specifies the maximum period of time this cmdlet should wait for the attach procedure to complete. By default, it waits indefinitely until the collection servicing completes.</maml:para> </maml:description> <command:parameterValue required="true">TimeSpan</command:parameterValue> <dev:type> <maml:name>System.TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10675199.02:48:05.4775807</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter Set: Use connection string --> <command:syntaxItem tfscmdlets:parameterSet="Use connection string"> <maml:name>Mount-TfsTeamProjectCollection</maml:name> <!-- Parameter: Collection --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Collection</maml:name> <maml:description> <maml:para>Specifies the name of the collection to attach. It can be different from the original name - in that case, it is attached under a new name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ConnectionString --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ConnectionString</maml:name> <maml:description> <maml:para>Specifies the connection string of the collection database.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Clone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Clone</maml:name> <maml:description> <maml:para>Changes the internal collection IDs upon attaching to that a "clone" of the original collection can be attached to the same server.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a new description for the collection. When omitted, it retains the original description.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InitialState --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InitialState</maml:name> <maml:description> <maml:para>Specifies whether the collection will be started ou stopped after being attached. When omitted, the collection is automatically started and goes online after being attached.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Started</dev:defaultValue> </command:parameter> <!-- Parameter: PollingInterval --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PollingInterval</maml:name> <maml:description> <maml:para>Specifies the polling interval (in seconds) to get an updated status from the server. When omitted, defaults to 5 seconds.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Specifies the maximum period of time this cmdlet should wait for the attach procedure to complete. By default, it waits indefinitely until the collection servicing completes.</maml:para> </maml:description> <command:parameterValue required="true">TimeSpan</command:parameterValue> <dev:type> <maml:name>System.TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10675199.02:48:05.4775807</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Collection --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Collection</maml:name> <maml:description> <maml:para>Specifies the name of the collection to attach. It can be different from the original name - in that case, it is attached under a new name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the collection to attach. It can be different from the original name - in that case, it is attached under a new name.</maml:para> <maml:para>This is an alias of the Collection parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a new description for the collection. When omitted, it retains the original description.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DatabaseServer --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DatabaseServer</maml:name> <maml:description> <maml:para>Specifies the name of the SQL Server instance where the database is stored.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DatabaseName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the collection database.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ConnectionString --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ConnectionString</maml:name> <maml:description> <maml:para>Specifies the connection string of the collection database.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InitialState --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InitialState</maml:name> <maml:description> <maml:para>Specifies whether the collection will be started ou stopped after being attached. When omitted, the collection is automatically started and goes online after being attached.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Started</dev:defaultValue> </command:parameter> <!-- Parameter: Clone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Clone</maml:name> <maml:description> <maml:para>Changes the internal collection IDs upon attaching to that a "clone" of the original collection can be attached to the same server.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PollingInterval --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PollingInterval</maml:name> <maml:description> <maml:para>Specifies the polling interval (in seconds) to get an updated status from the server. When omitted, defaults to 5 seconds.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Specifies the maximum period of time this cmdlet should wait for the attach procedure to complete. By default, it waits indefinitely until the collection servicing completes.</maml:para> </maml:description> <command:parameterValue required="true">TimeSpan</command:parameterValue> <dev:type> <maml:name>System.TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10675199.02:48:05.4775807</dev:defaultValue> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>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.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/TeamProjectCollection/Mount-TfsTeamProjectCollection</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-TfsTeamProjectCollection --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="TeamProjectCollection"> <command:details> <command:name>New-TfsTeamProjectCollection</command:name> <command:verb>New</command:verb> <command:noun>TfsTeamProjectCollection</command:noun> <maml:description> <maml:para>Creates a new team project collection.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>New-TfsTeamProjectCollection</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <!-- OutputType: Connection --> <command:returnValue> <dev:type> <maml:name>TfsCmdlets.Models.Connection</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/TeamProjectCollection/New-TfsTeamProjectCollection</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-TfsTeamProjectCollection --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="TeamProjectCollection"> <command:details> <command:name>Remove-TfsTeamProjectCollection</command:name> <command:verb>Remove</command:verb> <command:noun>TfsTeamProjectCollection</command:noun> <maml:description> <maml:para>Deletes a team project collection.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Remove-TfsTeamProjectCollection</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/TeamProjectCollection/Remove-TfsTeamProjectCollection</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Start-TfsTeamProjectCollection --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="TeamProjectCollection"> <command:details> <command:name>Start-TfsTeamProjectCollection</command:name> <command:verb>Start</command:verb> <command:noun>TfsTeamProjectCollection</command:noun> <maml:description> <maml:para>Starts an offline team project collection and make it online.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Start-TfsTeamProjectCollection</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/TeamProjectCollection/Start-TfsTeamProjectCollection</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Stop-TfsTeamProjectCollection --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="TeamProjectCollection"> <command:details> <command:name>Stop-TfsTeamProjectCollection</command:name> <command:verb>Stop</command:verb> <command:noun>TfsTeamProjectCollection</command:noun> <maml:description> <maml:para>Stops a team project collection and make it offline.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Stop-TfsTeamProjectCollection</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/TeamProjectCollection/Stop-TfsTeamProjectCollection</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Undo-TfsTeamProjectRemoval --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="TeamProject"> <command:details> <command:name>Undo-TfsTeamProjectRemoval</command:name> <command:verb>Undo</command:verb> <command:noun>TfsTeamProjectRemoval</command:noun> <maml:description> <maml:para>Undeletes one or more team projects.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Undo-TfsTeamProjectRemoval</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Project</maml:name> <maml:description> <maml:para>Specifies the name of the Team Project to undelete.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Project</maml:name> <maml:description> <maml:para>Specifies the name of the Team Project to undelete.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the name of the Team Project to undelete.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/TeamProject/Undo-TfsTeamProjectRemoval</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Copy-TfsTestPlan --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="TestManagement"> <command:details> <command:name>Copy-TfsTestPlan</command:name> <command:verb>Copy</command:verb> <command:noun>TfsTestPlan</command:noun> <maml:description> <maml:para>Clones a test plan and, optionally, its test suites and test cases.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Copy-TfsTestPlan copies ("clones") a test plan to help duplicate test suites and/or test cases. Cloning is useful if you want to branch your application into two versions. After copying, the tests for the two versions can be changed without affecting each other. When you clone a test suite, the following objects are copied from the source test plan to the destination test plan: * Test cases (note: Each new test case retains its shared steps. A link is made between the source and new test cases. The new test cases do not have test runs, bugs, test results, and build information); * Shared steps referenced by cloned test cases; * Test suites (note: The following data is retained - Names and hierarchical structure of the test suites; Order of the test cases; Assigned testers; Configurations); * Action Recordings linked from a cloned test case; * Links and Attachments; * Test configuration. The items below are only copied when using -CloneRequirements: * Requirements-based suites; * Requirements work items (product backlog items or user stories); * Bug work items, when in a project that uses the Scrum process template or any other project in which the Bug work item type is in the Requirements work item category. In other projects, bugs are not cloned.</maml:para> </maml:description> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Copy-TfsTestPlan</maml:name> <!-- Parameter: AreaPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AreaPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CloneRequirements --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CloneRequirements</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CopyAllSuites --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Recurse"> <maml:name>CopyAllSuites</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: CopyAncestorHierarchy --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CopyAncestorHierarchy</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DeepClone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeepClone</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DestinationProject --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Destination"> <maml:name>DestinationProject</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DestinationWorkItemType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DestinationWorkItemType</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Test Case</dev:defaultValue> </command:parameter> <!-- Parameter: IterationPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IterationPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RelatedLinkComment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RelatedLinkComment</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SuiteIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SuiteIds</maml:name> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TestPlan --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="id"> <maml:name>TestPlan</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: TestPlan --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="id"> <maml:name>TestPlan</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="id"> <maml:name>id</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>This is an alias of the TestPlan parameter.</maml:para> </maml:description> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DestinationProject --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Destination"> <maml:name>DestinationProject</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Destination"> <maml:name>Destination</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>This is an alias of the DestinationProject parameter.</maml:para> </maml:description> </command:parameter> <!-- Parameter: AreaPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AreaPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IterationPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IterationPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DeepClone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeepClone</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: CopyAllSuites --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Recurse"> <maml:name>CopyAllSuites</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Recurse"> <maml:name>Recurse</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> <maml:description> <maml:para>This is an alias of the CopyAllSuites parameter.</maml:para> </maml:description> </command:parameter> <!-- Parameter: CopyAncestorHierarchy --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CopyAncestorHierarchy</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: CloneRequirements --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CloneRequirements</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DestinationWorkItemType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DestinationWorkItemType</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Test Case</dev:defaultValue> </command:parameter> <!-- Parameter: SuiteIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SuiteIds</maml:name> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RelatedLinkComment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RelatedLinkComment</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: TestPlan --> <command:returnValue> <dev:type> <maml:name>Microsoft.VisualStudio.Services.TestManagement.TestPlanning.WebApi.TestPlan</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS> Copy-TfsTestPlan -TestPlan "My test plan" -Project "SourceProject" -Destination "TargetProject" -NewName "My new test plan"</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/TestManagement/Copy-TfsTestPlan</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-TfsTestPlan --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="TestManagement"> <command:details> <command:name>Get-TfsTestPlan</command:name> <command:verb>Get</command:verb> <command:noun>TfsTestPlan</command:noun> <maml:description> <maml:para>Gets the contents of one or more test plans.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Get-TfsTestPlan</maml:name> <!-- Parameter: TestPlan --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Id,Name"> <maml:name>TestPlan</maml:name> <maml:description> <maml:para>Specifies the test plan name. Wildcards are supported. When omitted, returns all test cases in the given team project.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: Active --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Active</maml:name> <maml:description> <maml:para>Get only the active plans.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NoPlanDetails --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoPlanDetails</maml:name> <maml:description> <maml:para>Get only basic properties of the test plan.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Owner --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Owner</maml:name> <maml:description> <maml:para>Gets only the plans owned by the specified user.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: TestPlan --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Id,Name"> <maml:name>TestPlan</maml:name> <maml:description> <maml:para>Specifies the test plan name. Wildcards are supported. When omitted, returns all test cases in the given team project.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Id,Name"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the test plan name. Wildcards are supported. When omitted, returns all test cases in the given team project.</maml:para> <maml:para>This is an alias of the TestPlan parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Id,Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the test plan name. Wildcards are supported. When omitted, returns all test cases in the given team project.</maml:para> <maml:para>This is an alias of the TestPlan parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: Owner --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Owner</maml:name> <maml:description> <maml:para>Gets only the plans owned by the specified user.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NoPlanDetails --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoPlanDetails</maml:name> <maml:description> <maml:para>Get only basic properties of the test plan.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Active --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Active</maml:name> <maml:description> <maml:para>Get only the active plans.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>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.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: TestPlan --> <command:returnValue> <dev:type> <maml:name>Microsoft.VisualStudio.Services.TestManagement.TestPlanning.WebApi.TestPlan</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/TestManagement/Get-TfsTestPlan</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-TfsTestPlan --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="TestManagement"> <command:details> <command:name>New-TfsTestPlan</command:name> <command:verb>New</command:verb> <command:noun>TfsTestPlan</command:noun> <maml:description> <maml:para>Creates a new test plan.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>New-TfsTestPlan</maml:name> <!-- Parameter: TestPlan --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>TestPlan</maml:name> <maml:description> <maml:para>Specifies the test plan name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AreaPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AreaPath</maml:name> <maml:description> <maml:para>Specifies the owner of the new test plan.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EndDate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EndDate</maml:name> <maml:description> <maml:para>Specifies the end date of the test plan.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: IterationPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IterationPath</maml:name> <maml:description> <maml:para>Specifies the owner of the new test plan.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Owner --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Owner</maml:name> <maml:description> <maml:para>Specifies the owner of the new test plan.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StartDate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartDate</maml:name> <maml:description> <maml:para>Specifies the start date of the test plan.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: TestPlan --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>TestPlan</maml:name> <maml:description> <maml:para>Specifies the test plan name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the test plan name.</maml:para> <maml:para>This is an alias of the TestPlan parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AreaPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AreaPath</maml:name> <maml:description> <maml:para>Specifies the owner of the new test plan.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IterationPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IterationPath</maml:name> <maml:description> <maml:para>Specifies the owner of the new test plan.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StartDate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartDate</maml:name> <maml:description> <maml:para>Specifies the start date of the test plan.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: EndDate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EndDate</maml:name> <maml:description> <maml:para>Specifies the end date of the test plan.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: Owner --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Owner</maml:name> <maml:description> <maml:para>Specifies the owner of the new test plan.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: TestPlan --> <command:returnValue> <dev:type> <maml:name>Microsoft.VisualStudio.Services.TestManagement.TestPlanning.WebApi.TestPlan</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/TestManagement/New-TfsTestPlan</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-TfsTestPlan --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="TestManagement"> <command:details> <command:name>Remove-TfsTestPlan</command:name> <command:verb>Remove</command:verb> <command:noun>TfsTestPlan</command:noun> <maml:description> <maml:para>Deletes one or more test plans.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Remove-TfsTestPlan</maml:name> <!-- Parameter: TestPlan --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Id,Name"> <maml:name>TestPlan</maml:name> <maml:description> <maml:para>Specifies one or more test plans to delete. Wildcards are supported.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: TestPlan --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Id,Name"> <maml:name>TestPlan</maml:name> <maml:description> <maml:para>Specifies one or more test plans to delete. Wildcards are supported.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Id,Name"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies one or more test plans to delete. Wildcards are supported.</maml:para> <maml:para>This is an alias of the TestPlan parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Id,Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies one or more test plans to delete. Wildcards are supported.</maml:para> <maml:para>This is an alias of the TestPlan parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies one or more test plans to delete. Wildcards are supported.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/TestManagement/Remove-TfsTestPlan</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Rename-TfsTestPlan --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="TestManagement"> <command:details> <command:name>Rename-TfsTestPlan</command:name> <command:verb>Rename</command:verb> <command:noun>TfsTestPlan</command:noun> <maml:description> <maml:para>Renames a test plans.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Rename-TfsTestPlan</maml:name> <!-- Parameter: TestPlan --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Id,Name"> <maml:name>TestPlan</maml:name> <maml:description> <maml:para>Specifies the test plan name.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NewName</maml:name> <maml:description> <maml:para>Specifies the new name of the item. Enter only a name - i.e., for items that support paths, do not enter a path and name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: TestPlan --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Id,Name"> <maml:name>TestPlan</maml:name> <maml:description> <maml:para>Specifies the test plan name.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Id,Name"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the test plan name.</maml:para> <maml:para>This is an alias of the TestPlan parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Id,Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the test plan name.</maml:para> <maml:para>This is an alias of the TestPlan parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NewName</maml:name> <maml:description> <maml:para>Specifies the new name of the item. Enter only a name - i.e., for items that support paths, do not enter a path and name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the test plan name.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: TestPlan --> <command:returnValue> <dev:type> <maml:name>Microsoft.VisualStudio.Services.TestManagement.TestPlanning.WebApi.TestPlan</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/TestManagement/Rename-TfsTestPlan</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-TfsVersion --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="Admin"> <command:details> <command:name>Get-TfsVersion</command:name> <command:verb>Get</command:verb> <command:noun>TfsVersion</command:noun> <maml:description> <maml:para>Gets the version information about Team Foundation / Azure DevOps servers and Azure DevOps Services organizations.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-TfsVersion cmdlet retrieves version information from the supplied team project collection or Azure DevOps organization. When available/applicable, detailed information about installed updates, deployed sprints and so on are also provided.</maml:para> </maml:description> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Get-TfsVersion</maml:name> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>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).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: ServerVersion --> <command:returnValue> <dev:type> <maml:name>TfsCmdlets.Util.ServerVersion</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/Admin/Get-TfsVersion</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Copy-TfsWorkItem --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="WorkItem"> <command:details> <command:name>Copy-TfsWorkItem</command:name> <command:verb>Copy</command:verb> <command:noun>TfsWorkItem</command:noun> <maml:description> <maml:para>Creates a copy of a work item, optionally changing its type.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Use this cmdlet to create a copy of a work item (using its latest saved state/revision data) that is of the specified work item type. By default, the copy retains the same type of the original work item, unless the Type argument is specified</maml:para> </maml:description> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Copy-TfsWorkItem</maml:name> <!-- Parameter: WorkItem --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="id"> <maml:name>WorkItem</maml:name> <maml:description> <maml:para>Specifies a work item. Valid values are the work item ID or an instance of Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DestinationProject --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DestinationProject</maml:name> <maml:description> <maml:para>Specifies the team project where the work item will be copied into. When omitted, the copy will be created in the same team project of the source work item.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IncludeAttachments --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeAttachments</maml:name> <maml:description> <maml:para>Creates a duplicate of all attachments present in the source work item and adds them to the new work item.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IncludeLinks --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeLinks</maml:name> <maml:description> <maml:para>Creates a copy of all links present in the source work item and adds them to the new work item. Only the links are copied; linked artifacts themselves are not copied. In other words, both the original and the copy work items point to the same linked artifacts.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: NewType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewType</maml:name> <maml:description> <maml:para>Specifies the type of the new work item. When omitted, the type of the original work item is preserved.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. It takes one of the following values: Original (returns the original work item), Copy (returns the newly created work item copy) or None.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Copy</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Specifies the source team project from where the work item will be copied. When omitted, it defaults to the team project of the piped work item (if any), or to the connection set by Connect-TfsTeamProject.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: WorkItem --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="id"> <maml:name>WorkItem</maml:name> <maml:description> <maml:para>Specifies a work item. Valid values are the work item ID or an instance of Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="id"> <maml:name>id</maml:name> <maml:description> <maml:para>Specifies a work item. Valid values are the work item ID or an instance of Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem.</maml:para> <maml:para>This is an alias of the WorkItem parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewType</maml:name> <maml:description> <maml:para>Specifies the type of the new work item. When omitted, the type of the original work item is preserved.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IncludeAttachments --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeAttachments</maml:name> <maml:description> <maml:para>Creates a duplicate of all attachments present in the source work item and adds them to the new work item.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IncludeLinks --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeLinks</maml:name> <maml:description> <maml:para>Creates a copy of all links present in the source work item and adds them to the new work item. Only the links are copied; linked artifacts themselves are not copied. In other words, both the original and the copy work items point to the same linked artifacts.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DestinationProject --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DestinationProject</maml:name> <maml:description> <maml:para>Specifies the team project where the work item will be copied into. When omitted, the copy will be created in the same team project of the source work item.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Specifies the source team project from where the work item will be copied. When omitted, it defaults to the team project of the piped work item (if any), or to the connection set by Connect-TfsTeamProject.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. It takes one of the following values: Original (returns the original work item), Copy (returns the newly created work item copy) or None.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Copy</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies a work item. Valid values are the work item ID or an instance of Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: WorkItem --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/WorkItem/Copy-TfsWorkItem</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-TfsWorkItem --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="WorkItem"> <command:details> <command:name>Get-TfsWorkItem</command:name> <command:verb>Get</command:verb> <command:noun>TfsWorkItem</command:noun> <maml:description> <maml:para>Gets the contents of one or more work items.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: Query by revision --> <command:syntaxItem tfscmdlets:parameterSet="Query by revision"> <maml:name>Get-TfsWorkItem</maml:name> <!-- Parameter: WorkItem --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="id"> <maml:name>WorkItem</maml:name> <maml:description> <maml:para>Specifies a work item. Valid values are the work item ID or an instance of Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Fields --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Fields</maml:name> <maml:description> <maml:para>Specifies which fields should be retrieved. When omitted, defaults to a set of standard fields that include Id, Title, Description, some state-related fields and more.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.AreaPath, System.TeamProject, System.IterationPath, System.WorkItemType, System.State, System.Reason, System.CreatedDate, System.CreatedBy, System.ChangedDate, System.ChangedBy, System.CommentCount, System.Title, System.BoardColumn, System.BoardColumnDone, Microsoft.VSTS.Common.StateChangeDate, Microsoft.VSTS.Common.Priority, Microsoft.VSTS.Common.ValueArea, System.Description, System.Tags</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Revision --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="rev"> <maml:name>Revision</maml:name> <maml:description> <maml:para>Specifies a work item revision number to retrieve. When omitted, returns the latest revision of the work item.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: ShowWindow --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ShowWindow</maml:name> <maml:description> <maml:para>Opens the specified work item in the default web browser.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Team --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeam (if any). For more details, see the Get-TfsTeam cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter Set: Query by date --> <command:syntaxItem tfscmdlets:parameterSet="Query by date"> <maml:name>Get-TfsWorkItem</maml:name> <!-- Parameter: WorkItem --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="id"> <maml:name>WorkItem</maml:name> <maml:description> <maml:para>Specifies a work item. Valid values are the work item ID or an instance of Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AsOf --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AsOf</maml:name> <maml:description> <maml:para>Returns the field values as they were defined in the work item revision that was the latest revision by the date specified.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Fields --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Fields</maml:name> <maml:description> <maml:para>Specifies which fields should be retrieved. When omitted, defaults to a set of standard fields that include Id, Title, Description, some state-related fields and more.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.AreaPath, System.TeamProject, System.IterationPath, System.WorkItemType, System.State, System.Reason, System.CreatedDate, System.CreatedBy, System.ChangedDate, System.ChangedBy, System.CommentCount, System.Title, System.BoardColumn, System.BoardColumnDone, Microsoft.VSTS.Common.StateChangeDate, Microsoft.VSTS.Common.Priority, Microsoft.VSTS.Common.ValueArea, System.Description, System.Tags</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Team --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeam (if any). For more details, see the Get-TfsTeam cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter Set: Get deleted --> <command:syntaxItem tfscmdlets:parameterSet="Get deleted"> <maml:name>Get-TfsWorkItem</maml:name> <!-- Parameter: WorkItem --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="id"> <maml:name>WorkItem</maml:name> <maml:description> <maml:para>Specifies a work item. Valid values are the work item ID or an instance of Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Deleted --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Deleted</maml:name> <maml:description> <maml:para>Gets deleted work items.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Fields --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Fields</maml:name> <maml:description> <maml:para>Specifies which fields should be retrieved. When omitted, defaults to a set of standard fields that include Id, Title, Description, some state-related fields and more.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.AreaPath, System.TeamProject, System.IterationPath, System.WorkItemType, System.State, System.Reason, System.CreatedDate, System.CreatedBy, System.ChangedDate, System.ChangedBy, System.CommentCount, System.Title, System.BoardColumn, System.BoardColumnDone, Microsoft.VSTS.Common.StateChangeDate, Microsoft.VSTS.Common.Priority, Microsoft.VSTS.Common.ValueArea, System.Description, System.Tags</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Team --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeam (if any). For more details, see the Get-TfsTeam cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter Set: Simple query --> <command:syntaxItem tfscmdlets:parameterSet="Simple query"> <maml:name>Get-TfsWorkItem</maml:name> <!-- Parameter: AreaPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AreaPath</maml:name> <maml:description> <maml:para>Specifies the area path to look up for in a work item. Wildcards are supported.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AsOf --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsOf</maml:name> <maml:description> <maml:para>Returns the field values as they were defined in the work item revision that was the latest revision by the date specified.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: BoardColumn --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BoardColumn</maml:name> <maml:description> <maml:para>Specifies the board column to look up for in a work item. Wildcards are supported.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BoardColumnDone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BoardColumnDone</maml:name> <maml:description> <maml:para>Specifies whether the work item is in the sub-column Doing or Done in a board.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ChangedBy --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ChangedBy</maml:name> <maml:description> <maml:para>Specifies the name or email of the user that did the latest change to the work item.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ChangedDate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ChangedDate</maml:name> <maml:description> <maml:para>Specifies the date of the latest change to the work item.</maml:para> </maml:description> <command:parameterValue required="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CreatedBy --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CreatedBy</maml:name> <maml:description> <maml:para>Specifies the name or email of the user that created the work item.</maml:para> </maml:description> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CreatedDate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CreatedDate</maml:name> <maml:description> <maml:para>Specifies the date when the work item was created.</maml:para> </maml:description> <command:parameterValue required="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description to look up for in a work item. Wildcards are supported.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Ever --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Ever</maml:name> <maml:description> <maml:para>Switches the query to historical query mode, by changing operators to "WAS EVER" where possible.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Fields --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Fields</maml:name> <maml:description> <maml:para>Specifies which fields should be retrieved. When omitted, defaults to a set of standard fields that include Id, Title, Description, some state-related fields and more.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.AreaPath, System.TeamProject, System.IterationPath, System.WorkItemType, System.State, System.Reason, System.CreatedDate, System.CreatedBy, System.ChangedDate, System.ChangedBy, System.CommentCount, System.Title, System.BoardColumn, System.BoardColumnDone, Microsoft.VSTS.Common.StateChangeDate, Microsoft.VSTS.Common.Priority, Microsoft.VSTS.Common.ValueArea, System.Description, System.Tags</dev:defaultValue> </command:parameter> <!-- Parameter: IterationPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IterationPath</maml:name> <maml:description> <maml:para>Specifies the iteration path to look up for in a work item. Wildcards are supported.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Priority --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Priority</maml:name> <maml:description> <maml:para>Specifies the priority of the work item.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Reason --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Reason</maml:name> <maml:description> <maml:para>Specifies the reason (field 'System.Reason') to look up for in a work item. Wildcards are supported.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: State --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>State</maml:name> <maml:description> <maml:para>Specifies the state (field 'System.State') to look up for in a work item. Wildcards are supported.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StateChangeDate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StateChangeDate</maml:name> <maml:description> <maml:para>Specifies the date of the most recent change to the state of the work item.</maml:para> </maml:description> <command:parameterValue required="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specifies the tags to look up for in a work item. When multiple tags are supplied, they are combined with an OR operator - in other works, returns work items that contain ANY ofthe supplied tags.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Team --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeam (if any). For more details, see the Get-TfsTeam cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TimePrecision --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TimePrecision</maml:name> <maml:description> <maml:para>Fetches work items in "time-precision mode": search criteria in WIQL queries take into account time information as well, not only dates.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Title --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>Specifies the title to look up for in a work item. Wildcards are supported. When a wildcard is used, matches a portion of the title (uses the operator "contains" in the WIQL query). Otherwise, matches the whole field with the operator "=", unless -Ever is also specified. In that case, uses the operator "was ever".</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ValueArea --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValueArea</maml:name> <maml:description> <maml:para>Specifies the Value Area (field 'Microsoft.VSTS.Common.ValueArea') to look up for in a work item. Wildcards are supported.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: WorkItemType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Type"> <maml:name>WorkItemType</maml:name> <maml:description> <maml:para>Specifies the work item type to look up for in a work item. Wildcards are supported.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter Set: Query by WIQL --> <command:syntaxItem tfscmdlets:parameterSet="Query by WIQL"> <maml:name>Get-TfsWorkItem</maml:name> <!-- Parameter: Query --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="WIQL,QueryText,SavedQuery,QueryPath"> <maml:name>Query</maml:name> <maml:description> <maml:para>Specifies a query written in WIQL (Work Item Query Language)</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Fields --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Fields</maml:name> <maml:description> <maml:para>Specifies which fields should be retrieved. When omitted, defaults to a set of standard fields that include Id, Title, Description, some state-related fields and more.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.AreaPath, System.TeamProject, System.IterationPath, System.WorkItemType, System.State, System.Reason, System.CreatedDate, System.CreatedBy, System.ChangedDate, System.ChangedBy, System.CommentCount, System.Title, System.BoardColumn, System.BoardColumnDone, Microsoft.VSTS.Common.StateChangeDate, Microsoft.VSTS.Common.Priority, Microsoft.VSTS.Common.ValueArea, System.Description, System.Tags</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Team --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeam (if any). For more details, see the Get-TfsTeam cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TimePrecision --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TimePrecision</maml:name> <maml:description> <maml:para>Fetches work items in "time-precision mode": search criteria in WIQL queries take into account time information as well, not only dates.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter Set: Query by filter --> <command:syntaxItem tfscmdlets:parameterSet="Query by filter"> <maml:name>Get-TfsWorkItem</maml:name> <!-- Parameter: Where --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Where</maml:name> <maml:description> <maml:para>Specifies a filter clause (the portion of a WIQL query after the WHERE keyword).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Fields --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Fields</maml:name> <maml:description> <maml:para>Specifies which fields should be retrieved. When omitted, defaults to a set of standard fields that include Id, Title, Description, some state-related fields and more.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.AreaPath, System.TeamProject, System.IterationPath, System.WorkItemType, System.State, System.Reason, System.CreatedDate, System.CreatedBy, System.ChangedDate, System.ChangedBy, System.CommentCount, System.Title, System.BoardColumn, System.BoardColumnDone, Microsoft.VSTS.Common.StateChangeDate, Microsoft.VSTS.Common.Priority, Microsoft.VSTS.Common.ValueArea, System.Description, System.Tags</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Team --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeam (if any). For more details, see the Get-TfsTeam cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TimePrecision --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TimePrecision</maml:name> <maml:description> <maml:para>Fetches work items in "time-precision mode": search criteria in WIQL queries take into account time information as well, not only dates.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: WorkItem --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="id"> <maml:name>WorkItem</maml:name> <maml:description> <maml:para>Specifies a work item. Valid values are the work item ID or an instance of Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="id"> <maml:name>id</maml:name> <maml:description> <maml:para>Specifies a work item. Valid values are the work item ID or an instance of Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem.</maml:para> <maml:para>This is an alias of the WorkItem parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Title --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>Specifies the title to look up for in a work item. Wildcards are supported. When a wildcard is used, matches a portion of the title (uses the operator "contains" in the WIQL query). Otherwise, matches the whole field with the operator "=", unless -Ever is also specified. In that case, uses the operator "was ever".</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description to look up for in a work item. Wildcards are supported.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AreaPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AreaPath</maml:name> <maml:description> <maml:para>Specifies the area path to look up for in a work item. Wildcards are supported.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IterationPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IterationPath</maml:name> <maml:description> <maml:para>Specifies the iteration path to look up for in a work item. Wildcards are supported.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: WorkItemType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Type"> <maml:name>WorkItemType</maml:name> <maml:description> <maml:para>Specifies the work item type to look up for in a work item. Wildcards are supported.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Type"> <maml:name>Type</maml:name> <maml:description> <maml:para>Specifies the work item type to look up for in a work item. Wildcards are supported.</maml:para> <maml:para>This is an alias of the WorkItemType parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: State --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>State</maml:name> <maml:description> <maml:para>Specifies the state (field 'System.State') to look up for in a work item. Wildcards are supported.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Reason --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Reason</maml:name> <maml:description> <maml:para>Specifies the reason (field 'System.Reason') to look up for in a work item. Wildcards are supported.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ValueArea --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValueArea</maml:name> <maml:description> <maml:para>Specifies the Value Area (field 'Microsoft.VSTS.Common.ValueArea') to look up for in a work item. Wildcards are supported.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BoardColumn --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BoardColumn</maml:name> <maml:description> <maml:para>Specifies the board column to look up for in a work item. Wildcards are supported.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BoardColumnDone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BoardColumnDone</maml:name> <maml:description> <maml:para>Specifies whether the work item is in the sub-column Doing or Done in a board.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: CreatedBy --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CreatedBy</maml:name> <maml:description> <maml:para>Specifies the name or email of the user that created the work item.</maml:para> </maml:description> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CreatedDate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CreatedDate</maml:name> <maml:description> <maml:para>Specifies the date when the work item was created.</maml:para> </maml:description> <command:parameterValue required="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ChangedBy --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ChangedBy</maml:name> <maml:description> <maml:para>Specifies the name or email of the user that did the latest change to the work item.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ChangedDate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ChangedDate</maml:name> <maml:description> <maml:para>Specifies the date of the latest change to the work item.</maml:para> </maml:description> <command:parameterValue required="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StateChangeDate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StateChangeDate</maml:name> <maml:description> <maml:para>Specifies the date of the most recent change to the state of the work item.</maml:para> </maml:description> <command:parameterValue required="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Priority --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Priority</maml:name> <maml:description> <maml:para>Specifies the priority of the work item.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specifies the tags to look up for in a work item. When multiple tags are supplied, they are combined with an OR operator - in other works, returns work items that contain ANY ofthe supplied tags.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Ever --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Ever</maml:name> <maml:description> <maml:para>Switches the query to historical query mode, by changing operators to "WAS EVER" where possible.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Revision --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="rev"> <maml:name>Revision</maml:name> <maml:description> <maml:para>Specifies a work item revision number to retrieve. When omitted, returns the latest revision of the work item.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="rev"> <maml:name>rev</maml:name> <maml:description> <maml:para>Specifies a work item revision number to retrieve. When omitted, returns the latest revision of the work item.</maml:para> <maml:para>This is an alias of the Revision parameter.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: AsOf --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AsOf</maml:name> <maml:description> <maml:para>Returns the field values as they were defined in the work item revision that was the latest revision by the date specified.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: Query --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="WIQL,QueryText,SavedQuery,QueryPath"> <maml:name>Query</maml:name> <maml:description> <maml:para>Specifies a query written in WIQL (Work Item Query Language)</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="WIQL,QueryText,SavedQuery,QueryPath"> <maml:name>WIQL</maml:name> <maml:description> <maml:para>Specifies a query written in WIQL (Work Item Query Language)</maml:para> <maml:para>This is an alias of the Query parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="WIQL,QueryText,SavedQuery,QueryPath"> <maml:name>QueryText</maml:name> <maml:description> <maml:para>Specifies a query written in WIQL (Work Item Query Language)</maml:para> <maml:para>This is an alias of the Query parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="WIQL,QueryText,SavedQuery,QueryPath"> <maml:name>SavedQuery</maml:name> <maml:description> <maml:para>Specifies a query written in WIQL (Work Item Query Language)</maml:para> <maml:para>This is an alias of the Query parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="WIQL,QueryText,SavedQuery,QueryPath"> <maml:name>QueryPath</maml:name> <maml:description> <maml:para>Specifies a query written in WIQL (Work Item Query Language)</maml:para> <maml:para>This is an alias of the Query parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Fields --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Fields</maml:name> <maml:description> <maml:para>Specifies which fields should be retrieved. When omitted, defaults to a set of standard fields that include Id, Title, Description, some state-related fields and more.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.AreaPath, System.TeamProject, System.IterationPath, System.WorkItemType, System.State, System.Reason, System.CreatedDate, System.CreatedBy, System.ChangedDate, System.ChangedBy, System.CommentCount, System.Title, System.BoardColumn, System.BoardColumnDone, Microsoft.VSTS.Common.StateChangeDate, Microsoft.VSTS.Common.Priority, Microsoft.VSTS.Common.ValueArea, System.Description, System.Tags</dev:defaultValue> </command:parameter> <!-- Parameter: Where --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Where</maml:name> <maml:description> <maml:para>Specifies a filter clause (the portion of a WIQL query after the WHERE keyword).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TimePrecision --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TimePrecision</maml:name> <maml:description> <maml:para>Fetches work items in "time-precision mode": search criteria in WIQL queries take into account time information as well, not only dates.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ShowWindow --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ShowWindow</maml:name> <maml:description> <maml:para>Opens the specified work item in the default web browser.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Deleted --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Deleted</maml:name> <maml:description> <maml:para>Gets deleted work items.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Team --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeam (if any). For more details, see the Get-TfsTeam cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>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.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: WorkItem --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/WorkItem/Get-TfsWorkItem</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Move-TfsWorkItem --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="WorkItem"> <command:details> <command:name>Move-TfsWorkItem</command:name> <command:verb>Move</command:verb> <command:noun>TfsWorkItem</command:noun> <maml:description> <maml:para>Moves a work item to a different team project in the same collection.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Move-TfsWorkItem</maml:name> <!-- Parameter: WorkItem --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="id"> <maml:name>WorkItem</maml:name> <maml:description> <maml:para>Specifies a work item. Valid values are the work item ID or an instance of Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1" aliases="Destination"> <maml:name>Project</maml:name> <maml:description> <maml:para>Specifies the team project where the work item will be moved to.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Area --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Area</maml:name> <maml:description> <maml:para>Specifies the area path in the destination project where the work item will be moved to. When omitted, the work item is moved to the root area path in the destination project.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Comment</maml:name> <maml:description> <maml:para>Specifies a comment to be added to the history</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Iteration --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Iteration</maml:name> <maml:description> <maml:para>Specifies the iteration path in the destination project where the work item will be moved to. When omitted, the work item is moved to the root iteration path in the destination project.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: State --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>State</maml:name> <maml:description> <maml:para>Specifies a new state for the work item in the destination project. When omitted, it retains the current state.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: WorkItem --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="id"> <maml:name>WorkItem</maml:name> <maml:description> <maml:para>Specifies a work item. Valid values are the work item ID or an instance of Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="id"> <maml:name>id</maml:name> <maml:description> <maml:para>Specifies a work item. Valid values are the work item ID or an instance of Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem.</maml:para> <maml:para>This is an alias of the WorkItem parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1" aliases="Destination"> <maml:name>Project</maml:name> <maml:description> <maml:para>Specifies the team project where the work item will be moved to.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="1" aliases="Destination"> <maml:name>Destination</maml:name> <maml:description> <maml:para>Specifies the team project where the work item will be moved to.</maml:para> <maml:para>This is an alias of the Project parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Area --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Area</maml:name> <maml:description> <maml:para>Specifies the area path in the destination project where the work item will be moved to. When omitted, the work item is moved to the root area path in the destination project.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Iteration --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Iteration</maml:name> <maml:description> <maml:para>Specifies the iteration path in the destination project where the work item will be moved to. When omitted, the work item is moved to the root iteration path in the destination project.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: State --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>State</maml:name> <maml:description> <maml:para>Specifies a new state for the work item in the destination project. When omitted, it retains the current state.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Comment</maml:name> <maml:description> <maml:para>Specifies a comment to be added to the history</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies a work item. Valid values are the work item ID or an instance of Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: WorkItem --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/WorkItem/Move-TfsWorkItem</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-TfsWorkItem --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="WorkItem"> <command:details> <command:name>New-TfsWorkItem</command:name> <command:verb>New</command:verb> <command:noun>TfsWorkItem</command:noun> <maml:description> <maml:para>Creates a new work item.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>New-TfsWorkItem</maml:name> <!-- Parameter: Type --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Type</maml:name> <maml:description> <maml:para>Specifies the type of the new work item.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Area --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Area</maml:name> <maml:description> <maml:para>Specifies the area path of the work item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AssignedTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AssignedTo</maml:name> <maml:description> <maml:para>Specifies the user this work item is assigned to.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BoardColumn --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BoardColumn</maml:name> <maml:description> <maml:para>Specifies the board column of the work item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BoardColumnDone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BoardColumnDone</maml:name> <maml:description> <maml:para>Specifies whether the work item is in the sub-column Doing or Done in a board.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: BoardLane --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BoardLane</maml:name> <maml:description> <maml:para>Specifies the board lane of the work item</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BypassRules --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BypassRules</maml:name> <maml:description> <maml:para>Bypasses any rule validation when saving the work item. Use it with caution, as this may leave the work item in an invalid state.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description of the work item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Fields --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Fields</maml:name> <maml:description> <maml:para>Specifies the names and the corresponding values for the fields to be set in the work item and whose values were not supplied in the other arguments to this cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Iteration --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Iteration</maml:name> <maml:description> <maml:para>Specifies the iteration path of the work item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Priority --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Priority</maml:name> <maml:description> <maml:para>Specifies the priority of the work item.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Reason --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Reason</maml:name> <maml:description> <maml:para>Specifies the reason (field 'System.Reason') of the work item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: State --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>State</maml:name> <maml:description> <maml:para>Specifies the state of the work item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specifies the tags of the work item.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Team --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeam (if any). For more details, see the Get-TfsTeam cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Title --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>Specifies the title of the work item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ValueArea --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValueArea</maml:name> <maml:description> <maml:para>Specifies the Value Area of the work item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Type --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Type</maml:name> <maml:description> <maml:para>Specifies the type of the new work item.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Title --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>Specifies the title of the work item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description of the work item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Area --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Area</maml:name> <maml:description> <maml:para>Specifies the area path of the work item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Iteration --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Iteration</maml:name> <maml:description> <maml:para>Specifies the iteration path of the work item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AssignedTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AssignedTo</maml:name> <maml:description> <maml:para>Specifies the user this work item is assigned to.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: State --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>State</maml:name> <maml:description> <maml:para>Specifies the state of the work item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Reason --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Reason</maml:name> <maml:description> <maml:para>Specifies the reason (field 'System.Reason') of the work item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ValueArea --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValueArea</maml:name> <maml:description> <maml:para>Specifies the Value Area of the work item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BoardColumn --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BoardColumn</maml:name> <maml:description> <maml:para>Specifies the board column of the work item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BoardColumnDone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BoardColumnDone</maml:name> <maml:description> <maml:para>Specifies whether the work item is in the sub-column Doing or Done in a board.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: BoardLane --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BoardLane</maml:name> <maml:description> <maml:para>Specifies the board lane of the work item</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Priority --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Priority</maml:name> <maml:description> <maml:para>Specifies the priority of the work item.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specifies the tags of the work item.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Fields --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Fields</maml:name> <maml:description> <maml:para>Specifies the names and the corresponding values for the fields to be set in the work item and whose values were not supplied in the other arguments to this cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BypassRules --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BypassRules</maml:name> <maml:description> <maml:para>Bypasses any rule validation when saving the work item. Use it with caution, as this may leave the work item in an invalid state.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Team --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeam (if any). For more details, see the Get-TfsTeam cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the type of the new work item.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: WorkItem --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/WorkItem/New-TfsWorkItem</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-TfsWorkItem --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="WorkItem"> <command:details> <command:name>Remove-TfsWorkItem</command:name> <command:verb>Remove</command:verb> <command:noun>TfsWorkItem</command:noun> <maml:description> <maml:para>Deletes a work item from a team project collection.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Remove-TfsWorkItem</maml:name> <!-- Parameter: WorkItem --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="id"> <maml:name>WorkItem</maml:name> <maml:description> <maml:para>Specifies the work item to remove.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Destroy --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Destroy</maml:name> <maml:description> <maml:para>Permanently deletes the work item, without sending it to the recycle bin.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Deletes the work item without asking for confirmation</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: WorkItem --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="id"> <maml:name>WorkItem</maml:name> <maml:description> <maml:para>Specifies the work item to remove.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="id"> <maml:name>id</maml:name> <maml:description> <maml:para>Specifies the work item to remove.</maml:para> <maml:para>This is an alias of the WorkItem parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Destroy --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Destroy</maml:name> <maml:description> <maml:para>Permanently deletes the work item, without sending it to the recycle bin.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Deletes the work item without asking for confirmation</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the work item to remove.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/WorkItem/Remove-TfsWorkItem</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Search-TfsWorkItem --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="WorkItem"> <command:details> <command:name>Search-TfsWorkItem</command:name> <command:verb>Search</command:verb> <command:noun>TfsWorkItem</command:noun> <maml:description> <maml:para>Gets the contents of one or more work items.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Search-TfsWorkItem</maml:name> <!-- Parameter: Query --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>Specifies the text to search for. Supports the Quick Filter syntax described in https://docs.microsoft.com/en-us/azure/devops/project/search/advanced-work-item-search-syntax</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Results --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Results</maml:name> <maml:description> <maml:para>Specifies the maximum quantity of results. Supports between 1 and 1000 results. When omitted, defaults to 100. Currently this cmdlet does not support result pagination.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>100</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Query --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>Specifies the text to search for. Supports the Quick Filter syntax described in https://docs.microsoft.com/en-us/azure/devops/project/search/advanced-work-item-search-syntax</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Results --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Results</maml:name> <maml:description> <maml:para>Specifies the maximum quantity of results. Supports between 1 and 1000 results. When omitted, defaults to 100. Currently this cmdlet does not support result pagination.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>100</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the text to search for. Supports the Quick Filter syntax described in https://docs.microsoft.com/en-us/azure/devops/project/search/advanced-work-item-search-syntax</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: WorkItem --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/WorkItem/Search-TfsWorkItem</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://docs.microsoft.com/en-us/azure/devops/project/search/advanced-work-item-search-syntax</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-TfsWorkItem --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="WorkItem"> <command:details> <command:name>Set-TfsWorkItem</command:name> <command:verb>Set</command:verb> <command:noun>TfsWorkItem</command:noun> <maml:description> <maml:para>Sets the contents of one or more work items.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Set-TfsWorkItem</maml:name> <!-- Parameter: WorkItem --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="id"> <maml:name>WorkItem</maml:name> <maml:description> <maml:para>Specifies a work item. Valid values are the work item ID or an instance of Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Area --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Area</maml:name> <maml:description> <maml:para>Specifies the area path of the work item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AssignedTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AssignedTo</maml:name> <maml:description> <maml:para>Specifies the user this work item is assigned to.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BoardColumn --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BoardColumn</maml:name> <maml:description> <maml:para>Specifies the board column of the work item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BoardColumnDone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BoardColumnDone</maml:name> <maml:description> <maml:para>Specifies whether the work item is in the sub-column Doing or Done in a board.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: BoardLane --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BoardLane</maml:name> <maml:description> <maml:para>Specifies the board lane of the work item</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BypassRules --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BypassRules</maml:name> <maml:description> <maml:para>Bypasses any rule validation when saving the work item. Use it with caution, as this may leave the work item in an invalid state.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description of the work item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Fields --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Fields</maml:name> <maml:description> <maml:para>Specifies the names and the corresponding values for the fields to be set in the work item and whose values were not supplied in the other arguments to this cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Iteration --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Iteration</maml:name> <maml:description> <maml:para>Specifies the iteration path of the work item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Priority --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Priority</maml:name> <maml:description> <maml:para>Specifies the priority of the work item.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Reason --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Reason</maml:name> <maml:description> <maml:para>Specifies the reason (field 'System.Reason') of the work item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: State --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>State</maml:name> <maml:description> <maml:para>Specifies the state of the work item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specifies the tags of the work item.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Team --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeam (if any). For more details, see the Get-TfsTeam cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Title --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>Specifies the title of the work item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ValueArea --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValueArea</maml:name> <maml:description> <maml:para>Specifies the Value Area of the work item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: WorkItem --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="id"> <maml:name>WorkItem</maml:name> <maml:description> <maml:para>Specifies a work item. Valid values are the work item ID or an instance of Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="id"> <maml:name>id</maml:name> <maml:description> <maml:para>Specifies a work item. Valid values are the work item ID or an instance of Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem.</maml:para> <maml:para>This is an alias of the WorkItem parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Title --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>Specifies the title of the work item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description of the work item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Area --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Area</maml:name> <maml:description> <maml:para>Specifies the area path of the work item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Iteration --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Iteration</maml:name> <maml:description> <maml:para>Specifies the iteration path of the work item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AssignedTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AssignedTo</maml:name> <maml:description> <maml:para>Specifies the user this work item is assigned to.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: State --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>State</maml:name> <maml:description> <maml:para>Specifies the state of the work item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Reason --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Reason</maml:name> <maml:description> <maml:para>Specifies the reason (field 'System.Reason') of the work item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ValueArea --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValueArea</maml:name> <maml:description> <maml:para>Specifies the Value Area of the work item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BoardColumn --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BoardColumn</maml:name> <maml:description> <maml:para>Specifies the board column of the work item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BoardColumnDone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BoardColumnDone</maml:name> <maml:description> <maml:para>Specifies whether the work item is in the sub-column Doing or Done in a board.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: BoardLane --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BoardLane</maml:name> <maml:description> <maml:para>Specifies the board lane of the work item</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Priority --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Priority</maml:name> <maml:description> <maml:para>Specifies the priority of the work item.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specifies the tags of the work item.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Fields --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Fields</maml:name> <maml:description> <maml:para>Specifies the names and the corresponding values for the fields to be set in the work item and whose values were not supplied in the other arguments to this cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BypassRules --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BypassRules</maml:name> <maml:description> <maml:para>Bypasses any rule validation when saving the work item. Use it with caution, as this may leave the work item in an invalid state.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Team --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeam (if any). For more details, see the Get-TfsTeam cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies a work item. Valid values are the work item ID or an instance of Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: WorkItem --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/WorkItem/Set-TfsWorkItem</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-TfsWorkItemHistory --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="WorkItem.History"> <command:details> <command:name>Get-TfsWorkItemHistory</command:name> <command:verb>Get</command:verb> <command:noun>TfsWorkItemHistory</command:noun> <maml:description> <maml:para>Gets the history of changes of a work item.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Get-TfsWorkItemHistory</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <!-- OutputType: PSCustomObject --> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/WorkItem/History/Get-TfsWorkItemHistory</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Add-TfsWorkItemLink --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="WorkItem.Linking"> <command:details> <command:name>Add-TfsWorkItemLink</command:name> <command:verb>Add</command:verb> <command:noun>TfsWorkItemLink</command:noun> <maml:description> <maml:para>Adds a link between two work items.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Add-TfsWorkItemLink</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/WorkItem/Linking/Add-TfsWorkItemLink</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-TfsWorkItemLink --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="WorkItem.Linking"> <command:details> <command:name>Get-TfsWorkItemLink</command:name> <command:verb>Get</command:verb> <command:noun>TfsWorkItemLink</command:noun> <maml:description> <maml:para>Gets the links in a work item.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Get-TfsWorkItemLink</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/WorkItem/Linking/Get-TfsWorkItemLink</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-TfsWorkItemLinkEndType --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="WorkItem.Linking"> <command:details> <command:name>Get-TfsWorkItemLinkEndType</command:name> <command:verb>Get</command:verb> <command:noun>TfsWorkItemLinkEndType</command:noun> <maml:description> <maml:para>Gets the work item link end types of a team project collection.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Get-TfsWorkItemLinkEndType</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/WorkItem/Linking/Get-TfsWorkItemLinkEndType</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Export-TfsWorkItemQuery --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="WorkItem.Query"> <command:details> <command:name>Export-TfsWorkItemQuery</command:name> <command:verb>Export</command:verb> <command:noun>TfsWorkItemQuery</command:noun> <maml:description> <maml:para>Exports a saved work item query to XML.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Work item queries can be exported to XML files (.WIQ extension) in order to be shared and reused. Visual Studio Team Explorer has the ability to open and save WIQ files. Use this cmdlet to generate WIQ files compatible with the format supported by Team Explorer.</maml:para> </maml:description> <command:syntax> <!-- Parameter Set: Export to file --> <command:syntaxItem tfscmdlets:parameterSet="Export to file"> <maml:name>Export-TfsWorkItemQuery</maml:name> <!-- Parameter: Query --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Path"> <maml:name>Query</maml:name> <maml:description> <maml:para>Specifies one or more saved queries to export. Wildcards supported.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>Specifies the path to the folder where exported queries are saved.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Encoding --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Encoding</maml:name> <maml:description> <maml:para>Specifies the encoding for the exported XML files. When omitted, defaults to UTF-8.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>UTF-8</dev:defaultValue> </command:parameter> <!-- Parameter: FlattenFolders --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FlattenFolders</maml:name> <maml:description> <maml:para>Flattens the query folder structure. When omitted, the original query folder structure is recreated in the destination folder.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Allows the cmdlet to overwrite an existing file in the destination folder.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Scope --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Specifies the scope of the returned item. Personal refers to the "My Queries" folder", whereas Shared refers to the "Shared Queries" folder. When omitted defaults to "Both", effectively searching for items in both scopes.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Both</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter Set: Export to output stream --> <command:syntaxItem tfscmdlets:parameterSet="Export to output stream"> <maml:name>Export-TfsWorkItemQuery</maml:name> <!-- Parameter: Query --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Path"> <maml:name>Query</maml:name> <maml:description> <maml:para>Specifies one or more saved queries to export. Wildcards supported.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AsXml --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AsXml</maml:name> <maml:description> <maml:para>Exports the saved query to the standard output stream as a string-encoded XML document.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Scope --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Specifies the scope of the returned item. Personal refers to the "My Queries" folder", whereas Shared refers to the "Shared Queries" folder. When omitted defaults to "Both", effectively searching for items in both scopes.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Both</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Query --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Path"> <maml:name>Query</maml:name> <maml:description> <maml:para>Specifies one or more saved queries to export. Wildcards supported.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Path"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies one or more saved queries to export. Wildcards supported.</maml:para> <maml:para>This is an alias of the Query parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Scope --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Specifies the scope of the returned item. Personal refers to the "My Queries" folder", whereas Shared refers to the "Shared Queries" folder. When omitted defaults to "Both", effectively searching for items in both scopes.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Both</dev:defaultValue> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>Specifies the path to the folder where exported queries are saved.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Encoding --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Encoding</maml:name> <maml:description> <maml:para>Specifies the encoding for the exported XML files. When omitted, defaults to UTF-8.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>UTF-8</dev:defaultValue> </command:parameter> <!-- Parameter: FlattenFolders --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FlattenFolders</maml:name> <maml:description> <maml:para>Flattens the query folder structure. When omitted, the original query folder structure is recreated in the destination folder.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Allows the cmdlet to overwrite an existing file in the destination folder.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: AsXml --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AsXml</maml:name> <maml:description> <maml:para>Exports the saved query to the standard output stream as a string-encoded XML document.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies one or more saved queries to export. Wildcards supported.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>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.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>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).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: String --> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/WorkItem/Query/Export-TfsWorkItemQuery</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-TfsWorkItemQuery --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="WorkItem.Query"> <command:details> <command:name>Get-TfsWorkItemQuery</command:name> <command:verb>Get</command:verb> <command:noun>TfsWorkItemQuery</command:noun> <maml:description> <maml:para>Gets the definition of one or more work item saved queries.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Get-TfsWorkItemQuery</maml:name> <!-- Parameter: Query --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Path"> <maml:name>Query</maml:name> <maml:description> <maml:para>Specifies one or more saved queries to return. Wildcards supported. When omitted, returns all saved queries in the given scope of the given team project.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>**</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Deleted --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Deleted</maml:name> <maml:description> <maml:para>Returns deleted items.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Scope --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Specifies the scope of the returned item. Personal refers to the "My Queries" folder", whereas Shared refers to the "Shared Queries" folder. When omitted defaults to "Both", effectively searching for items in both scopes.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Both</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Query --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Path"> <maml:name>Query</maml:name> <maml:description> <maml:para>Specifies one or more saved queries to return. Wildcards supported. When omitted, returns all saved queries in the given scope of the given team project.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>**</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Path"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies one or more saved queries to return. Wildcards supported. When omitted, returns all saved queries in the given scope of the given team project.</maml:para> <maml:para>This is an alias of the Query parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>**</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Scope --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Specifies the scope of the returned item. Personal refers to the "My Queries" folder", whereas Shared refers to the "Shared Queries" folder. When omitted defaults to "Both", effectively searching for items in both scopes.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Both</dev:defaultValue> </command:parameter> <!-- Parameter: Deleted --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Deleted</maml:name> <maml:description> <maml:para>Returns deleted items.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>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.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: QueryHierarchyItem --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItem</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/WorkItem/Query/Get-TfsWorkItemQuery</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-TfsWorkItemQuery --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="WorkItem.Query"> <command:details> <command:name>New-TfsWorkItemQuery</command:name> <command:verb>New</command:verb> <command:noun>TfsWorkItemQuery</command:noun> <maml:description> <maml:para>Create a new work items query in the given Team Project.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>New-TfsWorkItemQuery</maml:name> <!-- Parameter: Query --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Path"> <maml:name>Query</maml:name> <maml:description> <maml:para>Specifies one or more saved queries to return. Wildcards supported. When omitted, returns all saved queries in the given scope of the given team project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Allow the cmdlet to overwrite an existing item.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Scope --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Specifies the scope of the returned item. Personal refers to the "My Queries" folder", whereas Shared refers to the "Shared Queries" folder. When omitted defaults to "Both", effectively searching for items in both scopes.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Personal</dev:defaultValue> </command:parameter> <!-- Parameter: Wiql --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Definition"> <maml:name>Wiql</maml:name> <maml:description> <maml:para>Specifies the query definition text in WIQL (Work Item Query Language).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Query --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Path"> <maml:name>Query</maml:name> <maml:description> <maml:para>Specifies one or more saved queries to return. Wildcards supported. When omitted, returns all saved queries in the given scope of the given team project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Path"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies one or more saved queries to return. Wildcards supported. When omitted, returns all saved queries in the given scope of the given team project.</maml:para> <maml:para>This is an alias of the Query parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Wiql --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Definition"> <maml:name>Wiql</maml:name> <maml:description> <maml:para>Specifies the query definition text in WIQL (Work Item Query Language).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Definition"> <maml:name>Definition</maml:name> <maml:description> <maml:para>Specifies the query definition text in WIQL (Work Item Query Language).</maml:para> <maml:para>This is an alias of the Wiql parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Scope --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Specifies the scope of the returned item. Personal refers to the "My Queries" folder", whereas Shared refers to the "Shared Queries" folder. When omitted defaults to "Both", effectively searching for items in both scopes.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Personal</dev:defaultValue> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Allow the cmdlet to overwrite an existing item.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: QueryHierarchyItem --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItem</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/WorkItem/Query/New-TfsWorkItemQuery</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-TfsWorkItemQueryFolder --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="WorkItem.Query"> <command:details> <command:name>Get-TfsWorkItemQueryFolder</command:name> <command:verb>Get</command:verb> <command:noun>TfsWorkItemQueryFolder</command:noun> <maml:description> <maml:para>Gets the definition of one or more work item saved queries.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Get-TfsWorkItemQueryFolder</maml:name> <!-- Parameter: Folder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Path"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Specifies one or more saved queries to return. Wildcards supported. When omitted, returns all saved queries in the given scope of the given team project.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>**</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Deleted --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Deleted</maml:name> <maml:description> <maml:para>Returns deleted items.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Scope --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Specifies the scope of the returned item. Personal refers to the "My Queries" folder", whereas Shared refers to the "Shared Queries" folder. When omitted defaults to "Both", effectively searching for items in both scopes.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Both</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Folder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Path"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Specifies one or more saved queries to return. Wildcards supported. When omitted, returns all saved queries in the given scope of the given team project.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>**</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Path"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies one or more saved queries to return. Wildcards supported. When omitted, returns all saved queries in the given scope of the given team project.</maml:para> <maml:para>This is an alias of the Folder parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>**</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Scope --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Specifies the scope of the returned item. Personal refers to the "My Queries" folder", whereas Shared refers to the "Shared Queries" folder. When omitted defaults to "Both", effectively searching for items in both scopes.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Both</dev:defaultValue> </command:parameter> <!-- Parameter: Deleted --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Deleted</maml:name> <maml:description> <maml:para>Returns deleted items.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>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.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: QueryHierarchyItem --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItem</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/WorkItem/Query/Get-TfsWorkItemQueryFolder</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-TfsWorkItemQueryFolder --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="WorkItem.Query"> <command:details> <command:name>New-TfsWorkItemQueryFolder</command:name> <command:verb>New</command:verb> <command:noun>TfsWorkItemQueryFolder</command:noun> <maml:description> <maml:para>Create a new work items query in the given Team Project.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>New-TfsWorkItemQueryFolder</maml:name> <!-- Parameter: Folder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Path"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Specifies one or more saved queries to return. Wildcards supported. When omitted, returns all saved queries in the given scope of the given team project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Allow the cmdlet to overwrite an existing item.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Scope --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Specifies the scope of the returned item. Personal refers to the "My Queries" folder", whereas Shared refers to the "Shared Queries" folder. When omitted defaults to "Both", effectively searching for items in both scopes.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Personal</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Folder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Path"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Specifies one or more saved queries to return. Wildcards supported. When omitted, returns all saved queries in the given scope of the given team project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Path"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies one or more saved queries to return. Wildcards supported. When omitted, returns all saved queries in the given scope of the given team project.</maml:para> <maml:para>This is an alias of the Folder parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Scope --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Specifies the scope of the returned item. Personal refers to the "My Queries" folder", whereas Shared refers to the "Shared Queries" folder. When omitted defaults to "Both", effectively searching for items in both scopes.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Personal</dev:defaultValue> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Allow the cmdlet to overwrite an existing item.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: QueryHierarchyItem --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItem</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/WorkItem/Query/New-TfsWorkItemQueryFolder</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-TfsWorkItemTag --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="WorkItem.Tagging"> <command:details> <command:name>Get-TfsWorkItemTag</command:name> <command:verb>Get</command:verb> <command:noun>TfsWorkItemTag</command:noun> <maml:description> <maml:para>Gets one or more work item tags.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Get-TfsWorkItemTag</maml:name> <!-- Parameter: Tag --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Tag</maml:name> <maml:description> <maml:para>Specifies one or more tags to returns. Wildcards are supported. When omitted, returns all existing tags in the given project.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IncludeInactive --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeInactive</maml:name> <maml:description> <maml:para>Includes tags not associated to any work items.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Tag --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Tag</maml:name> <maml:description> <maml:para>Specifies one or more tags to returns. Wildcards are supported. When omitted, returns all existing tags in the given project.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies one or more tags to returns. Wildcards are supported. When omitted, returns all existing tags in the given project.</maml:para> <maml:para>This is an alias of the Tag parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: IncludeInactive --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeInactive</maml:name> <maml:description> <maml:para>Includes tags not associated to any work items.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>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.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: WebApiTagDefinition --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.Core.WebApi.WebApiTagDefinition</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/WorkItem/Tagging/Get-TfsWorkItemTag</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-TfsWorkItemTag --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="WorkItem.Tagging"> <command:details> <command:name>New-TfsWorkItemTag</command:name> <command:verb>New</command:verb> <command:noun>TfsWorkItemTag</command:noun> <maml:description> <maml:para>Creates a new work item tag.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>New-TfsWorkItemTag</maml:name> <!-- Parameter: Tag --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Name"> <maml:name>Tag</maml:name> <maml:description> <maml:para>Specifies the name of the new tag.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Tag --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Name"> <maml:name>Tag</maml:name> <maml:description> <maml:para>Specifies the name of the new tag.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the new tag.</maml:para> <maml:para>This is an alias of the Tag parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the name of the new tag.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: WebApiTagDefinition --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.Core.WebApi.WebApiTagDefinition</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/WorkItem/Tagging/New-TfsWorkItemTag</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-TfsWorkItemTag --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="WorkItem.Tagging"> <command:details> <command:name>Remove-TfsWorkItemTag</command:name> <command:verb>Remove</command:verb> <command:noun>TfsWorkItemTag</command:noun> <maml:description> <maml:para>Deletes one or more work item tags.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Remove-TfsWorkItemTag</maml:name> <!-- Parameter: Tag --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Name"> <maml:name>Tag</maml:name> <maml:description> <maml:para>Specifies one or more tags to delete. Wildcards are supported.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Allows the cmdlet to delete active tags (currently associated with work items).</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Tag --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Name"> <maml:name>Tag</maml:name> <maml:description> <maml:para>Specifies one or more tags to delete. Wildcards are supported.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies one or more tags to delete. Wildcards are supported.</maml:para> <maml:para>This is an alias of the Tag parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Allows the cmdlet to delete active tags (currently associated with work items).</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies one or more tags to delete. Wildcards are supported.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/WorkItem/Tagging/Remove-TfsWorkItemTag</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Rename-TfsWorkItemTag --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="WorkItem.Tagging"> <command:details> <command:name>Rename-TfsWorkItemTag</command:name> <command:verb>Rename</command:verb> <command:noun>TfsWorkItemTag</command:noun> <maml:description> <maml:para>Renames a work item tag.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Rename-TfsWorkItemTag</maml:name> <!-- Parameter: Tag --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Name"> <maml:name>Tag</maml:name> <maml:description> <maml:para>Specifies the name of the work item tag to rename.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NewName</maml:name> <maml:description> <maml:para>Specifies the new name of the item. Enter only a name - i.e., for items that support paths, do not enter a path and name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Tag --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Name"> <maml:name>Tag</maml:name> <maml:description> <maml:para>Specifies the name of the work item tag to rename.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the work item tag to rename.</maml:para> <maml:para>This is an alias of the Tag parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NewName</maml:name> <maml:description> <maml:para>Specifies the new name of the item. Enter only a name - i.e., for items that support paths, do not enter a path and name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Passthru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Returns the results of the command. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the name of the work item tag to rename.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: WebApiTagDefinition --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.Core.WebApi.WebApiTagDefinition</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/WorkItem/Tagging/Rename-TfsWorkItemTag</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Export-TfsWorkItemType --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="WorkItem.WorkItemType"> <command:details> <command:name>Export-TfsWorkItemType</command:name> <command:verb>Export</command:verb> <command:noun>TfsWorkItemType</command:noun> <maml:description> <maml:para>Exports an XML work item type definition from a team project.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: Export to output stream --> <command:syntaxItem tfscmdlets:parameterSet="Export to output stream"> <maml:name>Export-TfsWorkItemType</maml:name> <!-- Parameter: Type --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Type</maml:name> <maml:description> <maml:para>Specifies one or more work item types to export. Wildcards are supported. When omitted, all work item types in the given project are exported</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: AsXml --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AsXml</maml:name> <maml:description> <maml:para>Exports the saved query to the standard output stream as a string-encoded XML document.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IncludeGlobalLists --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeGlobalLists</maml:name> <maml:description> <maml:para>Exports the definitions of referenced global lists. When omitted, global list definitions are not included in the exported XML document.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter Set: Export to file --> <command:syntaxItem tfscmdlets:parameterSet="Export to file"> <maml:name>Export-TfsWorkItemType</maml:name> <!-- Parameter: Destination --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>Specifies the path to the folder where exported types are saved.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Allows the cmdlet to overwrite an existing file in the destination folder.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IncludeGlobalLists --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeGlobalLists</maml:name> <maml:description> <maml:para>Exports the definitions of referenced global lists. When omitted, global list definitions are not included in the exported XML document.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Type --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Type</maml:name> <maml:description> <maml:para>Specifies one or more work item types to export. Wildcards are supported. When omitted, all work item types in the given project are exported</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies one or more work item types to export. Wildcards are supported. When omitted, all work item types in the given project are exported</maml:para> <maml:para>This is an alias of the Type parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: IncludeGlobalLists --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeGlobalLists</maml:name> <maml:description> <maml:para>Exports the definitions of referenced global lists. When omitted, global list definitions are not included in the exported XML document.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>Specifies the path to the folder where exported types are saved.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Allows the cmdlet to overwrite an existing file in the destination folder.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: AsXml --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AsXml</maml:name> <maml:description> <maml:para>Exports the saved query to the standard output stream as a string-encoded XML document.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>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.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: String --> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/WorkItem/WorkItemType/Export-TfsWorkItemType</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-TfsWorkItemType --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="WorkItem.WorkItemType"> <command:details> <command:name>Get-TfsWorkItemType</command:name> <command:verb>Get</command:verb> <command:noun>TfsWorkItemType</command:noun> <maml:description> <maml:para>Gets one or more Work Item Type definitions from a team project.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: Get by type --> <command:syntaxItem tfscmdlets:parameterSet="Get by type"> <maml:name>Get-TfsWorkItemType</maml:name> <!-- Parameter: Type --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Type</maml:name> <maml:description> <maml:para>Specifies one or more work item type names to return. Wildcards are supported. When omitted, returns all work item types in the given team project.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter Set: Get by work item --> <command:syntaxItem tfscmdlets:parameterSet="Get by work item"> <maml:name>Get-TfsWorkItemType</maml:name> <!-- Parameter: WorkItem --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WorkItem</maml:name> <maml:description> <maml:para>Speficies a work item whose corresponding type should be returned.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Type --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Type</maml:name> <maml:description> <maml:para>Specifies one or more work item type names to return. Wildcards are supported. When omitted, returns all work item types in the given team project.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies one or more work item type names to return. Wildcards are supported. When omitted, returns all work item types in the given team project.</maml:para> <maml:para>This is an alias of the Type parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: WorkItem --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WorkItem</maml:name> <maml:description> <maml:para>Speficies a work item whose corresponding type should be returned.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Collection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Collection</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>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.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: WorkItemType --> <command:returnValue> <dev:type> <maml:name>Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemType</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/WorkItem/WorkItemType/Get-TfsWorkItemType</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Import-TfsWorkItemType --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="WorkItem.WorkItemType"> <command:details> <command:name>Import-TfsWorkItemType</command:name> <command:verb>Import</command:verb> <command:noun>TfsWorkItemType</command:noun> <maml:description> <maml:para>Imports a work item type definition into a team project.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Import-TfsWorkItemType</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/WorkItem/WorkItemType/Import-TfsWorkItemType</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Start-TfsXamlBuild --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:tfscmdlets="https://igoravl.github.com/tfscmdlets/maml/" tfscmdlets:module="Pipeline.XamlBuild"> <command:details> <command:name>Start-TfsXamlBuild</command:name> <command:verb>Start</command:verb> <command:noun>TfsXamlBuild</command:noun> <maml:description> <maml:para>Queues a XAML Build.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter Set: __AllParameterSets --> <command:syntaxItem tfscmdlets:parameterSet="__AllParameterSets"> <maml:name>Start-TfsXamlBuild</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://tfscmdlets.dev/Cmdlets/Pipeline/XamlBuild/Start-TfsXamlBuild</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> </helpItems> |