PoshVsts.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <!-- Cmdlet: Get-VstsBranch --> <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"> <command:details> <command:name>Get-VstsBranch</command:name> <command:verb>Get</command:verb> <command:noun>VstsBranch</command:noun> <maml:description> <maml:para>Gets branches from Visual Studio Team Services</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-VstsBranch cmdlet retrieves branches from a VSTS project.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-VstsBranch</maml:name> <!-- Parameter: AccessToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Personal Access Token (PAT) to login to the VSTS-server. If this is not specified, the access token will be read from the current configuration. The access token cannot be shown using Get-VstsConfiguration, but it is possible to update it by Set-VstsConfiguration. The access token is stored in the windows credential store. In case there is no current access token and the AccessToken argument has not been specified, the cmdlet will prompt for a token.</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>Project name of the Visual Studio Team Services project. If this is not specified, the project will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the project argument has not been specified, the cmdlet will prompt for a 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: Repository --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Name"> <maml:name>Repository</maml:name> <maml:description> <maml:para>Name of the repository. If the connection to VSTS has already been established by running another VSTS-cmdlet, you can cycle through the available repositories via tab-completion.</maml:para> <maml:para>If no repository is specified, but the current path is within a git-repository, that repository will be used. Otherwise there will be an error.</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: Url --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the Visual Studio Team Services instance. If this is not specified, the URL will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the URL argument has not been specified, the cmdlet will prompt for a URL.</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: Repository --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Name"> <maml:name>Repository</maml:name> <maml:description> <maml:para>Name of the repository. If the connection to VSTS has already been established by running another VSTS-cmdlet, you can cycle through the available repositories via tab-completion.</maml:para> <maml:para>If no repository is specified, but the current path is within a git-repository, that repository will be used. Otherwise there will be an error.</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="named" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the repository. If the connection to VSTS has already been established by running another VSTS-cmdlet, you can cycle through the available repositories via tab-completion.</maml:para> <maml:para>If no repository is specified, but the current path is within a git-repository, that repository will be used. Otherwise there will be an error.</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: Url --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the Visual Studio Team Services instance. If this is not specified, the URL will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the URL argument has not been specified, the cmdlet will prompt for a URL.</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>Project name of the Visual Studio Team Services project. If this is not specified, the project will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the project argument has not been specified, the cmdlet will prompt for a 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: AccessToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Personal Access Token (PAT) to login to the VSTS-server. If this is not specified, the access token will be read from the current configuration. The access token cannot be shown using Get-VstsConfiguration, but it is possible to update it by Set-VstsConfiguration. The access token is stored in the windows credential store. In case there is no current access token and the AccessToken argument has not been specified, the cmdlet will prompt for a token.</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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Name of the repository. If the connection to VSTS has already been established by running another VSTS-cmdlet, you can cycle through the available repositories via tab-completion.</maml:para> <maml:para>If no repository is specified, but the current path is within a git-repository, that repository will be used. Otherwise there will be an error.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-VstsBranch</dev:code> <dev:remarks> <maml:para>Returns all branches from the current repository in the current project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-VstsBranch -Url https://fabrikam.visualstudio.com -Project xyz</dev:code> <dev:remarks> <maml:para>Returns all branches from the current repository in project xyz in the VSTS-instance at https://fabrikam.visualstudio.com .</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Get-VstsBranch -Repository "ProductX"</dev:code> <dev:remarks> <maml:para>Returns all branches from the repository "ProductX" in the current project.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-VstsBuild --> <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"> <command:details> <command:name>Get-VstsBuild</command:name> <command:verb>Get</command:verb> <command:noun>VstsBuild</command:noun> <maml:description> <maml:para>Gets the builds from Visual Studio Team Services</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-VstsBuild cmdlet gets the builds from a VSTS project.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Id --> <command:syntaxItem> <maml:name>Get-VstsBuild</maml:name> <!-- Parameter: Id --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Id</maml:name> <maml:description> <maml:para>Id of a build to retrieve.</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>-1</dev:defaultValue> </command:parameter> <!-- Parameter: AccessToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Personal Access Token (PAT) to login to the VSTS-server. If this is not specified, the access token will be read from the current configuration. The access token cannot be shown using Get-VstsConfiguration, but it is possible to update it by Set-VstsConfiguration. The access token is stored in the windows credential store. In case there is no current access token and the AccessToken argument has not been specified, the cmdlet will prompt for a token.</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>Project name of the Visual Studio Team Services project. If this is not specified, the project will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the project argument has not been specified, the cmdlet will prompt for a 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: Url --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the Visual Studio Team Services instance. If this is not specified, the URL will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the URL argument has not been specified, the cmdlet will prompt for a URL.</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: BuildDefinition --> <command:syntaxItem> <maml:name>Get-VstsBuild</maml:name> <!-- Parameter: AccessToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Personal Access Token (PAT) to login to the VSTS-server. If this is not specified, the access token will be read from the current configuration. The access token cannot be shown using Get-VstsConfiguration, but it is possible to update it by Set-VstsConfiguration. The access token is stored in the windows credential store. In case there is no current access token and the AccessToken argument has not been specified, the cmdlet will prompt for a token.</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: BuildDefinition --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BuildDefinition</maml:name> <maml:description> <maml:para>Id, name or instance of a build-definition to return only builds from that definition.</maml:para> </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>Project name of the Visual Studio Team Services project. If this is not specified, the project will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the project argument has not been specified, the cmdlet will prompt for a 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: Url --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the Visual Studio Team Services instance. If this is not specified, the URL will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the URL argument has not been specified, the cmdlet will prompt for a URL.</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: Id --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Id</maml:name> <maml:description> <maml:para>Id of a build to retrieve.</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>-1</dev:defaultValue> </command:parameter> <!-- Parameter: BuildDefinition --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BuildDefinition</maml:name> <maml:description> <maml:para>Id, name or instance of a build-definition to return only builds from that definition.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Url --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the Visual Studio Team Services instance. If this is not specified, the URL will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the URL argument has not been specified, the cmdlet will prompt for a URL.</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>Project name of the Visual Studio Team Services project. If this is not specified, the project will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the project argument has not been specified, the cmdlet will prompt for a 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: AccessToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Personal Access Token (PAT) to login to the VSTS-server. If this is not specified, the access token will be read from the current configuration. The access token cannot be shown using Get-VstsConfiguration, but it is possible to update it by Set-VstsConfiguration. The access token is stored in the windows credential store. In case there is no current access token and the AccessToken argument has not been specified, the cmdlet will prompt for a token.</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:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-VstsBuild</dev:code> <dev:remarks> <maml:para>Returns all builds from the current project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-VstsBuild -Url https://fabrikam.visualstudio.com -Project xyz</dev:code> <dev:remarks> <maml:para>Returns all builds from the project xyz in the VSTS-instance at https://fabrikam.visualstudio.com .</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Get-VstsBuild 123</dev:code> <dev:remarks> <maml:para>Get build with ID 123 from the current project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\> Get-VstsBuild -BuildDefinition "MyReleaseBuild"</dev:code> <dev:remarks> <maml:para>Get all builds from the build-definition with name "MyReleaseBuild" in the current project.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Start-VstsBuild --> <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"> <command:details> <command:name>Start-VstsBuild</command:name> <command:verb>Start</command:verb> <command:noun>VstsBuild</command:noun> <maml:description> <maml:para>Starts a build on Visual Studio Team Services</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Start-VstsBuild cmdlet starts a build on a VSTS project.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Start-VstsBuild</maml:name> <!-- Parameter: BuildDefinition --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="Id"> <maml:name>BuildDefinition</maml:name> <maml:description> <maml:para>Id number or build-definition to start a new build for.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AccessToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Personal Access Token (PAT) to login to the VSTS-server. If this is not specified, the access token will be read from the current configuration. The access token cannot be shown using Get-VstsConfiguration, but it is possible to update it by Set-VstsConfiguration. The access token is stored in the windows credential store. In case there is no current access token and the AccessToken argument has not been specified, the cmdlet will prompt for a token.</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>Project name of the Visual Studio Team Services project. If this is not specified, the project will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the project argument has not been specified, the cmdlet will prompt for a 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: Url --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the Visual Studio Team Services instance. If this is not specified, the URL will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the URL argument has not been specified, the cmdlet will prompt for a URL.</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: BuildDefinition --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="Id"> <maml:name>BuildDefinition</maml:name> <maml:description> <maml:para>Id number or build-definition to start a new build for.</maml: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 (ByPropertyName)" position="1" aliases="Id"> <maml:name>Id</maml:name> <maml:description> <maml:para>Id number or build-definition to start a new build for.</maml:para> <maml:para>This is an alias of the BuildDefinition 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: Url --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the Visual Studio Team Services instance. If this is not specified, the URL will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the URL argument has not been specified, the cmdlet will prompt for a URL.</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>Project name of the Visual Studio Team Services project. If this is not specified, the project will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the project argument has not been specified, the cmdlet will prompt for a 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: AccessToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Personal Access Token (PAT) to login to the VSTS-server. If this is not specified, the access token will be read from the current configuration. The access token cannot be shown using Get-VstsConfiguration, but it is possible to update it by Set-VstsConfiguration. The access token is stored in the windows credential store. In case there is no current access token and the AccessToken argument has not been specified, the cmdlet will prompt for a token.</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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Id number or build-definition to start a new build for.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Start-VstsBuild 133</dev:code> <dev:remarks> <maml:para>Starts a new build with the build-definition 133.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Start-VstsBuild 133 -Url https://fabrikam.visualstudio.com -Project xyz</dev:code> <dev:remarks> <maml:para>Starts a new build with the build-definition 133 from the project xyz in the VSTS-instance at https://fabrikam.visualstudio.com .</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Start-VstsBuild $buildDefinition</dev:code> <dev:remarks> <maml:para>tarts a new build with the build-definition $buildDefinition.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-VstsBuildDefinition --> <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"> <command:details> <command:name>Get-VstsBuildDefinition</command:name> <command:verb>Get</command:verb> <command:noun>VstsBuildDefinition</command:noun> <maml:description> <maml:para>Gets the build definitions from Visual Studio Team Services</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-VstsBuildDefinition cmdlet gets the build definitions from a VSTS project.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-VstsBuildDefinition</maml:name> <!-- Parameter: AccessToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Personal Access Token (PAT) to login to the VSTS-server. If this is not specified, the access token will be read from the current configuration. The access token cannot be shown using Get-VstsConfiguration, but it is possible to update it by Set-VstsConfiguration. The access token is stored in the windows credential store. In case there is no current access token and the AccessToken argument has not been specified, the cmdlet will prompt for a token.</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>Project name of the Visual Studio Team Services project. If this is not specified, the project will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the project argument has not been specified, the cmdlet will prompt for a 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: Url --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the Visual Studio Team Services instance. If this is not specified, the URL will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the URL argument has not been specified, the cmdlet will prompt for a URL.</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: Url --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the Visual Studio Team Services instance. If this is not specified, the URL will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the URL argument has not been specified, the cmdlet will prompt for a URL.</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>Project name of the Visual Studio Team Services project. If this is not specified, the project will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the project argument has not been specified, the cmdlet will prompt for a 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: AccessToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Personal Access Token (PAT) to login to the VSTS-server. If this is not specified, the access token will be read from the current configuration. The access token cannot be shown using Get-VstsConfiguration, but it is possible to update it by Set-VstsConfiguration. The access token is stored in the windows credential store. In case there is no current access token and the AccessToken argument has not been specified, the cmdlet will prompt for a token.</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:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-VstsBuildDefinition -Url https://fabrikam.visualstudio.com -Project xyz</dev:code> <dev:remarks> <maml:para>Returns all build-definitions from the project xyz in the VSTS-instance at https://fabrikam.visualstudio.com .</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-VstsBuildDefinition -Project xyz</dev:code> <dev:remarks> <maml:para>Returns all build definitions from the project xyz.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-VstsBuildLog --> <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"> <command:details> <command:name>Get-VstsBuildLog</command:name> <command:verb>Get</command:verb> <command:noun>VstsBuildLog</command:noun> <maml:description> <maml:para>Gets the build logs from a build in Visual Studio Team Services</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-VstsBuildLog cmdlet gets the build log for a build on VSTS.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-VstsBuildLog</maml:name> <!-- Parameter: Build --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="Id"> <maml:name>Build</maml:name> <maml:description> <maml:para>Id number or build-instance returned from Get-VstsBuild to get the logs for.</maml:para> <maml:para>Entries will be returned after a log-file has been fully written.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AccessToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Personal Access Token (PAT) to login to the VSTS-server. If this is not specified, the access token will be read from the current configuration. The access token cannot be shown using Get-VstsConfiguration, but it is possible to update it by Set-VstsConfiguration. The access token is stored in the windows credential store. In case there is no current access token and the AccessToken argument has not been specified, the cmdlet will prompt for a token.</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: Pretty --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Pretty</maml:name> <maml:description> <maml:para>Returns the log entries as text formatted for better readability.</maml:para> <maml:para>Use this switch if you want to read the log on the screen. If you want to process or analyze log entries, do not specify the switch so that log entries will be returned as objects with properties instead of text.</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>Project name of the Visual Studio Team Services project. If this is not specified, the project will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the project argument has not been specified, the cmdlet will prompt for a 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: Url --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the Visual Studio Team Services instance. If this is not specified, the URL will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the URL argument has not been specified, the cmdlet will prompt for a URL.</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: Build --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="Id"> <maml:name>Build</maml:name> <maml:description> <maml:para>Id number or build-instance returned from Get-VstsBuild to get the logs for.</maml:para> <maml:para>Entries will be returned after a log-file has been fully written.</maml: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 (ByPropertyName)" position="1" aliases="Id"> <maml:name>Id</maml:name> <maml:description> <maml:para>Id number or build-instance returned from Get-VstsBuild to get the logs for.</maml:para> <maml:para>Entries will be returned after a log-file has been fully written.</maml:para> <maml:para>This is an alias of the Build 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: Pretty --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Pretty</maml:name> <maml:description> <maml:para>Returns the log entries as text formatted for better readability.</maml:para> <maml:para>Use this switch if you want to read the log on the screen. If you want to process or analyze log entries, do not specify the switch so that log entries will be returned as objects with properties instead of text.</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: Url --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the Visual Studio Team Services instance. If this is not specified, the URL will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the URL argument has not been specified, the cmdlet will prompt for a URL.</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>Project name of the Visual Studio Team Services project. If this is not specified, the project will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the project argument has not been specified, the cmdlet will prompt for a 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: AccessToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Personal Access Token (PAT) to login to the VSTS-server. If this is not specified, the access token will be read from the current configuration. The access token cannot be shown using Get-VstsConfiguration, but it is possible to update it by Set-VstsConfiguration. The access token is stored in the windows credential store. In case there is no current access token and the AccessToken argument has not been specified, the cmdlet will prompt for a token.</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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Id number or build-instance returned from Get-VstsBuild to get the logs for.</maml:para> <maml:para>Entries will be returned after a log-file has been fully written.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-VstsBuildLog 133</dev:code> <dev:remarks> <maml:para>Returns all log entries for the build with ID 133.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-VstsBuildLog 133 -Url https://fabrikam.visualstudio.com -Project xyz</dev:code> <dev:remarks> <maml:para>Returns all log entries for the build with ID 133 from the project xyz in the VSTS-instance at https://fabrikam.visualstudio.com .</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Get-VstsBuildLog -Id 323 -Pretty</dev:code> <dev:remarks> <maml:para>Returns all log entries for the build with ID 323 formatted for readability.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\> Get-VstsBuildLog -Build $build</dev:code> <dev:remarks> <maml:para>Returns all log entries for the build in $build.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 5 ----------</maml:title> <dev:code>PS C:\> $build | Get-VstsBuildLog</dev:code> <dev:remarks> <maml:para>Returns all log entries for the build in $build.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-VstsConfiguration --> <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"> <command:details> <command:name>Get-VstsConfiguration</command:name> <command:verb>Get</command:verb> <command:noun>VstsConfiguration</command:noun> <maml:description> <maml:para>Returns the current configuration settings for PoshVsts.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-VstsConfiguration cmdlet returns the current PoshVsts configuration.</maml:para> <maml:para>The configuration contains the URL to the VSTS-instance and the name of the project, which will be used whenever a PoshVsts cmdlet is called without specifying the URL-parameter and/or the Project-parameter.</maml:para> <maml:para>The configuration is read from a file named .poshVsts in the current user´s directory.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-VstsConfiguration</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-VstsConfiguration</dev:code> <dev:remarks> <maml:para>Returns the current configuration.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-VstsConfiguration --> <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"> <command:details> <command:name>Set-VstsConfiguration</command:name> <command:verb>Set</command:verb> <command:noun>VstsConfiguration</command:noun> <maml:description> <maml:para>Updates the current configuration settings for PoshVsts.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-VstsConfiguration cmdlet changes the current PoshVsts configuration.</maml:para> <maml:para>The configuration contains the URL to the VSTS-instance and the name of the project, which will be used whenever a PoshVsts cmdlet is called without specifying the URL-parameter and/or the Project-parameter.</maml:para> <maml:para>The configuration is saved in a file named .poshVsts in the current user´s directory.</maml:para> <maml:para>This cmdlet can also be used to update the personal access token, which is stored in the windows credential store.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-VstsConfiguration</maml:name> <!-- Parameter: AccessToken --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>The personal access token (PAT) which is used by all PoshVsts cmdlets to access VSTS. It will be stored in the windows credential store.</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 (ByPropertyName)" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Project of the project which will be used as a default for all PoshVsts cmdlets.</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: Url --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>URL to the VSTS-instance which will be used as a default for all PoshVsts cmdlets.</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: Url --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>URL to the VSTS-instance which will be used as a default for all PoshVsts cmdlets.</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 (ByPropertyName)" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Project of the project which will be used as a default for all PoshVsts cmdlets.</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: AccessToken --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>The personal access token (PAT) which is used by all PoshVsts cmdlets to access VSTS. It will be stored in the windows credential store.</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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>URL to the VSTS-instance which will be used as a default for all PoshVsts cmdlets.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Project of the project which will be used as a default for all PoshVsts cmdlets.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The personal access token (PAT) which is used by all PoshVsts cmdlets to access VSTS. It will be stored in the windows credential store.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-VstsConfiguration</dev:code> <dev:remarks> <maml:para>Returns the current configuration.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-VstsIteration --> <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"> <command:details> <command:name>Get-VstsIteration</command:name> <command:verb>Get</command:verb> <command:noun>VstsIteration</command:noun> <maml:description> <maml:para>Returns all iterations on Visual Studio Team Services</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-VstsIteration cmdlet returns all iterations from VSTS.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-VstsIteration</maml:name> <!-- Parameter: AccessToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Personal Access Token (PAT) to login to the VSTS-server. If this is not specified, the access token will be read from the current configuration. The access token cannot be shown using Get-VstsConfiguration, but it is possible to update it by Set-VstsConfiguration. The access token is stored in the windows credential store. In case there is no current access token and the AccessToken argument has not been specified, the cmdlet will prompt for a token.</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>Project name of the Visual Studio Team Services project. If this is not specified, the project will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the project argument has not been specified, the cmdlet will prompt for a 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: Url --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the Visual Studio Team Services instance. If this is not specified, the URL will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the URL argument has not been specified, the cmdlet will prompt for a URL.</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: Url --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the Visual Studio Team Services instance. If this is not specified, the URL will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the URL argument has not been specified, the cmdlet will prompt for a URL.</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>Project name of the Visual Studio Team Services project. If this is not specified, the project will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the project argument has not been specified, the cmdlet will prompt for a 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: AccessToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Personal Access Token (PAT) to login to the VSTS-server. If this is not specified, the access token will be read from the current configuration. The access token cannot be shown using Get-VstsConfiguration, but it is possible to update it by Set-VstsConfiguration. The access token is stored in the windows credential store. In case there is no current access token and the AccessToken argument has not been specified, the cmdlet will prompt for a token.</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:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-VstsIteration</dev:code> <dev:remarks> <maml:para>Returns all iterations from the current project on the current VSTS-instance.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-VstsIteration -Url https://fabrikam.visualstudio.com -Project xyz</dev:code> <dev:remarks> <maml:para>Returns all iterations from the project xyz on the VSTS-instance at https://fabrikam.visualstudio.com</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-VstsPullRequest --> <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"> <command:details> <command:name>Get-VstsPullRequest</command:name> <command:verb>Get</command:verb> <command:noun>VstsPullRequest</command:noun> <maml:description> <maml:para>Gets the pull-requests from Visual Studio Team Services</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-VstsPullRequest cmdlet gets the pull-requests from a VSTS project.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-VstsPullRequest</maml:name> <!-- Parameter: Id --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Id</maml:name> <maml:description> <maml:para>Id of a pull-request.</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>-1</dev:defaultValue> </command:parameter> <!-- Parameter: AccessToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Personal Access Token (PAT) to login to the VSTS-server. If this is not specified, the access token will be read from the current configuration. The access token cannot be shown using Get-VstsConfiguration, but it is possible to update it by Set-VstsConfiguration. The access token is stored in the windows credential store. In case there is no current access token and the AccessToken argument has not been specified, the cmdlet will prompt for a token.</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>Project name of the Visual Studio Team Services project. If this is not specified, the project will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the project argument has not been specified, the cmdlet will prompt for a 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: Url --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the Visual Studio Team Services instance. If this is not specified, the URL will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the URL argument has not been specified, the cmdlet will prompt for a URL.</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: Id --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Id</maml:name> <maml:description> <maml:para>Id of a pull-request.</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>-1</dev:defaultValue> </command:parameter> <!-- Parameter: Url --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the Visual Studio Team Services instance. If this is not specified, the URL will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the URL argument has not been specified, the cmdlet will prompt for a URL.</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>Project name of the Visual Studio Team Services project. If this is not specified, the project will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the project argument has not been specified, the cmdlet will prompt for a 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: AccessToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Personal Access Token (PAT) to login to the VSTS-server. If this is not specified, the access token will be read from the current configuration. The access token cannot be shown using Get-VstsConfiguration, but it is possible to update it by Set-VstsConfiguration. The access token is stored in the windows credential store. In case there is no current access token and the AccessToken argument has not been specified, the cmdlet will prompt for a token.</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:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-VstsPullRequest</dev:code> <dev:remarks> <maml:para>Returns all pull-requests from the current project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-VstsPullRequest 123</dev:code> <dev:remarks> <maml:para>Returns the pull-request with id 123 from the current project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Get-VstsPullRequest -Url https://fabrikam.visualstudio.com -Project xyz</dev:code> <dev:remarks> <maml:para>Returns all pull-requests from the project xyz in the VSTS-instance at https://fabrikam.visualstudio.com .</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-VstsPullRequest --> <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"> <command:details> <command:name>New-VstsPullRequest</command:name> <command:verb>New</command:verb> <command:noun>VstsPullRequest</command:noun> <maml:description> <maml:para>Creates a new pull-request on Visual Studio Team Services</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-VstsPullRequest cmdlet creates a new pull-request on a VSTS project.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-VstsPullRequest</maml:name> <!-- Parameter: Title --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Title</maml:name> <maml:description> <maml:para>Title of the pull request.</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: TargetBranch --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>TargetBranch</maml:name> <maml:description> <maml:para>Name of the target branch. If the connection to VSTS has already been established by running another VSTS-cmdlet, you can cycle through the available branches via tab-completion.</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: AccessToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Personal Access Token (PAT) to login to the VSTS-server. If this is not specified, the access token will be read from the current configuration. The access token cannot be shown using Get-VstsConfiguration, but it is possible to update it by Set-VstsConfiguration. The access token is stored in the windows credential store. In case there is no current access token and the AccessToken argument has not been specified, the cmdlet will prompt for a token.</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>Project name of the Visual Studio Team Services project. If this is not specified, the project will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the project argument has not been specified, the cmdlet will prompt for a 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: Repository --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Repository</maml:name> <maml:description> <maml:para>Name of the repository. If the connection to VSTS has already been established by running another VSTS-cmdlet, you can cycle through the available repositories via tab-completion.</maml:para> <maml:para>If no repository is specified, but the current path is within a git-repository, that repository will be used. Otherwise there will be an error.</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: SourceBranch --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceBranch</maml:name> <maml:description> <maml:para>Name of the source branch. If the connection to VSTS has already been established by running another VSTS-cmdlet, you can cycle through the available branches via tab-completion.</maml:para> <maml:para>If no source branch is specified, but the current path is within a git-repository, the currently checked out branch will be assumed to be the source. Otherwise there will be an error.</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: Url --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the Visual Studio Team Services instance. If this is not specified, the URL will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the URL argument has not been specified, the cmdlet will prompt for a URL.</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: Title --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Title</maml:name> <maml:description> <maml:para>Title of the pull request.</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: TargetBranch --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>TargetBranch</maml:name> <maml:description> <maml:para>Name of the target branch. If the connection to VSTS has already been established by running another VSTS-cmdlet, you can cycle through the available branches via tab-completion.</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: Repository --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Repository</maml:name> <maml:description> <maml:para>Name of the repository. If the connection to VSTS has already been established by running another VSTS-cmdlet, you can cycle through the available repositories via tab-completion.</maml:para> <maml:para>If no repository is specified, but the current path is within a git-repository, that repository will be used. Otherwise there will be an error.</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: SourceBranch --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceBranch</maml:name> <maml:description> <maml:para>Name of the source branch. If the connection to VSTS has already been established by running another VSTS-cmdlet, you can cycle through the available branches via tab-completion.</maml:para> <maml:para>If no source branch is specified, but the current path is within a git-repository, the currently checked out branch will be assumed to be the source. Otherwise there will be an error.</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: Url --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the Visual Studio Team Services instance. If this is not specified, the URL will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the URL argument has not been specified, the cmdlet will prompt for a URL.</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>Project name of the Visual Studio Team Services project. If this is not specified, the project will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the project argument has not been specified, the cmdlet will prompt for a 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: AccessToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Personal Access Token (PAT) to login to the VSTS-server. If this is not specified, the access token will be read from the current configuration. The access token cannot be shown using Get-VstsConfiguration, but it is possible to update it by Set-VstsConfiguration. The access token is stored in the windows credential store. In case there is no current access token and the AccessToken argument has not been specified, the cmdlet will prompt for a token.</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:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> New-VstsPullRequest "Made some minor adjustments" "master"</dev:code> <dev:remarks> <maml:para>Creates a new pull-request with the title "Made some minor adjustments". It will request to pull the changes from the current branch into the branch "master".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> New-VstsPullRequest -Title "Made some minor adjustments" -Repository "ProductX" -SourceBranch "MyFeature" -TargetBranch "master"</dev:code> <dev:remarks> <maml:para>Creates a new pull-request with the title "Made some minor adjustments". It will request to pull the changes from the branch "MyFeature" in repository "ProductX" into the branch "master" in repository "ProductX".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> New-VstsPullRequest Made some minor adjustments" "master" -Url https://fabrikam.visualstudio.com -Project xyz</dev:code> <dev:remarks> <maml:para>Creates a new pull-request with the title "Made some minor adjustments". It will request to pull the changes from the current branch into the branch "master" of the project xyz in the VSTS-instance at https://fabrikam.visualstudio.com .</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Update-VstsPullRequest --> <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"> <command:details> <command:name>Update-VstsPullRequest</command:name> <command:verb>Update</command:verb> <command:noun>VstsPullRequest</command:noun> <maml:description> <maml:para>Updates a pull-request in Visual Studio Team Services</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Update-VstsPullRequest cmdlet gets updates a pull-request on a VSTS project.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Update-VstsPullRequest</maml:name> <!-- Parameter: PullRequestId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>PullRequestId</maml:name> <maml:description> <maml:para>Id number or pull-request-instance returned from Get-VstsPullRequest to update.</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: AccessToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Personal Access Token (PAT) to login to the VSTS-server. If this is not specified, the access token will be read from the current configuration. The access token cannot be shown using Get-VstsConfiguration, but it is possible to update it by Set-VstsConfiguration. The access token is stored in the windows credential store. In case there is no current access token and the AccessToken argument has not been specified, the cmdlet will prompt for a token.</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>New description of the pull-request.</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>Project name of the Visual Studio Team Services project. If this is not specified, the project will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the project argument has not been specified, the cmdlet will prompt for a 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: Repository --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Repository</maml:name> <maml:description> <maml:para>Name of the repository. If the connection to VSTS has already been established by running another VSTS-cmdlet, you can cycle through the available repositories via tab-completion.</maml:para> <maml:para>If no repository is specified, but the current path is within a git-repository, that repository will be used. Otherwise there will be an error.</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: Title --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>New title of the pull-request.</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: Url --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the Visual Studio Team Services instance. If this is not specified, the URL will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the URL argument has not been specified, the cmdlet will prompt for a URL.</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: PullRequestId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>PullRequestId</maml:name> <maml:description> <maml:para>Id number or pull-request-instance returned from Get-VstsPullRequest to update.</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: Repository --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Repository</maml:name> <maml:description> <maml:para>Name of the repository. If the connection to VSTS has already been established by running another VSTS-cmdlet, you can cycle through the available repositories via tab-completion.</maml:para> <maml:para>If no repository is specified, but the current path is within a git-repository, that repository will be used. Otherwise there will be an error.</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: Title --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>New title of the pull-request.</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>New description of the pull-request.</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: Url --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the Visual Studio Team Services instance. If this is not specified, the URL will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the URL argument has not been specified, the cmdlet will prompt for a URL.</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>Project name of the Visual Studio Team Services project. If this is not specified, the project will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the project argument has not been specified, the cmdlet will prompt for a 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: AccessToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Personal Access Token (PAT) to login to the VSTS-server. If this is not specified, the access token will be read from the current configuration. The access token cannot be shown using Get-VstsConfiguration, but it is possible to update it by Set-VstsConfiguration. The access token is stored in the windows credential store. In case there is no current access token and the AccessToken argument has not been specified, the cmdlet will prompt for a token.</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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Id number or pull-request-instance returned from Get-VstsPullRequest to update.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Update-VstsPullRequest 314 -Title "This is a new title"</dev:code> <dev:remarks> <maml:para>Updates the title of pull-request with Id 314 in the current repository to be "This is a new title"</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Update-VstsPullRequest $pullRequest -Repository "ProductX" -Description "This is a new description"</dev:code> <dev:remarks> <maml:para>Updates the description of the pull-request $pullRequest in the repository "ProductX" to be "This is a new description"</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-VstsRelation --> <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"> <command:details> <command:name>Add-VstsRelation</command:name> <command:verb>Add</command:verb> <command:noun>VstsRelation</command:noun> <maml:description> <maml:para>Creates a new relation for a work-item on Visual Studio Team Services</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Add-VstsRelation cmdlet creates a new work-item relation.</maml:para> <maml:para>The relation will be saved right away to VSTS and there is no need to invoke Save-VstsWorkItem.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Add-VstsRelation</maml:name> <!-- Parameter: Item --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="ItemId"> <maml:name>Item</maml:name> <maml:description> <maml:para>Id number or work-item-instance returned from Get-VstsWorkItem to add a relation 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: Type --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Type</maml:name> <maml:description> <maml:para>Type of the relation. You can cycle through all supported relations using tab-completion.</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: RelatedItem --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3" aliases="RelatedItemId"> <maml:name>RelatedItem</maml:name> <maml:description> <maml:para>Element that should be associated with the work-item.</maml:para> <maml:para>This can be an instance or ID of a work-item, branch or pull-request.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AccessToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Personal Access Token (PAT) to login to the VSTS-server. If this is not specified, the access token will be read from the current configuration. The access token cannot be shown using Get-VstsConfiguration, but it is possible to update it by Set-VstsConfiguration. The access token is stored in the windows credential store. In case there is no current access token and the AccessToken argument has not been specified, the cmdlet will prompt for a token.</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>Project name of the Visual Studio Team Services project. If this is not specified, the project will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the project argument has not been specified, the cmdlet will prompt for a 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: Repository --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Name"> <maml:name>Repository</maml:name> <maml:description> <maml:para>Name of a repository on VSTS.</maml:para> <maml:para>This can be specified if the related-item is a branch or pull-request. If it is not specified the current repository will be assumed.</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: Url --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the Visual Studio Team Services instance. If this is not specified, the URL will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the URL argument has not been specified, the cmdlet will prompt for a URL.</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: Item --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="ItemId"> <maml:name>Item</maml:name> <maml:description> <maml:para>Id number or work-item-instance returned from Get-VstsWorkItem to add a relation 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="true (ByValue)" position="1" aliases="ItemId"> <maml:name>ItemId</maml:name> <maml:description> <maml:para>Id number or work-item-instance returned from Get-VstsWorkItem to add a relation to.</maml:para> <maml:para>This is an alias of the Item 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: Type --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Type</maml:name> <maml:description> <maml:para>Type of the relation. You can cycle through all supported relations using tab-completion.</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: RelatedItem --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3" aliases="RelatedItemId"> <maml:name>RelatedItem</maml:name> <maml:description> <maml:para>Element that should be associated with the work-item.</maml:para> <maml:para>This can be an instance or ID of a work-item, branch or pull-request.</maml: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="3" aliases="RelatedItemId"> <maml:name>RelatedItemId</maml:name> <maml:description> <maml:para>Element that should be associated with the work-item.</maml:para> <maml:para>This can be an instance or ID of a work-item, branch or pull-request.</maml:para> <maml:para>This is an alias of the RelatedItem 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: Repository --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Name"> <maml:name>Repository</maml:name> <maml:description> <maml:para>Name of a repository on VSTS.</maml:para> <maml:para>This can be specified if the related-item is a branch or pull-request. If it is not specified the current repository will be assumed.</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="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of a repository on VSTS.</maml:para> <maml:para>This can be specified if the related-item is a branch or pull-request. If it is not specified the current repository will be assumed.</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: Url --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the Visual Studio Team Services instance. If this is not specified, the URL will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the URL argument has not been specified, the cmdlet will prompt for a URL.</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>Project name of the Visual Studio Team Services project. If this is not specified, the project will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the project argument has not been specified, the cmdlet will prompt for a 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: AccessToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Personal Access Token (PAT) to login to the VSTS-server. If this is not specified, the access token will be read from the current configuration. The access token cannot be shown using Get-VstsConfiguration, but it is possible to update it by Set-VstsConfiguration. The access token is stored in the windows credential store. In case there is no current access token and the AccessToken argument has not been specified, the cmdlet will prompt for a token.</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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Id number or work-item-instance returned from Get-VstsWorkItem to add a relation to.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Add-VstsRelation $workItem "Related" $relatedWorkItem</dev:code> <dev:remarks> <maml:para>Adds a new relation of type "Related" between the work-item in $workItem and the work-item in $anotherWorkItem</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Add-VstsRelation -ItemId 123 -Type "Duplicate" -RelatedItem 456</dev:code> <dev:remarks> <maml:para>Adds a new relation of type "Duplicate" between the work-item with id 123 and the work-item with id 456</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Add-VstsRelation 123 "Branch" "MyBranch" -Repository ProductX</dev:code> <dev:remarks> <maml:para>Associates the branch "MyBranch" in repository "ProductX" with the work-item with id 456.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\> Add-VstsRelation $item "PullRequest" 243 -Url https://fabrikam.visualstudio.com -Project xyz</dev:code> <dev:remarks> <maml:para>Associates the work-item in $item with the pull-request with id 243 in the current repository in the project xyz on the VSTS-instance at https://fabrikam.visualstudio.com</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-VstsRelation --> <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"> <command:details> <command:name>Remove-VstsRelation</command:name> <command:verb>Remove</command:verb> <command:noun>VstsRelation</command:noun> <maml:description> <maml:para>Removes a work-item relation from Visual Studio Team Services</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-VstsRelation a work-item relation on VSTS.</maml:para> <maml:para>The relation will be removed right away from VSTS and there is no need to invoke Save-VstsWorkItem.</maml:para> <maml:para>If the relation is between work-items the respective relation of the related work-item will also be removed. For example removing a child-relation will also remove the parent-relation from the child.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-VstsRelation</maml:name> <!-- Parameter: Item --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="ItemId"> <maml:name>Item</maml:name> <maml:description> <maml:para>Id number or work-item-instance returned from Get-VstsWorkItem to remove a relation 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: Relation --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Relation</maml:name> <maml:description> <maml:para>String-representation of a relation or a relation-instance retrieved from the Relation-property of a work-item. If the item-parameter has already been provided on the command-line, you can cycle through all relations of the item using tab-completion. The cmdlet will use a string representation of the relation in the format "Type(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: AccessToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Personal Access Token (PAT) to login to the VSTS-server. If this is not specified, the access token will be read from the current configuration. The access token cannot be shown using Get-VstsConfiguration, but it is possible to update it by Set-VstsConfiguration. The access token is stored in the windows credential store. In case there is no current access token and the AccessToken argument has not been specified, the cmdlet will prompt for a token.</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>Project name of the Visual Studio Team Services project. If this is not specified, the project will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the project argument has not been specified, the cmdlet will prompt for a 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: Url --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the Visual Studio Team Services instance. If this is not specified, the URL will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the URL argument has not been specified, the cmdlet will prompt for a URL.</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: Item --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="ItemId"> <maml:name>Item</maml:name> <maml:description> <maml:para>Id number or work-item-instance returned from Get-VstsWorkItem to remove a relation 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> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="ItemId"> <maml:name>ItemId</maml:name> <maml:description> <maml:para>Id number or work-item-instance returned from Get-VstsWorkItem to remove a relation from.</maml:para> <maml:para>This is an alias of the Item 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: Relation --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Relation</maml:name> <maml:description> <maml:para>String-representation of a relation or a relation-instance retrieved from the Relation-property of a work-item. If the item-parameter has already been provided on the command-line, you can cycle through all relations of the item using tab-completion. The cmdlet will use a string representation of the relation in the format "Type(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: Url --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the Visual Studio Team Services instance. If this is not specified, the URL will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the URL argument has not been specified, the cmdlet will prompt for a URL.</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>Project name of the Visual Studio Team Services project. If this is not specified, the project will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the project argument has not been specified, the cmdlet will prompt for a 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: AccessToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Personal Access Token (PAT) to login to the VSTS-server. If this is not specified, the access token will be read from the current configuration. The access token cannot be shown using Get-VstsConfiguration, but it is possible to update it by Set-VstsConfiguration. The access token is stored in the windows credential store. In case there is no current access token and the AccessToken argument has not been specified, the cmdlet will prompt for a token.</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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Id number or work-item-instance returned from Get-VstsWorkItem to remove a relation from.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Remove-VstsRelation 123 $item.Relations[0]</dev:code> <dev:remarks> <maml:para>Removes the first relation of the work-item with id 123.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> $item | Remove-VstsRelation $relation</dev:code> <dev:remarks> <maml:para>Removes the relation in $relation from the work-item in $item.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Remove-VstsRelation -Item $item -Relation "Child(123)"</dev:code> <dev:remarks> <maml:para>Removes the child relation to item with id 123 from the work-item in $item.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\> Remove-VstsRelation 123 $relation -Url https://fabrikam.visualstudio.com -Project xyz</dev:code> <dev:remarks> <maml:para>Removes the relation in $relation from the work-item with id 123 in the project xyz in the VSTS-instance at https://fabrikam.visualstudio.com .</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-VstsRelease --> <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"> <command:details> <command:name>Get-VstsRelease</command:name> <command:verb>Get</command:verb> <command:noun>VstsRelease</command:noun> <maml:description> <maml:para>Gets the releases from Visual Studio Team Services</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-VstsRelease cmdlet gets the releases from a VSTS project.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-VstsRelease</maml:name> <!-- Parameter: Id --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Id</maml:name> <maml:description> <maml:para>Id of a release to retrieve.</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>-1</dev:defaultValue> </command:parameter> <!-- Parameter: AccessToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Personal Access Token (PAT) to login to the VSTS-server. If this is not specified, the access token will be read from the current configuration. The access token cannot be shown using Get-VstsConfiguration, but it is possible to update it by Set-VstsConfiguration. The access token is stored in the windows credential store. In case there is no current access token and the AccessToken argument has not been specified, the cmdlet will prompt for a token.</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>Project name of the Visual Studio Team Services project. If this is not specified, the project will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the project argument has not been specified, the cmdlet will prompt for a 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: Url --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the Visual Studio Team Services instance. If this is not specified, the URL will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the URL argument has not been specified, the cmdlet will prompt for a URL.</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: Id --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Id</maml:name> <maml:description> <maml:para>Id of a release to retrieve.</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>-1</dev:defaultValue> </command:parameter> <!-- Parameter: Url --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the Visual Studio Team Services instance. If this is not specified, the URL will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the URL argument has not been specified, the cmdlet will prompt for a URL.</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>Project name of the Visual Studio Team Services project. If this is not specified, the project will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the project argument has not been specified, the cmdlet will prompt for a 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: AccessToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Personal Access Token (PAT) to login to the VSTS-server. If this is not specified, the access token will be read from the current configuration. The access token cannot be shown using Get-VstsConfiguration, but it is possible to update it by Set-VstsConfiguration. The access token is stored in the windows credential store. In case there is no current access token and the AccessToken argument has not been specified, the cmdlet will prompt for a token.</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:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-VstsRelease</dev:code> <dev:remarks> <maml:para>Returns all releases from the current project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-VstsRelease -Url https://fabrikam.visualstudio.com -Project xyz</dev:code> <dev:remarks> <maml:para>Returns all releases from the project xyz in the VSTS-instance at https://fabrikam.visualstudio.com .</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Get-VstsRelease 123</dev:code> <dev:remarks> <maml:para>Get release with ID 123 from the current project.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-VstsReleaseDefinition --> <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"> <command:details> <command:name>Get-VstsReleaseDefinition</command:name> <command:verb>Get</command:verb> <command:noun>VstsReleaseDefinition</command:noun> <maml:description> <maml:para>Gets the release-definitions from Visual Studio Team Services</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-VstsReleaseDefinition cmdlet gets the release-definitions from a VSTS project.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-VstsReleaseDefinition</maml:name> <!-- Parameter: AccessToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Personal Access Token (PAT) to login to the VSTS-server. If this is not specified, the access token will be read from the current configuration. The access token cannot be shown using Get-VstsConfiguration, but it is possible to update it by Set-VstsConfiguration. The access token is stored in the windows credential store. In case there is no current access token and the AccessToken argument has not been specified, the cmdlet will prompt for a token.</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>Project name of the Visual Studio Team Services project. If this is not specified, the project will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the project argument has not been specified, the cmdlet will prompt for a 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: Url --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the Visual Studio Team Services instance. If this is not specified, the URL will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the URL argument has not been specified, the cmdlet will prompt for a URL.</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: Url --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the Visual Studio Team Services instance. If this is not specified, the URL will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the URL argument has not been specified, the cmdlet will prompt for a URL.</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>Project name of the Visual Studio Team Services project. If this is not specified, the project will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the project argument has not been specified, the cmdlet will prompt for a 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: AccessToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Personal Access Token (PAT) to login to the VSTS-server. If this is not specified, the access token will be read from the current configuration. The access token cannot be shown using Get-VstsConfiguration, but it is possible to update it by Set-VstsConfiguration. The access token is stored in the windows credential store. In case there is no current access token and the AccessToken argument has not been specified, the cmdlet will prompt for a token.</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:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-VstsReleaseDefinition</dev:code> <dev:remarks> <maml:para>Returns all release-definitions from the current project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-VstsReleaseDefinition -Url https://fabrikam.visualstudio.com -Project xyz</dev:code> <dev:remarks> <maml:para>Returns all release definitions from the project xyz in the VSTS-instance at https://fabrikam.visualstudio.com .</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-VstsRepository --> <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"> <command:details> <command:name>Get-VstsRepository</command:name> <command:verb>Get</command:verb> <command:noun>VstsRepository</command:noun> <maml:description> <maml:para>Gets the repositories from Visual Studio Team Services</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-VstsRepository cmdlet gets the repositories from a VSTS project.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-VstsRepository</maml:name> <!-- Parameter: AccessToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Personal Access Token (PAT) to login to the VSTS-server. If this is not specified, the access token will be read from the current configuration. The access token cannot be shown using Get-VstsConfiguration, but it is possible to update it by Set-VstsConfiguration. The access token is stored in the windows credential store. In case there is no current access token and the AccessToken argument has not been specified, the cmdlet will prompt for a token.</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>Project name of the Visual Studio Team Services project. If this is not specified, the project will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the project argument has not been specified, the cmdlet will prompt for a 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: Url --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the Visual Studio Team Services instance. If this is not specified, the URL will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the URL argument has not been specified, the cmdlet will prompt for a URL.</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: Url --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the Visual Studio Team Services instance. If this is not specified, the URL will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the URL argument has not been specified, the cmdlet will prompt for a URL.</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>Project name of the Visual Studio Team Services project. If this is not specified, the project will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the project argument has not been specified, the cmdlet will prompt for a 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: AccessToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Personal Access Token (PAT) to login to the VSTS-server. If this is not specified, the access token will be read from the current configuration. The access token cannot be shown using Get-VstsConfiguration, but it is possible to update it by Set-VstsConfiguration. The access token is stored in the windows credential store. In case there is no current access token and the AccessToken argument has not been specified, the cmdlet will prompt for a token.</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:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-VstsRepository</dev:code> <dev:remarks> <maml:para>Returns all repositories from the current project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-VstsRepository -Url https://fabrikam.visualstudio.com -Project xyz</dev:code> <dev:remarks> <maml:para>Returns all repositories from the project xyz in the VSTS-instance at https://fabrikam.visualstudio.com .</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-VstsWorkItem --> <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"> <command:details> <command:name>Get-VstsWorkItem</command:name> <command:verb>Get</command:verb> <command:noun>VstsWorkItem</command:noun> <maml:description> <maml:para>Retrieves work-items from Visual Studio Team Services</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-VstsWorkItem cmdlet retrieves work-items from VSTS.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Id --> <command:syntaxItem> <maml:name>Get-VstsWorkItem</maml:name> <!-- Parameter: Id --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Ids"> <maml:name>Id</maml:name> <maml:description> <maml:para>Id of one or more work-items to retrieve.</maml:para> <maml:para>If you want to retrieve multiple items at once by their id, you can provide a list if id´s to this parameter.</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: AccessToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Personal Access Token (PAT) to login to the VSTS-server. If this is not specified, the access token will be read from the current configuration. The access token cannot be shown using Get-VstsConfiguration, but it is possible to update it by Set-VstsConfiguration. The access token is stored in the windows credential store. In case there is no current access token and the AccessToken argument has not been specified, the cmdlet will prompt for a token.</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>Project name of the Visual Studio Team Services project. If this is not specified, the project will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the project argument has not been specified, the cmdlet will prompt for a 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: Url --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the Visual Studio Team Services instance. If this is not specified, the URL will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the URL argument has not been specified, the cmdlet will prompt for a URL.</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: Build --> <command:syntaxItem> <maml:name>Get-VstsWorkItem</maml:name> <!-- Parameter: AccessToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Personal Access Token (PAT) to login to the VSTS-server. If this is not specified, the access token will be read from the current configuration. The access token cannot be shown using Get-VstsConfiguration, but it is possible to update it by Set-VstsConfiguration. The access token is stored in the windows credential store. In case there is no current access token and the AccessToken argument has not been specified, the cmdlet will prompt for a token.</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: BuildId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BuildId</maml:name> <maml:description> <maml:para>Id of a build to retrieve the associated items from.</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>Project name of the Visual Studio Team Services project. If this is not specified, the project will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the project argument has not been specified, the cmdlet will prompt for a 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: Url --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the Visual Studio Team Services instance. If this is not specified, the URL will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the URL argument has not been specified, the cmdlet will prompt for a URL.</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: Filter --> <command:syntaxItem> <maml:name>Get-VstsWorkItem</maml:name> <!-- Parameter: AccessToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Personal Access Token (PAT) to login to the VSTS-server. If this is not specified, the access token will be read from the current configuration. The access token cannot be shown using Get-VstsConfiguration, but it is possible to update it by Set-VstsConfiguration. The access token is stored in the windows credential store. In case there is no current access token and the AccessToken argument has not been specified, the cmdlet will prompt for a token.</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: AssignedToMe --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AssignedToMe</maml:name> <maml:description> <maml:para>If this is specified, only items which are assigned to the current user (i.e. the user for which the current personal access token was created for) will be 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: CurrentIteration --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CurrentIteration</maml:name> <maml:description> <maml:para>With this switch, only items which are in the current iteration will be 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: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Project name of the Visual Studio Team Services project. If this is not specified, the project will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the project argument has not been specified, the cmdlet will prompt for a 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: RecentlyChanged --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RecentlyChanged</maml:name> <maml:description> <maml:para>With this switch you can specify to only retrieve work-items that have been changed during the last three months.</maml:para> <maml:para>If this is used in combination with the -RecentlyCreated switch, work-items that have been changed OR created in the last three months will be 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: RecentlyCreated --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RecentlyCreated</maml:name> <maml:description> <maml:para>With this switch you can specify to only retrieve work-items that have been created during the last three months.</maml:para> <maml:para>If this is used in combination with the -RecentlyChanged switch, work-items that have been changed OR created in the last three months will be 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: State --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>State</maml:name> <maml:description> <maml:para>State of the work-items to retrieve. You can cycle through the available work-item states via tab-completion, but if the connection to VSTS has not already been established by running another VSTS-cmdlet, it will provide a standard set of states, which could be invalid states for your 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: Type --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>Type of the work-items to retrieve. If the connection to VSTS has already been established by running another VSTS-cmdlet, you can cycle through the available work-item types via tab-completion.</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: Url --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the Visual Studio Team Services instance. If this is not specified, the URL will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the URL argument has not been specified, the cmdlet will prompt for a URL.</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: Id --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Ids"> <maml:name>Id</maml:name> <maml:description> <maml:para>Id of one or more work-items to retrieve.</maml:para> <maml:para>If you want to retrieve multiple items at once by their id, you can provide a list if id´s to this parameter.</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> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Ids"> <maml:name>Ids</maml:name> <maml:description> <maml:para>Id of one or more work-items to retrieve.</maml:para> <maml:para>If you want to retrieve multiple items at once by their id, you can provide a list if id´s to this parameter.</maml:para> <maml:para>This is an alias of the Id parameter.</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: BuildId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BuildId</maml:name> <maml:description> <maml:para>Id of a build to retrieve the associated items from.</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: Type --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>Type of the work-items to retrieve. If the connection to VSTS has already been established by running another VSTS-cmdlet, you can cycle through the available work-item types via tab-completion.</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>State of the work-items to retrieve. You can cycle through the available work-item states via tab-completion, but if the connection to VSTS has not already been established by running another VSTS-cmdlet, it will provide a standard set of states, which could be invalid states for your 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: RecentlyChanged --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RecentlyChanged</maml:name> <maml:description> <maml:para>With this switch you can specify to only retrieve work-items that have been changed during the last three months.</maml:para> <maml:para>If this is used in combination with the -RecentlyCreated switch, work-items that have been changed OR created in the last three months will be 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: RecentlyCreated --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RecentlyCreated</maml:name> <maml:description> <maml:para>With this switch you can specify to only retrieve work-items that have been created during the last three months.</maml:para> <maml:para>If this is used in combination with the -RecentlyChanged switch, work-items that have been changed OR created in the last three months will be 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: AssignedToMe --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AssignedToMe</maml:name> <maml:description> <maml:para>If this is specified, only items which are assigned to the current user (i.e. the user for which the current personal access token was created for) will be 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: CurrentIteration --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CurrentIteration</maml:name> <maml:description> <maml:para>With this switch, only items which are in the current iteration will be 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: Url --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the Visual Studio Team Services instance. If this is not specified, the URL will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the URL argument has not been specified, the cmdlet will prompt for a URL.</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>Project name of the Visual Studio Team Services project. If this is not specified, the project will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the project argument has not been specified, the cmdlet will prompt for a 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: AccessToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Personal Access Token (PAT) to login to the VSTS-server. If this is not specified, the access token will be read from the current configuration. The access token cannot be shown using Get-VstsConfiguration, but it is possible to update it by Set-VstsConfiguration. The access token is stored in the windows credential store. In case there is no current access token and the AccessToken argument has not been specified, the cmdlet will prompt for a token.</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:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-VstsWorkItem</dev:code> <dev:remarks> <maml:para>Returns all work-items in the current project of the current VSTS-instance.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-VstsWorkItem -Type Task -RecentlyChanged</dev:code> <dev:remarks> <maml:para>Returns all work-items of the type "Task" that have been changed in the last three months.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Get-VstsWorkItem -Type Task -CurrentIteration -AssignedToMe</dev:code> <dev:remarks> <maml:para>Returns all work-items of the type "Task" that are in the current iteration and have been assigned to the user for which the personal access token was generated.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\> Get-VstsWorkItem 123</dev:code> <dev:remarks> <maml:para>Returns the work-item with id 123.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 5 ----------</maml:title> <dev:code>PS C:\> Get-VstsWorkItem -BuildId 123</dev:code> <dev:remarks> <maml:para>Returns all work-items associated with the build with id 123.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 6 ----------</maml:title> <dev:code>PS C:\> Get-VstsWorkItem -Url https://fabrikam.visualstudio.com -Project xyz</dev:code> <dev:remarks> <maml:para>Returns all work-items in the project xyz in the VSTS-instance at https://fabrikam.visualstudio.com .</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-VstsWorkItem --> <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"> <command:details> <command:name>New-VstsWorkItem</command:name> <command:verb>New</command:verb> <command:noun>VstsWorkItem</command:noun> <maml:description> <maml:para>Creates a new work-item on Visual Studio Team Services</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-VstsWorkItem cmdlet creates a new work-item.</maml:para> <maml:para>Note that the item will not be created on VSTS as long as it has not been saved using the Save-VstsWorkItem cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-VstsWorkItem</maml:name> <!-- Parameter: Type --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Type</maml:name> <maml:description> <maml:para>Type of the work-item. If the connection to VSTS has already been established by running another VSTS-cmdlet, you can cycle through the available work-item types via tab-completion.</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: AccessToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Personal Access Token (PAT) to login to the VSTS-server. If this is not specified, the access token will be read from the current configuration. The access token cannot be shown using Get-VstsConfiguration, but it is possible to update it by Set-VstsConfiguration. The access token is stored in the windows credential store. In case there is no current access token and the AccessToken argument has not been specified, the cmdlet will prompt for a token.</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>Project name of the Visual Studio Team Services project. If this is not specified, the project will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the project argument has not been specified, the cmdlet will prompt for a 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: Url --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the Visual Studio Team Services instance. If this is not specified, the URL will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the URL argument has not been specified, the cmdlet will prompt for a URL.</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="false" position="0"> <maml:name>Type</maml:name> <maml:description> <maml:para>Type of the work-item. If the connection to VSTS has already been established by running another VSTS-cmdlet, you can cycle through the available work-item types via tab-completion.</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: Url --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the Visual Studio Team Services instance. If this is not specified, the URL will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the URL argument has not been specified, the cmdlet will prompt for a URL.</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>Project name of the Visual Studio Team Services project. If this is not specified, the project will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the project argument has not been specified, the cmdlet will prompt for a 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: AccessToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Personal Access Token (PAT) to login to the VSTS-server. If this is not specified, the access token will be read from the current configuration. The access token cannot be shown using Get-VstsConfiguration, but it is possible to update it by Set-VstsConfiguration. The access token is stored in the windows credential store. In case there is no current access token and the AccessToken argument has not been specified, the cmdlet will prompt for a token.</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:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> New-VstsWorkItem Task</dev:code> <dev:remarks> <maml:para>Creates a new work-item of type "Task".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> New-VstsWorkItem -Type "Product Backlog Item"</dev:code> <dev:remarks> <maml:para>Creates a new work-item of type "Product Backlog Item".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-VstsWorkItem --> <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"> <command:details> <command:name>Remove-VstsWorkItem</command:name> <command:verb>Remove</command:verb> <command:noun>VstsWorkItem</command:noun> <maml:description> <maml:para>Saves the changes on one or more work-items in Visual Studio Team Services</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Save-VstsWorkItems saves work-item changes on VSTS.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-VstsWorkItem</maml:name> <!-- Parameter: Items --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Items</maml:name> <maml:description> <maml:para>A work-item instance or id or multiple instances or id´s to delete from VSTS.</maml:para> </maml:description> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AccessToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Personal Access Token (PAT) to login to the VSTS-server. If this is not specified, the access token will be read from the current configuration. The access token cannot be shown using Get-VstsConfiguration, but it is possible to update it by Set-VstsConfiguration. The access token is stored in the windows credential store. In case there is no current access token and the AccessToken argument has not been specified, the cmdlet will prompt for a token.</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>Project name of the Visual Studio Team Services project. If this is not specified, the project will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the project argument has not been specified, the cmdlet will prompt for a 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: Url --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the Visual Studio Team Services instance. If this is not specified, the URL will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the URL argument has not been specified, the cmdlet will prompt for a URL.</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: Items --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Items</maml:name> <maml:description> <maml:para>A work-item instance or id or multiple instances or id´s to delete from VSTS.</maml:para> </maml:description> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Url --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the Visual Studio Team Services instance. If this is not specified, the URL will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the URL argument has not been specified, the cmdlet will prompt for a URL.</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>Project name of the Visual Studio Team Services project. If this is not specified, the project will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the project argument has not been specified, the cmdlet will prompt for a 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: AccessToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Personal Access Token (PAT) to login to the VSTS-server. If this is not specified, the access token will be read from the current configuration. The access token cannot be shown using Get-VstsConfiguration, but it is possible to update it by Set-VstsConfiguration. The access token is stored in the windows credential store. In case there is no current access token and the AccessToken argument has not been specified, the cmdlet will prompt for a token.</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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A work-item instance or id or multiple instances or id´s to delete from VSTS.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Save-VstsWorkItem $item</dev:code> <dev:remarks> <maml:para>Saves the changes that have been made on the properties of the work-item in $item.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> $items | Save-VstsWorkItem</dev:code> <dev:remarks> <maml:para>Saves the changes that have been made on the properties of all the work-items in $items.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Save-VstsWorkItem $item -Url https://fabrikam.visualstudio.com -Project xyz</dev:code> <dev:remarks> <maml:para>Saves the changes that have been made on the properties of the work-item in $item in the project xyz in the VSTS-instance at https://fabrikam.visualstudio.com .</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Save-VstsWorkItem --> <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"> <command:details> <command:name>Save-VstsWorkItem</command:name> <command:verb>Save</command:verb> <command:noun>VstsWorkItem</command:noun> <maml:description> <maml:para>Saves the changes on one or more work-items in Visual Studio Team Services</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Save-VstsWorkItems saves work-item changes on VSTS.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Save-VstsWorkItem</maml:name> <!-- Parameter: Items --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Items</maml:name> <maml:description> <maml:para>A work-item instance or multiple instances to save the changes for.</maml:para> </maml:description> <command:parameterValue required="true">VstsWorkItem[]</command:parameterValue> <dev:type> <maml:name>PoshVsts.VstsWorkItem[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AccessToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Personal Access Token (PAT) to login to the VSTS-server. If this is not specified, the access token will be read from the current configuration. The access token cannot be shown using Get-VstsConfiguration, but it is possible to update it by Set-VstsConfiguration. The access token is stored in the windows credential store. In case there is no current access token and the AccessToken argument has not been specified, the cmdlet will prompt for a token.</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>Project name of the Visual Studio Team Services project. If this is not specified, the project will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the project argument has not been specified, the cmdlet will prompt for a 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: Url --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the Visual Studio Team Services instance. If this is not specified, the URL will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the URL argument has not been specified, the cmdlet will prompt for a URL.</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: Items --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Items</maml:name> <maml:description> <maml:para>A work-item instance or multiple instances to save the changes for.</maml:para> </maml:description> <command:parameterValue required="true">VstsWorkItem[]</command:parameterValue> <dev:type> <maml:name>PoshVsts.VstsWorkItem[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Url --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the Visual Studio Team Services instance. If this is not specified, the URL will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the URL argument has not been specified, the cmdlet will prompt for a URL.</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>Project name of the Visual Studio Team Services project. If this is not specified, the project will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the project argument has not been specified, the cmdlet will prompt for a 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: AccessToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Personal Access Token (PAT) to login to the VSTS-server. If this is not specified, the access token will be read from the current configuration. The access token cannot be shown using Get-VstsConfiguration, but it is possible to update it by Set-VstsConfiguration. The access token is stored in the windows credential store. In case there is no current access token and the AccessToken argument has not been specified, the cmdlet will prompt for a token.</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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PoshVsts.VstsWorkItem[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A work-item instance or multiple instances to save the changes for.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Save-VstsWorkItem $item</dev:code> <dev:remarks> <maml:para>Saves the changes that have been made on the properties of the work-item in $item.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> $items | Save-VstsWorkItem</dev:code> <dev:remarks> <maml:para>Saves the changes that have been made on the properties of all the work-items in $items.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Save-VstsWorkItem $item -Url https://fabrikam.visualstudio.com -Project xyz</dev:code> <dev:remarks> <maml:para>Saves the changes that have been made on the properties of the work-item in $item in the project xyz in the VSTS-instance at https://fabrikam.visualstudio.com .</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-VstsWorkItemHistory --> <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"> <command:details> <command:name>Get-VstsWorkItemHistory</command:name> <command:verb>Get</command:verb> <command:noun>VstsWorkItemHistory</command:noun> <maml:description> <maml:para>Returns the change history of a work-item in Visual Studio Team Services</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-VstsWorkItemHistory returns the work-item change history from on VSTS.</maml:para> <maml:para>Note that changes of some of the fields, like Backlog-Priority, BoardColumn and Reason are not returned. If you want to see changes for these fields, add the -All switch-parameter.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-VstsWorkItemHistory</maml:name> <!-- Parameter: Item --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Item</maml:name> <maml:description> <maml:para>A work-item instance or id to get the 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: AccessToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Personal Access Token (PAT) to login to the VSTS-server. If this is not specified, the access token will be read from the current configuration. The access token cannot be shown using Get-VstsConfiguration, but it is possible to update it by Set-VstsConfiguration. The access token is stored in the windows credential store. In case there is no current access token and the AccessToken argument has not been specified, the cmdlet will prompt for a token.</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: All --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>All</maml:name> <maml:description> <maml:para>The changes of some of the fields, like Backlog-Priority, BoardColumn and Reason are not returned. Use this switch to include these changes.</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>Project name of the Visual Studio Team Services project. If this is not specified, the project will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the project argument has not been specified, the cmdlet will prompt for a 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: Url --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the Visual Studio Team Services instance. If this is not specified, the URL will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the URL argument has not been specified, the cmdlet will prompt for a URL.</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: Item --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Item</maml:name> <maml:description> <maml:para>A work-item instance or id to get the 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: All --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>All</maml:name> <maml:description> <maml:para>The changes of some of the fields, like Backlog-Priority, BoardColumn and Reason are not returned. Use this switch to include these changes.</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: Url --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the Visual Studio Team Services instance. If this is not specified, the URL will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the URL argument has not been specified, the cmdlet will prompt for a URL.</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>Project name of the Visual Studio Team Services project. If this is not specified, the project will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the project argument has not been specified, the cmdlet will prompt for a 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: AccessToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Personal Access Token (PAT) to login to the VSTS-server. If this is not specified, the access token will be read from the current configuration. The access token cannot be shown using Get-VstsConfiguration, but it is possible to update it by Set-VstsConfiguration. The access token is stored in the windows credential store. In case there is no current access token and the AccessToken argument has not been specified, the cmdlet will prompt for a token.</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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A work-item instance or id to get the history from.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-VstsWorkItemHistory 123</dev:code> <dev:remarks> <maml:para>Returns the history for the work-item with id 123.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> $item | Get-VstsWorkItemHistory -All</dev:code> <dev:remarks> <maml:para>Returns the history for the work-item in $item including the changes for all fields.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Get-VstsWorkItemHistory $item</dev:code> <dev:remarks> <maml:para>Returns the history for the work-item in $item.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\> Get-VstsWorkItemHistory 123 -Url https://fabrikam.visualstudio.com -Project xyz</dev:code> <dev:remarks> <maml:para>Returns the history for the work-item with id 123 in the project xyz in the VSTS-instance at https://fabrikam.visualstudio.com .</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-VstsWorkItemState --> <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"> <command:details> <command:name>Get-VstsWorkItemState</command:name> <command:verb>Get</command:verb> <command:noun>VstsWorkItemState</command:noun> <maml:description> <maml:para>Returns all work-item states from Visual Studio Team Services</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-VstsWorkItemState returns all available work-item states from VSTS.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-VstsWorkItemState</maml:name> <!-- Parameter: AccessToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Personal Access Token (PAT) to login to the VSTS-server. If this is not specified, the access token will be read from the current configuration. The access token cannot be shown using Get-VstsConfiguration, but it is possible to update it by Set-VstsConfiguration. The access token is stored in the windows credential store. In case there is no current access token and the AccessToken argument has not been specified, the cmdlet will prompt for a token.</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>Project name of the Visual Studio Team Services project. If this is not specified, the project will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the project argument has not been specified, the cmdlet will prompt for a 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: Url --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the Visual Studio Team Services instance. If this is not specified, the URL will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the URL argument has not been specified, the cmdlet will prompt for a URL.</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: Url --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the Visual Studio Team Services instance. If this is not specified, the URL will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the URL argument has not been specified, the cmdlet will prompt for a URL.</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>Project name of the Visual Studio Team Services project. If this is not specified, the project will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the project argument has not been specified, the cmdlet will prompt for a 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: AccessToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Personal Access Token (PAT) to login to the VSTS-server. If this is not specified, the access token will be read from the current configuration. The access token cannot be shown using Get-VstsConfiguration, but it is possible to update it by Set-VstsConfiguration. The access token is stored in the windows credential store. In case there is no current access token and the AccessToken argument has not been specified, the cmdlet will prompt for a token.</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:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-VstsWorkItemState</dev:code> <dev:remarks> <maml:para>Returns all work-item states from the work-items in the current project on the current VSTS-instance.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-VstsWorkItemState -Url https://fabrikam.visualstudio.com -Project xyz</dev:code> <dev:remarks> <maml:para>Returns all work-item states in the project xyz in the VSTS-instance at https://fabrikam.visualstudio.com .</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-VstsWorkItemType --> <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"> <command:details> <command:name>Get-VstsWorkItemType</command:name> <command:verb>Get</command:verb> <command:noun>VstsWorkItemType</command:noun> <maml:description> <maml:para>Returns all work-item types from Visual Studio Team Services</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-VstsWorkItemType returns all available work-item types from VSTS.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-VstsWorkItemType</maml:name> <!-- Parameter: AccessToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Personal Access Token (PAT) to login to the VSTS-server. If this is not specified, the access token will be read from the current configuration. The access token cannot be shown using Get-VstsConfiguration, but it is possible to update it by Set-VstsConfiguration. The access token is stored in the windows credential store. In case there is no current access token and the AccessToken argument has not been specified, the cmdlet will prompt for a token.</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>Project name of the Visual Studio Team Services project. If this is not specified, the project will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the project argument has not been specified, the cmdlet will prompt for a 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: Url --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the Visual Studio Team Services instance. If this is not specified, the URL will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the URL argument has not been specified, the cmdlet will prompt for a URL.</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: Url --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the Visual Studio Team Services instance. If this is not specified, the URL will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the URL argument has not been specified, the cmdlet will prompt for a URL.</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>Project name of the Visual Studio Team Services project. If this is not specified, the project will be read from the current configuration, which can be shown using Get-VstsConfiguration and update by Set-VstsConfiguration. The configuration is stored in a file named '.poshVsts' the user directory. In case there is no current configuration and the project argument has not been specified, the cmdlet will prompt for a 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: AccessToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Personal Access Token (PAT) to login to the VSTS-server. If this is not specified, the access token will be read from the current configuration. The access token cannot be shown using Get-VstsConfiguration, but it is possible to update it by Set-VstsConfiguration. The access token is stored in the windows credential store. In case there is no current access token and the AccessToken argument has not been specified, the cmdlet will prompt for a token.</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:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-VstsWorkItemType</dev:code> <dev:remarks> <maml:para>Returns all work-item types from the work-items in the current project on the current VSTS-instance.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-VstsWorkItemType -Url https://fabrikam.visualstudio.com -Project xyz</dev:code> <dev:remarks> <maml:para>Returns all work-item types in the project xyz in the VSTS-instance at https://fabrikam.visualstudio.com .</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> </helpItems> |