TFSPowershell

0.1.0

MAML/TFSPowershell.Workitems.Help.xml

                                <?xml version="1.0" encoding="utf-8"?>

<helpItems xmlns="http://msh" schema="maml">

<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:MSHelp="http://msdn.microsoft.com/mshelp">

<command:details><command:name>Destroy-WorkItemById</command:name>

<command:verb>Destroy</command:verb>

<command:noun>WorkItemById</command:noun>

<maml:description><maml:para>Deletes a workitem and all its history.

</maml:para>

</maml:description>

</command:details>

<maml:description><maml:para>Permanently deletes a workitem and all its history. It will not be moved to recycle bin.

</maml:para>

</maml:description>

<command:syntax><command:syntaxItem><maml:name>Destroy-WorkItemById</maml:name>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>CollectionUrl</maml:name>

<maml:Description><maml:para>The TeamProjectCollection URL. Ex.: https://tfs2015.local/tfs/defaultcollection.  Note: if the 'Tfs' parameter was informed, this parameter will be ignored.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>None</dev:defaultValue>

</command:parameter>

<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>WorkitemId</maml:name>

<maml:Description><maml:para>The workitem Id.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">Int32</command:parameterValue>

<dev:type><maml:name>Int32</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>None</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="2" aliases="none"><maml:name>Tfs</maml:name>

<maml:Description><maml:para>An instance of the object TfsTeamProjectCollection, that represents a TeamProjectCollection. If informed the CollectionUrl will be ignored.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">TfsTeamProjectCollection</command:parameterValue>

<dev:type><maml:name>TfsTeamProjectCollection</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>None</dev:defaultValue>

</command:parameter>

</command:syntaxItem>

</command:syntax>

<command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>CollectionUrl</maml:name>

<maml:Description><maml:para>The TeamProjectCollection URL. Ex.: https://tfs2015.local/tfs/defaultcollection.  Note: if the 'Tfs' parameter was informed, this parameter will be ignored.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>None</dev:defaultValue>

</command:parameter>

<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>WorkitemId</maml:name>

<maml:Description><maml:para>The workitem Id.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">Int32</command:parameterValue>

<dev:type><maml:name>Int32</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>None</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="2" aliases="none"><maml:name>Tfs</maml:name>

<maml:Description><maml:para>An instance of the object TfsTeamProjectCollection, that represents a TeamProjectCollection. If informed the CollectionUrl will be ignored.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">TfsTeamProjectCollection</command:parameterValue>

<dev:type><maml:name>TfsTeamProjectCollection</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>None</dev:defaultValue>

</command:parameter>

</command:parameters>

<command:inputTypes></command:inputTypes>

<command:returnValues></command:returnValues>

<maml:alertSet><maml:alert><maml:para>

</maml:para>

</maml:alert>

</maml:alertSet>

<command:examples><command:example><maml:title>Example 1</maml:title>

<dev:code>PS C:\&gt; {{ Add example code here }}</dev:code>

<dev:remarks><maml:para>{{ Add example description here }}

</maml:para>

</dev:remarks>

</command:example>

</command:examples>

<command:relatedLinks></command:relatedLinks>

</command:command>

<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:MSHelp="http://msdn.microsoft.com/mshelp">

<command:details><command:name>Get-WorkItemById</command:name>

<command:verb>Get</command:verb>

<command:noun>WorkItemById</command:noun>

<maml:description><maml:para>Gets a workitem by its Id.

</maml:para>

</maml:description>

</command:details>

<maml:description><maml:para>Retrieves the object that represents the workitem by its Id.

</maml:para>

</maml:description>

<command:syntax><command:syntaxItem><maml:name>Get-WorkItemById</maml:name>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>CollectionUrl</maml:name>

<maml:Description><maml:para>The TeamProjectCollection URL. Ex.: https://tfs2015.local/tfs/defaultcollection.  Note: if the 'Tfs' parameter was informed, this parameter will be ignored.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>None</dev:defaultValue>

</command:parameter>

<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>WorkitemId</maml:name>

<maml:Description><maml:para>The id of the workitem.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">Int32</command:parameterValue>

<dev:type><maml:name>Int32</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>None</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="2" aliases="none"><maml:name>Tfs</maml:name>

<maml:Description><maml:para>An instance of the object TfsTeamProjectCollection, that represents a TeamProjectCollection. If informed the CollectionUrl will be ignored.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">TfsTeamProjectCollection</command:parameterValue>

<dev:type><maml:name>TfsTeamProjectCollection</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>None</dev:defaultValue>

</command:parameter>

</command:syntaxItem>

</command:syntax>

<command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>CollectionUrl</maml:name>

<maml:Description><maml:para>The TeamProjectCollection URL. Ex.: https://tfs2015.local/tfs/defaultcollection.  Note: if the 'Tfs' parameter was informed, this parameter will be ignored.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>None</dev:defaultValue>

</command:parameter>

<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>WorkitemId</maml:name>

<maml:Description><maml:para>The id of the workitem.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">Int32</command:parameterValue>

<dev:type><maml:name>Int32</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>None</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="2" aliases="none"><maml:name>Tfs</maml:name>

<maml:Description><maml:para>An instance of the object TfsTeamProjectCollection, that represents a TeamProjectCollection. If informed the CollectionUrl will be ignored.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">TfsTeamProjectCollection</command:parameterValue>

<dev:type><maml:name>TfsTeamProjectCollection</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>None</dev:defaultValue>

</command:parameter>

</command:parameters>

<command:inputTypes></command:inputTypes>

<command:returnValues></command:returnValues>

<maml:alertSet><maml:alert><maml:para>

</maml:para>

</maml:alert>

</maml:alertSet>

<command:examples><command:example><maml:title>Example 1</maml:title>

<dev:code>PS C:\&gt; {{ Add example code here }}</dev:code>

<dev:remarks><maml:para>{{ Add example description here }}

</maml:para>

</dev:remarks>

</command:example>

</command:examples>

<command:relatedLinks></command:relatedLinks>

</command:command>

<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:MSHelp="http://msdn.microsoft.com/mshelp">

<command:details><command:name>Update-WorkItemField</command:name>

<command:verb>Update</command:verb>

<command:noun>WorkItemField</command:noun>

<maml:description><maml:para>This function are not implemented yet.

</maml:para>

</maml:description>

</command:details>

<maml:description><maml:para>This function are not implemented yet.

</maml:para>

</maml:description>

<command:syntax><command:syntaxItem><maml:name>Update-WorkItemField</maml:name>

</command:syntaxItem>

</command:syntax>

<command:parameters></command:parameters>

<command:inputTypes></command:inputTypes>

<command:returnValues></command:returnValues>

<maml:alertSet><maml:alert><maml:para>

</maml:para>

</maml:alert>

</maml:alertSet>

<command:examples><command:example><maml:title>Example 1</maml:title>

<dev:code>PS C:\&gt; {{ Add example code here }}</dev:code>

<dev:remarks><maml:para>{{ Add example description here }}

</maml:para>

</dev:remarks>

</command:example>

</command:examples>

<command:relatedLinks></command:relatedLinks>

</command:command>

</helpItems>