TFSPowershell

0.4.0

MAML/TFSPowershell.ServiceEndpoint.Help.xml

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

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

<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">

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

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

<command:noun>ServiceEndpoints</command:noun>

<maml:description><maml:para>Gets the service enpoints for a given Team Project.

</maml:para>

</maml:description>

</command:details>

<maml:description><maml:para>Gets the service enpoints for a given Team Project.

</maml:para>

</maml:description>

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

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

<maml:Description><maml:para>The TeamProjectCollection URL. Ex.: https://tfs2015.local/tfs/defaultcollection.

</maml:para>

</maml:Description>

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

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

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

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

</command:parameter>

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

<maml:Description><maml:para>The Team Project name.

</maml:para>

</maml:Description>

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

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

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

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

</command:parameter>

</command:syntaxItem>

</command:syntax>

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

<maml:Description><maml:para>The TeamProjectCollection URL. Ex.: https://tfs2015.local/tfs/defaultcollection.

</maml:para>

</maml:Description>

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

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

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

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

</command:parameter>

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

<maml:Description><maml:para>The Team Project name.

</maml:para>

</maml:Description>

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

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

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

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

</command:parameter>

</command:parameters>

<command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name>

</dev:type>

<maml:description><maml:para>

</maml:para>

</maml:description>

</command:inputType>

</command:inputTypes>

<command:returnValues><command:returnValue><dev:type><maml:name>System.Object</maml:name>

</dev:type>

<maml:description><maml:para>

</maml:para>

</maml:description>

</command:returnValue>

</command:returnValues>

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

</maml:para>

</maml:alert>

</maml:alertSet>

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

<dev:code>PS C:\&gt; Get-ServiceEndpoints -CollectionUrl https://myvisual.visualstudio.com -TeamProject myTeamproject</dev:code>

<dev:remarks><maml:para>

</maml:para>

</dev:remarks>

</command:example>

</command:examples>

<command:relatedLinks></command:relatedLinks>

</command:command>

<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">

<command:details><command:name>New-ServiceEndpoint</command:name>

<command:verb>New</command:verb>

<command:noun>ServiceEndpoint</command:noun>

<maml:description><maml:para>Creates a new service endpoint.

</maml:para>

</maml:description>

</command:details>

<maml:description><maml:para>Creates a new service endpoint.

</maml:para>

</maml:description>

<command:syntax><command:syntaxItem><maml:name>New-ServiceEndpoint</maml:name>

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

<maml:Description><maml:para>The TeamProjectCollection URL. Ex.: https://tfs2015.local/tfs/defaultcollection.

</maml:para>

</maml:Description>

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

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

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

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

</command:parameter>

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

<maml:Description><maml:para>The Team Project name.

</maml:para>

</maml:Description>

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

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

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

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

</command:parameter>

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

<maml:Description><maml:para>A JSON string with the new endpoint data. See above an example for the string. More details here (https://www.visualstudio.com/en-us/docs/integrate/api/endpoints/endpoints#create-a-service-endpoint).

</maml:para>

</maml:Description>

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

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

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

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

</command:parameter>

</command:syntaxItem>

</command:syntax>

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

<maml:Description><maml:para>The TeamProjectCollection URL. Ex.: https://tfs2015.local/tfs/defaultcollection.

</maml:para>

</maml:Description>

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

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

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

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

</command:parameter>

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

<maml:Description><maml:para>A JSON string with the new endpoint data. See above an example for the string. More details here (https://www.visualstudio.com/en-us/docs/integrate/api/endpoints/endpoints#create-a-service-endpoint).

</maml:para>

</maml:Description>

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

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

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

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

</command:parameter>

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

<maml:Description><maml:para>The Team Project name.

</maml:para>

</maml:Description>

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

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

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

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

</command:parameter>

</command:parameters>

<command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name>

</dev:type>

<maml:description><maml:para>

</maml:para>

</maml:description>

</command:inputType>

</command:inputTypes>

<command:returnValues><command:returnValue><dev:type><maml:name>System.Object</maml:name>

</dev:type>

<maml:description><maml:para>

</maml:para>

</maml:description>

</command:returnValue>

</command:returnValues>

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

</maml:para>

</maml:alert>

</maml:alertSet>

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

<dev:code>PS C:\&gt; New-ServiceEndpoint -CollectionUrl https://tfs2015.local/tfs/defaultcollection -TeamProjectName MyTeamProjet -NewEndPointJson $endpointJsonString

$endpointJsonString = @"

{

  "name": "SonarQube",

  "type": "sonarqube",

  "url": "https://mysonarqubeserver:9000",

  "authorization": {

    "scheme": "UsernamePassword",

    "parameters": {

      "username": "someUsername",

      "password": "sonarqubetoken"

    }

  }

}

"@</dev:code>

<dev:remarks><maml:para>

</maml:para>

</dev:remarks>

</command:example>

</command:examples>

<command:relatedLinks></command:relatedLinks>

</command:command>

</helpItems>