EN-US/AzdoAPITools-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <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>Convert-AzDoAPIToolsYamlObjectToYAMLFile</command:name> <command:verb>Convert</command:verb> <command:noun>AzDoAPIToolsYamlObjectToYAMLFile</command:noun> <maml:description> <maml:para>Converts a YAML PSOBject to YAML using Powershell-YAML and outs to a UTF-8 yml file</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Converts a YAML PSOBject to YAML using Powershell-YAML and outs to a UTF-8 yml file</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Convert-AzDoAPIToolsYamlObjectToYAMLFile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>InputObject</maml:name> <maml:Description> <maml:para>Object which is YAMLPrepped and needs conversion.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</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>outputpath</maml:name> <maml:Description> <maml:para>String path name where you want the yml file to be written to.</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>Outputfilename</maml:name> <maml:Description> <maml:para>String filename to use including extension to write.</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>InputObject</maml:name> <maml:Description> <maml:para>Object which is YAMLPrepped and needs conversion.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</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>Outputfilename</maml:name> <maml:Description> <maml:para>String filename to use including extension to write.</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>outputpath</maml:name> <maml:Description> <maml:para>String path name where you want the yml file to be written to.</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:\> Convert-AzDoAPIToolsYamlObjectToYAMLFile -InputObject $objectToConvert -outputpath 'C:\OutPutPathToUse' -Outputfilename 'FileNameToUse.yml'</dev:code> <dev:remarks> <maml:para>This Example will convert the $ObjectToConvert to YAML notation and output it to C:\OutPutPathToUse\FileNameToUse.yml. If the path does not exist it will prompt to create it for you.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzDoAPIToolsDefinitionAsYAMLPrepped</command:name> <command:verb>Get</command:verb> <command:noun>AzDoAPIToolsDefinitionAsYAMLPrepped</command:noun> <maml:description> <maml:para>Returns a YAML Prepped PSObject or yml file with all the elements of a YAML pipeline based on a(n Array) of Build Definitions.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This function takes one or more Build Definition where metadata is present from `Get-AzDoAPIToolsDefinitionsTaskGroupsByNamesList` or `Get-AzDoAPIToolsDefinitionsTaskGroupsByID` and prepares all elements in it for conversion to a YAML Pipeline. if chosen it will output each build definition to a seperate yml file.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzDoAPIToolsDefinitionAsYAMLPrepped</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>DefinitionsToConvert</maml:name> <maml:Description> <maml:para>Array of Build Definitions with MetaData to be converted to YAML Pipelines</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Array</command:parameterValue> <dev:type> <maml:name>Array</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>Projectname</maml:name> <maml:Description> <maml:para>The project to use to call the AzDo API. Should be the same as the project used to add Metadata / retrieve the Build Definitions.</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="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>profilename</maml:name> <maml:Description> <maml:para>Optional parameter to target a specific alias inside the config.json to use as a connection to AzDo. The -ProjectName provided should be accessible from this profile.</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="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>OutputPath</maml:name> <maml:Description> <maml:para>If Specified will write to this path when -OutPutAsFile is used. If the specified path does not exist you will be prompted to have it created.</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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExpandNestedTaskGroups</maml:name> <maml:Description> <maml:para>Switch to determine whether or not to expand found Task Groups or to call them as templates.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Outputasfile</maml:name> <maml:Description> <maml:para>Switch to specify the output has to written to a file. When used also specify -OutPutPath. If not used the function will return a PSObject instead.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</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>DefinitionsToConvert</maml:name> <maml:Description> <maml:para>Array of Build Definitions with MetaData to be converted to YAML Pipelines</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExpandNestedTaskGroups</maml:name> <maml:Description> <maml:para>Switch to determine whether or not to expand found Task Groups or to call them as templates.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>OutputPath</maml:name> <maml:Description> <maml:para>If Specified will write to this path when -OutPutAsFile is used. If the specified path does not exist you will be prompted to have it created.</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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Outputasfile</maml:name> <maml:Description> <maml:para>Switch to specify the output has to written to a file. When used also specify -OutPutPath. If not used the function will return a PSObject instead.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Projectname</maml:name> <maml:Description> <maml:para>The project to use to call the AzDo API. Should be the same as the project used to add Metadata / retrieve the Build Definitions.</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="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>profilename</maml:name> <maml:Description> <maml:para>Optional parameter to target a specific alias inside the config.json to use as a connection to AzDo. The -ProjectName provided should be accessible from this profile.</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:\> Get-AzDoAPIToolsDefinitionAsYAMLPrepped -DefinitionsToConvert $ArrayOfBuildDefinitions -Projectname 'YourAzDoProject'</dev:code> <dev:remarks> <maml:para>Will Take The definitions specified in $ArrayOfBuildDefinitions and for each definition will extract all elements from a Build Definition and converts them to a YAML ready PSObject. It will do this for the specified -Projectname on AzDo. Task Groups found in Build Definition steps will be converted to a template call.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-AzDoAPIToolsDefinitionAsYAMLPrepped -DefinitionsToConvert $ArrayOfBuildDefinitions -Projectname 'YourAzDoProject' -Profilename 'Alternative Alias in config.json'</dev:code> <dev:remarks> <maml:para>Will Take The definitions specified in $ArrayOfBuildDefinitions and for each definition will extract all elements from a Build Definition and converts them to a YAML ready PSObject. It will do this for the specified -Projectname on AzDo. Task Groups found in Build Definition steps will be converted to a template call. Will use the Connection details specified in -profilename rather than the first entry in config.json.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Get-AzDoAPIToolsDefinitionAsYAMLPrepped -DefinitionsToConvert $ArrayOfBuildDefinitions -Projectname 'YourAzDoProject' -ExpandNestedTaskGroups</dev:code> <dev:remarks> <maml:para>Will Take The definitions specified in $ArrayOfBuildDefinitions and for each definition will extract all elements from a Build Definition and converts them to a YAML ready PSObject. It will do this for the specified -Projectname on AzDo. Task Groups found in Build Definition steps will be iterated over and expanded as seperate steps in the converted Build Definition.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>PS C:\> Get-AzDoAPIToolsDefinitionAsYAMLPrepped -DefinitionsToConvert $ArrayOfBuildDefinitions -Projectname 'YourAzDoProject' -ExpandNestedTaskGroups -OutputAsFile -OutPutPath 'C:\OutPut'</dev:code> <dev:remarks> <maml:para>Will Take The definitions specified in $ArrayOfBuildDefinitions and for each definition will extract all elements from a Build Definition and converts them to a yml file called BuildDefinitionName.yml inside C:\OutPut. It will do this for the specified -Projectname on AzDo. Task Groups found in Build Definition steps will be iterated over and expanded as seperate steps in the converted Build Definition.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzDoAPIToolsDefinitionSchedulesAsYAMLPrepped</command:name> <command:verb>Get</command:verb> <command:noun>AzDoAPIToolsDefinitionSchedulesAsYAMLPrepped</command:noun> <maml:description> <maml:para>Returns a YAML Prepped PSObject with the schedules of a YAML pipeline based on a(n Array) of Build Definitions</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This function takes one or more Build Definition where metadata is present from `Get-AzDoAPIToolsDefinitionsTaskGroupsByNamesList` or `Get-AzDoAPIToolsDefinitionsTaskGroupsByID` and extracts the schedules from it and prepare it for conversion use in a YAML Pipeline. If desired use `Convert-AzDoAPIToolsYamlObjectToYAMLFile` to convert the extracted elements to a seperate yml file.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzDoAPIToolsDefinitionSchedulesAsYAMLPrepped</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>InputDefinitions</maml:name> <maml:Description> <maml:para>Array of Build Definitions with MetaData to be converted to YAML Pipelines</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Array</command:parameterValue> <dev:type> <maml:name>Array</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>InputDefinitions</maml:name> <maml:Description> <maml:para>Array of Build Definitions with MetaData to be converted to YAML Pipelines</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Array</command:parameterValue> <dev:type> <maml:name>Array</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:\> Get-AzDoAPIToolsDefinitionSchedulesAsYAMLPrepped -InputDefinitions $ArrayOfBuildDefinitions</dev:code> <dev:remarks> <maml:para>Will Take The definitions specified in $ArrayOfBuildDefinitions and for each definition will extract the schedule elements from a Build Definition and converts them to a YAML ready PSObject.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzDoAPIToolsDefinitionsTaskGroupsByID</command:name> <command:verb>Get</command:verb> <command:noun>AzDoAPIToolsDefinitionsTaskGroupsByID</command:noun> <maml:description> <maml:para>Returns a Build / Release Definition or Task Group by its ID with added metadata for easy use</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns a Build / Release Definition or Task Group by its ID with added metadata for easy use. For Task Groups it has control over preview, version and drafts.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzDoAPIToolsDefinitionsTaskGroupsByID</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ID</maml:name> <maml:Description> <maml:para>ID of the Build / Release definition or Task Group to lookup. for Build / Release definitions expects an integer and for Task Groups a GUID.</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="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>TGVersion</maml:name> <maml:Description> <maml:para>Used in combination with -APIType TaskGroup. Specifies a specific version to return for the given Task Group.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Projectname</maml:name> <maml:Description> <maml:para>The project to use to call the AzDo API. Should be the same as the project used to add Metadata / retrieve the Build Definitions.</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="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>profilename</maml:name> <maml:Description> <maml:para>Optional parameter to target a specific alias inside the config.json to use as a connection to AzDo. The -ProjectName provided should be accessible from this profile.</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="4" aliases="none"> <maml:name>ApiType</maml:name> <maml:Description> <maml:para>Specifies what API to call. Knows BuildDefinition, ReleaseDefinition and TaskGroup as accepted values.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">BuildDefinition</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ReleaseDefinition</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">TaskGroup</command:parameterValue> </command:parameterValueGroup> <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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AllTGVersions</maml:name> <maml:Description> <maml:para>Switch to have the function return all versions of a Task Group given. Will only work for APIType 'TaskGroup'. If ommitted it will by default return the highest found version of the Task Group</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>includeTGdrafts</maml:name> <maml:Description> <maml:para>If this switch is used it will include any Task Groups which are in Draft State. If you have specified a Draft ID and not use this switch your result will be null.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>includeTGpreview</maml:name> <maml:Description> <maml:para>If this switch is used the results of the function will include previews of a task group. This might affect the Highest version returned from a task group.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AllTGVersions</maml:name> <maml:Description> <maml:para>Switch to have the function return all versions of a Task Group given. Will only work for APIType 'TaskGroup'. If ommitted it will by default return the highest found version of the Task Group</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>ApiType</maml:name> <maml:Description> <maml:para>Specifies what API to call. Knows BuildDefinition, ReleaseDefinition and TaskGroup as accepted values.</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="0" aliases="none"> <maml:name>ID</maml:name> <maml:Description> <maml:para>ID of the Build / Release definition or Task Group to lookup. for Build / Release definitions expects an integer and for Task Groups a GUID.</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>Projectname</maml:name> <maml:Description> <maml:para>The project to use to call the AzDo API. Should be the same as the project used to add Metadata / retrieve the Build Definitions.</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="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>TGVersion</maml:name> <maml:Description> <maml:para>Used in combination with -APIType TaskGroup. Specifies a specific version to return for the given Task Group.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>includeTGdrafts</maml:name> <maml:Description> <maml:para>If this switch is used it will include any Task Groups which are in Draft State. If you have specified a Draft ID and not use this switch your result will be null.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>includeTGpreview</maml:name> <maml:Description> <maml:para>If this switch is used the results of the function will include previews of a task group. This might affect the Highest version returned from a task group.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>profilename</maml:name> <maml:Description> <maml:para>Optional parameter to target a specific alias inside the config.json to use as a connection to AzDo. The -ProjectName provided should be accessible from this profile.</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:\> Get-AzDoAPIToolsDefinitionsTaskGroupsByID -ID $ID -APIType 'BuildDefinition' -Projectname 'YourAzDoProject'</dev:code> <dev:remarks> <maml:para>Will look for Build Definition with ID $ID in the Azure DevOps Project 'YourAzDoProject' The result will be a PSObject with the build definition along with some additional metdata.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-AzDoAPIToolsDefinitionsTaskGroupsByID -ID $ID -APIType 'BuildDefinition' -Projectname 'YourAzDoProject' -Profilename 'Alternative Alias in config.json'</dev:code> <dev:remarks> <maml:para>Will look for Build Definition with ID $ID in the Azure DevOps Project 'YourAzDoProject' The result will be a PSObject with the build definition along with some additional metdata. Will use the Connection details specified in -profilename rather than the first entry in config.json.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Get-AzDoAPIToolsDefinitionsTaskGroupsByID -ID $ID -APIType 'ReleaseDefinition' -Projectname 'YourAzDoProject'</dev:code> <dev:remarks> <maml:para>Will look for Release Definition with ID $ID in the Azure DevOps Project 'YourAzDoProject' The result will be a PSObject with the Release definition along with some additional metdata. EXPERIMENTAL FEATURE!!!</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>PS C:\> Get-AzDoAPIToolsDefinitionsTaskGroupsByID -ID $ID -APIType 'TaskGroup' -Projectname 'YourAzDoProject'</dev:code> <dev:remarks> <maml:para>Will look for Task Group with GUID $ID in the Azure DevOps Project 'YourAzDoProject' The result will be a PSObject with the highest version non draft non preview Task Group along with some additional metdata.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>PS C:\> Get-AzDoAPIToolsDefinitionsTaskGroupsByID -ID $ID -APIType 'TaskGroup' -Projectname 'YourAzDoProject' -TGVersion 2</dev:code> <dev:remarks> <maml:para>Will look for Task Group with GUID $ID and version 2 in the Azure DevOps Project 'YourAzDoProject' The result will be a PSObject with the Task Group version 2 along with some additional metdata.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 6 --------------------------</maml:title> <dev:code>PS C:\> Get-AzDoAPIToolsDefinitionsTaskGroupsByID -ID $ID -APIType 'TaskGroup' -Projectname 'YourAzDoProject' -AllTGVersions</dev:code> <dev:remarks> <maml:para>Will look for Task Group with GUID $ID in the Azure DevOps Project 'YourAzDoProject' The result will be a PSObject with the Task Group and all its non-draft non-preview versions along with some additional metdata.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 7 --------------------------</maml:title> <dev:code>PS C:\> Get-AzDoAPIToolsDefinitionsTaskGroupsByID -ID $ID -APIType 'TaskGroup' -Projectname 'YourAzDoProject' -AllTGVersions -includeTGdrafts -includeTGpreview</dev:code> <dev:remarks> <maml:para>Will look for Task Group with GUID $ID in the Azure DevOps Project 'YourAzDoProject' The result will be a PSObject with the Task Group and all its draft and preview versions along with some additional metdata.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 8 --------------------------</maml:title> <dev:code>PS C:\> Get-AzDoAPIToolsDefinitionsTaskGroupsByID -ID $ID -APIType 'TaskGroup' -Projectname 'YourAzDoProject' -includeTGpreview</dev:code> <dev:remarks> <maml:para>Will look for Task Group with GUID $ID in the Azure DevOps Project 'YourAzDoProject' The result will be a PSObject with the highest version non-draft and with previews of the Task Group along with some additional metdata.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 9 --------------------------</maml:title> <dev:code>PS C:\> Get-AzDoAPIToolsDefinitionsTaskGroupsByID -ID $ID -APIType 'TaskGroup' -Projectname 'YourAzDoProject' -includeTGdrafts</dev:code> <dev:remarks> <maml:para>Will look for Task Group with GUID $ID in the Azure DevOps Project 'YourAzDoProject' The result will be a PSObject with the highest version draft non-preview of the Task Group along with some additional metdata.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzDoAPIToolsDefinitionsTaskGroupsByNamesList</command:name> <command:verb>Get</command:verb> <command:noun>AzDoAPIToolsDefinitionsTaskGroupsByNamesList</command:noun> <maml:description> <maml:para>Returns an array of Build / Release Definition or Task Group by an array of names with added metadata for easy use</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns a Build / Release Definition or Task Group by an array of names with added metadata for easy use. For Task Groups it has control over preview, version and drafts.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzDoAPIToolsDefinitionsTaskGroupsByNamesList</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>NamesList</maml:name> <maml:Description> <maml:para>Array of names to look for in Build / Release Definitions or Task Groups.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Array</command:parameterValue> <dev:type> <maml:name>Array</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>Projectname</maml:name> <maml:Description> <maml:para>The project to use to call the AzDo API. Should be the same as the project used to add Metadata / retrieve the Build Definitions.</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="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>profilename</maml:name> <maml:Description> <maml:para>Optional parameter to target a specific alias inside the config.json to use as a connection to AzDo. The -ProjectName provided should be accessible from this profile.</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="3" aliases="none"> <maml:name>ApiType</maml:name> <maml:Description> <maml:para>Specifies what API to call. Knows BuildDefinition, ReleaseDefinition and TaskGroup as accepted values.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">BuildDefinition</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ReleaseDefinition</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">TaskGroup</command:parameterValue> </command:parameterValueGroup> <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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AllTGVersions</maml:name> <maml:Description> <maml:para>Switch to have the function return all versions of a Task Group given. Will only work for APIType 'TaskGroup'. If ommitted it will by default return the highest found version of the Task Group.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>includeTGdrafts</maml:name> <maml:Description> <maml:para>If this switch is used it will include any Task Groups which are in Draft State. If you have specified a Draft ID and not use this switch your result will be null.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>includeTGpreview</maml:name> <maml:Description> <maml:para>If this switch is used the results of the function will include previews of a task group. This might affect the Highest version returned from a task group.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AllTGVersions</maml:name> <maml:Description> <maml:para>Switch to have the function return all versions of a Task Group given. Will only work for APIType 'TaskGroup'. If ommitted it will by default return the highest found version of the Task Group.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>ApiType</maml:name> <maml:Description> <maml:para>Specifies what API to call. Knows BuildDefinition, ReleaseDefinition and TaskGroup as accepted values.</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="0" aliases="none"> <maml:name>NamesList</maml:name> <maml:Description> <maml:para>Array of names to look for in Build / Release Definitions or Task Groups.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Array</command:parameterValue> <dev:type> <maml:name>Array</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>Projectname</maml:name> <maml:Description> <maml:para>The project to use to call the AzDo API. Should be the same as the project used to add Metadata / retrieve the Build Definitions.</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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>includeTGdrafts</maml:name> <maml:Description> <maml:para>If this switch is used it will include any Task Groups which are in Draft State. If you have specified a Draft ID and not use this switch your result will be null.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>includeTGpreview</maml:name> <maml:Description> <maml:para>If this switch is used the results of the function will include previews of a task group. This might affect the Highest version returned from a task group.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>profilename</maml:name> <maml:Description> <maml:para>Optional parameter to target a specific alias inside the config.json to use as a connection to AzDo. The -ProjectName provided should be accessible from this profile.</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:\> Get-AzDoAPIToolsDefinitionsTaskGroupsByNamesList -NamesList $nameslist -APIType 'BuildDefinition' -Projectname 'YourAzDoProject'</dev:code> <dev:remarks> <maml:para>Will look for Build Definitions with names found in $nameslist in the Azure DevOps Project 'YourAzDoProject' The result will be a PSObject with the build definition along with some additional metdata.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-AzDoAPIToolsDefinitionsTaskGroupsByNamesList -NamesList $nameslist -APIType 'BuildDefinition' -Projectname 'YourAzDoProject' -Profilename 'Alternative Alias in config.json'</dev:code> <dev:remarks> <maml:para>Will look for Build Definitions with names found in $nameslist in the Azure DevOps Project 'YourAzDoProject' The result will be a PSObject with the build definition along with some additional metdata. Will use the Connection details specified in -profilename rather than the first entry in config.json.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Get-AzDoAPIToolsDefinitionsTaskGroupsByNamesList -NamesList $nameslist -APIType 'ReleaseDefinition' -Projectname 'YourAzDoProject'</dev:code> <dev:remarks> <maml:para>Will look for Release Definitions with names found in $nameslist in the Azure DevOps Project 'YourAzDoProject' The result will be a PSObject with the Release definition along with some additional metdata. EXPERIMENTAL FEATURE!!!</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>PS C:\> Get-AzDoAPIToolsDefinitionsTaskGroupsByNamesList -NamesList $nameslist -APIType 'TaskGroup' -Projectname 'YourAzDoProject'</dev:code> <dev:remarks> <maml:para>Will look for Task Groups with names found in $nameslist in the Azure DevOps Project 'YourAzDoProject' The result will be a PSObject with the highest version non draft non preview Task Group along with some additional metdata.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>PS C:\> Get-AzDoAPIToolsDefinitionsTaskGroupsByNamesList -NamesList $nameslist -APIType 'TaskGroup' -Projectname 'YourAzDoProject' -AllTGVersions</dev:code> <dev:remarks> <maml:para>Will look for Task Groups with names found in $nameslist in the Azure DevOps Project 'YourAzDoProject' The result will be a PSObject with the Task Group and all its non-draft non-preview versions along with some additional metdata.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 6 --------------------------</maml:title> <dev:code>PS C:\> Get-AzDoAPIToolsDefinitionsTaskGroupsByNamesList -NamesList $nameslist -APIType 'TaskGroup' -Projectname 'YourAzDoProject' -AllTGVersions -includeTGdrafts -includeTGpreview</dev:code> <dev:remarks> <maml:para>Will look for Task Groups with names found in $nameslist in the Azure DevOps Project 'YourAzDoProject' The result will be a PSObject with the Task Group and all its draft and preview versions along with some additional metdata.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 7 --------------------------</maml:title> <dev:code>PS C:\> Get-AzDoAPIToolsDefinitionsTaskGroupsByNamesList -NamesList $nameslist -APIType 'TaskGroup' -Projectname 'YourAzDoProject' -includeTGpreview</dev:code> <dev:remarks> <maml:para>Will look for Task Groups with names found in $nameslist in the Azure DevOps Project 'YourAzDoProject' The result will be a PSObject with the highest version non-draft and with previews of the Task Group along with some additional metdata.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 8 --------------------------</maml:title> <dev:code>PS C:\> Get-AzDoAPIToolsDefinitionsTaskGroupsByNamesList -NamesList $nameslist -APIType 'TaskGroup' -Projectname 'YourAzDoProject' -includeTGdrafts</dev:code> <dev:remarks> <maml:para>Will look for Task Groups with names found in $nameslist in the Azure DevOps Project 'YourAzDoProject' The result will be a PSObject with the highest version draft non-preview of the Task Group along with some additional metdata.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzDoAPIToolsDefinitionStepsAsYAMLPrepped</command:name> <command:verb>Get</command:verb> <command:noun>AzDoAPIToolsDefinitionStepsAsYAMLPrepped</command:noun> <maml:description> <maml:para>Returns a YAML Prepped PSObject with the steps of a YAML pipeline based on a(n Array) of Build Definitions</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This function takes one or more Build Definition where metadata is present from `Get-AzDoAPIToolsDefinitionsTaskGroupsByNamesList` or `Get-AzDoAPIToolsDefinitionsTaskGroupsByID` and extracts the schedules from it and prepare it for conversion use in a YAML Pipeline. If desired use `Convert-AzDoAPIToolsYamlObjectToYAMLFile` to convert the extracted elements to a seperate yml file.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzDoAPIToolsDefinitionStepsAsYAMLPrepped</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>InputDefinitions</maml:name> <maml:Description> <maml:para>Array of Build Definitions with MetaData to be converted to YAML Pipelines</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Array</command:parameterValue> <dev:type> <maml:name>Array</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>Projectname</maml:name> <maml:Description> <maml:para>The project to use to call the AzDo API. Should be the same as the project used to add Metadata / retrieve the Build Definitions.</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="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>profilename</maml:name> <maml:Description> <maml:para>Optional parameter to target a specific alias inside the config.json to use as a connection to AzDo. The -ProjectName provided should be accessible from this profile.</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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExpandNestedTaskGroups</maml:name> <maml:Description> <maml:para>Switch to determine whether or not to expand found Task Groups or to call them as templates.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExpandNestedTaskGroups</maml:name> <maml:Description> <maml:para>Switch to determine whether or not to expand found Task Groups or to call them as templates.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>InputDefinitions</maml:name> <maml:Description> <maml:para>Array of Build Definitions with MetaData to be converted to YAML Pipelines</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Array</command:parameterValue> <dev:type> <maml:name>Array</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>Projectname</maml:name> <maml:Description> <maml:para>The project to use to call the AzDo API. Should be the same as the project used to add Metadata / retrieve the Build Definitions.</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="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>profilename</maml:name> <maml:Description> <maml:para>Optional parameter to target a specific alias inside the config.json to use as a connection to AzDo. The -ProjectName provided should be accessible from this profile.</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:\> Get-AzDoAPIToolsDefinitionStepsAsYAMLPrepped -InputDefinitions $ArrayOfBuildDefinitions -Projectname 'YourAzDoProject'</dev:code> <dev:remarks> <maml:para>Will Take The definitions specified in $ArrayOfBuildDefinitions and for each definition will extract the steps from a Build Definition and converts them to a YAML ready PSObject. It will do this for the specified -Projectname on AzDo. Task Groups found in Build Definition steps will be converted to a template call.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-AzDoAPIToolsDefinitionStepsAsYAMLPrepped -InputDefinitions $ArrayOfBuildDefinitions -Projectname 'YourAzDoProject' -Profilename 'Alternative Alias in config.json'</dev:code> <dev:remarks> <maml:para>Will Take The definitions specified in $ArrayOfBuildDefinitions and for each definition will extract the steps from a Build Definition and converts them to a YAML ready PSObject. It will do this for the specified -Projectname on AzDo. Task Groups found in Build Definition steps will be converted to a template call. Will use the Connection details specified in -profilename rather than the first entry in config.json.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Get-AzDoAPIToolsDefinitionStepsAsYAMLPrepped -InputDefinitions $ArrayOfBuildDefinitions -Projectname 'YourAzDoProject' -ExpandNestedTaskGroups</dev:code> <dev:remarks> <maml:para>Will Take The definitions specified in $ArrayOfBuildDefinitions and for each definition will extract the steps from a Build Definition and converts them to a YAML ready PSObject. It will do this for the specified -Projectname on AzDo. Task Groups found in Build Definition steps will be iterated over and expanded as seperate steps in the converted Build Definition.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzDoAPIToolsDefinitionTriggersAsYAMLPrepped</command:name> <command:verb>Get</command:verb> <command:noun>AzDoAPIToolsDefinitionTriggersAsYAMLPrepped</command:noun> <maml:description> <maml:para>Returns a YAML Prepped PSObject with the triggers of a YAML pipeline based on a(n Array) of Build Definitions</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This function takes one or more Build Definition where metadata is present from `Get-AzDoAPIToolsDefinitionsTaskGroupsByNamesList` or `Get-AzDoAPIToolsDefinitionsTaskGroupsByID` and extracts the triggers from it and prepare it for conversion use in a YAML Pipeline. If desired use `Convert-AzDoAPIToolsYamlObjectToYAMLFile` to convert the extracted elements to a seperate yml file.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzDoAPIToolsDefinitionTriggersAsYAMLPrepped</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>InputDefinitions</maml:name> <maml:Description> <maml:para>Array of Build Definitions with MetaData to be converted to YAML Pipelines</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Array</command:parameterValue> <dev:type> <maml:name>Array</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>InputDefinitions</maml:name> <maml:Description> <maml:para>Array of Build Definitions with MetaData to be converted to YAML Pipelines</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Array</command:parameterValue> <dev:type> <maml:name>Array</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:\> GGet-AzDoAPIToolsDefinitionTriggersAsYAMLPrepped -InputDefinitions $ArrayOfBuildDefinitions</dev:code> <dev:remarks> <maml:para>Will Take The definitions specified in $ArrayOfBuildDefinitions and for each definition will extract the trigger elements from a Build Definition and converts them to a YAML ready PSObject.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzDoAPIToolsDefinitionVariablesAsYAMLPrepped</command:name> <command:verb>Get</command:verb> <command:noun>AzDoAPIToolsDefinitionVariablesAsYAMLPrepped</command:noun> <maml:description> <maml:para>Returns a YAML Prepped PSObject with the parameters and variables of a YAML pipeline based on a(n Array) of Build Definitions</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This function takes one or more Build Definition where metadata is present from `Get-AzDoAPIToolsDefinitionsTaskGroupsByNamesList` or `Get-AzDoAPIToolsDefinitionsTaskGroupsByID` and extracts the variables from it, determine whether it needs conversion and if so as a parameter or a variable and prepare it for conversion use in a YAML Pipeline. If desired use `Convert-AzDoAPIToolsYamlObjectToYAMLFile` to convert the extracted elements to a seperate yml file.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzDoAPIToolsDefinitionVariablesAsYAMLPrepped</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>InputDefinitions</maml:name> <maml:Description> <maml:para>Array of Build Definitions with MetaData to be converted to YAML Pipelines</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Array</command:parameterValue> <dev:type> <maml:name>Array</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>InputDefinitions</maml:name> <maml:Description> <maml:para>Array of Build Definitions with MetaData to be converted to YAML Pipelines</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Array</command:parameterValue> <dev:type> <maml:name>Array</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:\> Get-AzDoAPIToolsDefinitionVariablesAsYAMLPrepped -InputDefinitions $ArrayOfBuildDefinitions</dev:code> <dev:remarks> <maml:para>Will Take The definitions specified in $ArrayOfBuildDefinitions and for each definition will extract the variable elements from a Build Definition, determine if it needs conversion and if so as a parameter or a variable and converts them to a YAML ready PSObject.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzDoAPIToolsDefinitonsTaskGroupNames</command:name> <command:verb>Get</command:verb> <command:noun>AzDoAPIToolsDefinitonsTaskGroupNames</command:noun> <maml:description> <maml:para>Returns an array of names for all available Build / Release Definitions / Task Groups in a project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns an array of names for all available Build / Release Definitions / Task Groups in a project.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzDoAPIToolsDefinitonsTaskGroupNames</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ApiType</maml:name> <maml:Description> <maml:para>Specifies what API to call. Knows BuildDefinition, ReleaseDefinition and TaskGroup as accepted values.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">BuildDefinition</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ReleaseDefinition</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">TaskGroup</command:parameterValue> </command:parameterValueGroup> <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>Projectname</maml:name> <maml:Description> <maml:para>The project to use to call the AzDo API. Should be the same as the project used to add Metadata / retrieve the Build Definitions.</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="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>profilename</maml:name> <maml:Description> <maml:para>Optional parameter to target a specific alias inside the config.json to use as a connection to AzDo. The -ProjectName provided should be accessible from this profile.</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>ApiType</maml:name> <maml:Description> <maml:para>Specifies what API to call. Knows BuildDefinition, ReleaseDefinition and TaskGroup as accepted values.</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>Projectname</maml:name> <maml:Description> <maml:para>The project to use to call the AzDo API. Should be the same as the project used to add Metadata / retrieve the Build Definitions.</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="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>profilename</maml:name> <maml:Description> <maml:para>Optional parameter to target a specific alias inside the config.json to use as a connection to AzDo. The -ProjectName provided should be accessible from this profile.</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:\> {Get-AzDoAPIToolsDefinitonsTaskGroupNames -ApiType 'BuildDefinition' -Projectname 'YourAzDoProject'</dev:code> <dev:remarks> <maml:para>Will return an array with unique names of Build Definitions for YourAzDoProject.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> {Get-AzDoAPIToolsDefinitonsTaskGroupNames -ApiType 'ReleaseDefinition' -Projectname 'YourAzDoProject'</dev:code> <dev:remarks> <maml:para>Will return an array with unique names of Release Definitions for YourAzDoProject.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> {Get-AzDoAPIToolsDefinitonsTaskGroupNames -ApiType 'TaskGroup' -Projectname 'YourAzDoProject'</dev:code> <dev:remarks> <maml:para>Will return an array with unique names of found Task Groups for YourAzDoProject.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>PS C:\> {Get-AzDoAPIToolsDefinitonsTaskGroupNames -ApiType 'TaskGroup' -Projectname 'YourAzDoProject' -Profilename 'Alternative Alias in config.json'</dev:code> <dev:remarks> <maml:para>Will return an array with unique names of found Task Groups for YourAzDoProject. Will use the Connection details specified in -profilename rather than the first entry in config.json.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzDoAPIToolsTaskGroupAsYAMLPrepped</command:name> <command:verb>Get</command:verb> <command:noun>AzDoAPIToolsTaskGroupAsYAMLPrepped</command:noun> <maml:description> <maml:para>Returns a YAML Prepped PSObject or yml file with all the elements of a YAML pipeline based on a(n Array) of Task Groups.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This function takes one or more Task Groups where metadata is present from `Get-AzDoAPIToolsDefinitionsTaskGroupsByNamesList` or `Get-AzDoAPIToolsDefinitionsTaskGroupsByID` and prepares all elements in it for conversion to a YAML Template. if chosen it will output each Task Group to a seperate yml file.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzDoAPIToolsTaskGroupAsYAMLPrepped</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>TaskGroupsToConvert</maml:name> <maml:Description> <maml:para>Array of Task Groups with MetaData to be converted to YAML Pipelines</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Array</command:parameterValue> <dev:type> <maml:name>Array</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>Projectname</maml:name> <maml:Description> <maml:para>The project to use to call the AzDo API. Should be the same as the project used to add Metadata / retrieve the Build Definitions.</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="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>profilename</maml:name> <maml:Description> <maml:para>Optional parameter to target a specific alias inside the config.json to use as a connection to AzDo. The -ProjectName provided should be accessible from this profile.</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="3" aliases="none"> <maml:name>OutputPath</maml:name> <maml:Description> <maml:para>If Specified will write to this path when -OutPutAsFile is used. If the specified path does not exist you will be prompted to have it created.</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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExpandNestedTaskGroups</maml:name> <maml:Description> <maml:para>Switch to determine whether or not to expand found Task Groups or to call them as templates.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Outputasfile</maml:name> <maml:Description> <maml:para>{Switch to specify the output has to written to a file. When used also specify -OutPutPath. If not used the function will return a PSObject instead.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExpandNestedTaskGroups</maml:name> <maml:Description> <maml:para>Switch to determine whether or not to expand found Task Groups or to call them as templates.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>OutputPath</maml:name> <maml:Description> <maml:para>If Specified will write to this path when -OutPutAsFile is used. If the specified path does not exist you will be prompted to have it created.</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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Outputasfile</maml:name> <maml:Description> <maml:para>{Switch to specify the output has to written to a file. When used also specify -OutPutPath. If not used the function will return a PSObject instead.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Projectname</maml:name> <maml:Description> <maml:para>The project to use to call the AzDo API. Should be the same as the project used to add Metadata / retrieve the Build Definitions.</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="0" aliases="none"> <maml:name>TaskGroupsToConvert</maml:name> <maml:Description> <maml:para>Array of Task Groups with MetaData to be converted to YAML Pipelines</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>profilename</maml:name> <maml:Description> <maml:para>Optional parameter to target a specific alias inside the config.json to use as a connection to AzDo. The -ProjectName provided should be accessible from this profile.</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:\> Get-AzDoAPIToolsTaskGroupAsYAMLPrepped -TaskGroupsToConvert $ArrayOfTaskGroups -Projectname 'YourAzDoProject'</dev:code> <dev:remarks> <maml:para>Will Take The Task Groups specified in $ArrayOfTaskGroups and for each object will extract all elements from a Task Group and converts them to a YAML ready PSObject. It will do this for the specified -Projectname on AzDo. Task Groups found in Task Group steps will be converted to a template call.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-AzDoAPIToolsTaskGroupAsYAMLPrepped -TaskGroupsToConvert $ArrayOfTaskGroups -Projectname 'YourAzDoProject' -Profilename 'Alternative Alias in config.json'</dev:code> <dev:remarks> <maml:para>Will Take The Task Groups specified in $ArrayOfTaskGroups and for each object will extract all elements from a Task Group and converts them to a YAML ready PSObject. It will do this for the specified -Projectname on AzDo. Task Groups found in Task Group steps will be converted to a template call. Will use the Connection details specified in -profilename rather than the first entry in config.json.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Get-AzDoAPIToolsTaskGroupAsYAMLPrepped -TaskGroupsToConvert $ArrayOfTaskGroups -Projectname 'YourAzDoProject' -ExpandNestedTaskGroups</dev:code> <dev:remarks> <maml:para>Will Take The Task Groups specified in $ArrayOfTaskGroups and for each object will extract all elements from a Task Group and converts them to a YAML ready PSObject. It will do this for the specified -Projectname on AzDo. Task Groups found in Task Group steps will be iterated over and expanded as seperate steps in the converted Task Group Template.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>PS C:\> Get-AzDoAPIToolsTaskGroupAsYAMLPrepped -TaskGroupsToConvert $ArrayOfTaskGroups -Projectname 'YourAzDoProject' -ExpandNestedTaskGroups -OutputAsFile -OutPutPath 'C:\OutPut'</dev:code> <dev:remarks> <maml:para>Will Take The Task Groups specified in $ArrayOfTaskGroups and for each object will extract all elements from a Task Group and converts them to a yml file called TaskGroupName.yml inside C:\OutPut. It will do this for the specified -Projectname on AzDo. Task Groups found in Task Group steps will be iterated over and expanded as seperate steps in the converted Task Group Template.</maml:para> </dev:remarks> </command:example> </command:examples> <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>Set-AzdoAPIToolsConfig</command:name> <command:verb>Set</command:verb> <command:noun>AzdoAPIToolsConfig</command:noun> <maml:description> <maml:para>A simple function to add & overwrite the config.json file used by the module.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>A simple function to add & overwrite the config.json file used by the module.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzdoAPIToolsConfig</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>configfilepath</maml:name> <maml:Description> <maml:para>Specifies a path where to save your configfile.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>configfilepath</maml:name> <maml:Description> <maml:para>Specifies a path where to save your configfile.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</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:\> Set-AzdoAPIToolsConfig</dev:code> <dev:remarks> <maml:para>Will start the process to save a config.json file used by this module in %AppData%\AzDoAPITools. If a config file exists you will be prompted if you want to overwrite the existing file or if you want to append / add to the existing config.json file. If you choose to overwrite it will create a new config.json file with the details requested. If you choose to append / add you will be prompted for the details. If the Alias you entered for the connection to save exists in the configfile you will be prompted if it needs to be overwritten or appended.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Set-AzdoAPIToolsConfig -configfilepath C:\testpath</dev:code> <dev:remarks> <maml:para>Will start the process to save a config.json file used by this module in C:\testpath. If a config file exists you will be prompted if you want to overwrite the existing file or if you want to append / add to the existing config.json file. If you choose to overwrite it will create a new config.json file with the details requested. If you choose to append / add you will be prompted for the details. If the Alias you entered for the connection to save exists in the configfile you will be prompted if it needs to be overwritten or appended.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> </helpItems> |