| external help file | Module Name | online version | schema |
|---|---|---|---|
AzdoAPITools-help.xml |
AzDoAPITools |
2.0.0 |
Returns a YAML Prepped PSObject or yml file with all the elements of a YAML pipeline based on a(n Array) of Build Definitions.
Get-AzDoAPIToolsDefinitionAsYAMLPrepped [-DefinitionsToConvert] <Array> [-Projectname] <String>
[[-profilename] <String>] [[-OutputPath] <String>] [-ExpandNestedTaskGroups] [-Outputasfile]
[<CommonParameters>]
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.
PS C:\> Get-AzDoAPIToolsDefinitionAsYAMLPrepped -DefinitionsToConvert $ArrayOfBuildDefinitions -Projectname 'YourAzDoProject'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.
PS C:\> Get-AzDoAPIToolsDefinitionAsYAMLPrepped -DefinitionsToConvert $ArrayOfBuildDefinitions -Projectname 'YourAzDoProject' -Profilename 'Alternative Alias in config.json'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.
PS C:\> Get-AzDoAPIToolsDefinitionAsYAMLPrepped -DefinitionsToConvert $ArrayOfBuildDefinitions -Projectname 'YourAzDoProject' -ExpandNestedTaskGroupsWill 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.
PS C:\> Get-AzDoAPIToolsDefinitionAsYAMLPrepped -DefinitionsToConvert $ArrayOfBuildDefinitions -Projectname 'YourAzDoProject' -ExpandNestedTaskGroups -OutputAsFile -OutPutPath 'C:\OutPut'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.
Array of Build Definitions with MetaData to be converted to YAML Pipelines
Type: Array
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSwitch to determine whether or not to expand found Task Groups or to call them as templates.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseIf 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.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSwitch 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.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe project to use to call the AzDo API. Should be the same as the project used to add Metadata / retrieve the Build Definitions.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseOptional 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.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.