Skip to content

Latest commit

 

History

History
224 lines (169 loc) · 7.12 KB

Get-AzDoAPIToolsDefinitionsTaskGroupsByID.md

File metadata and controls

224 lines (169 loc) · 7.12 KB
external help file Module Name online version schema
AzdoAPITools-help.xml
AzDoAPITools
2.0.0

Get-AzDoAPIToolsDefinitionsTaskGroupsByID

SYNOPSIS

Returns a Build / Release Definition or Task Group by its ID with added metadata for easy use

SYNTAX

Get-AzDoAPIToolsDefinitionsTaskGroupsByID [-ID] <String> [[-TGVersion] <Int32>] [-Projectname] <String>
 [[-profilename] <String>] [-ApiType] <String> [-includeTGdrafts] [-includeTGpreview] [-AllTGVersions]
 [<CommonParameters>]

DESCRIPTION

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.

EXAMPLES

Example 1

PS C:\> Get-AzDoAPIToolsDefinitionsTaskGroupsByID -ID $ID -APIType 'BuildDefinition' -Projectname 'YourAzDoProject'

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.

Example 2

PS C:\> Get-AzDoAPIToolsDefinitionsTaskGroupsByID -ID $ID -APIType 'BuildDefinition' -Projectname 'YourAzDoProject' -Profilename 'Alternative Alias in config.json'

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.

Example 3

PS C:\> Get-AzDoAPIToolsDefinitionsTaskGroupsByID -ID $ID -APIType 'ReleaseDefinition' -Projectname 'YourAzDoProject'

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!!!

Example 4

PS C:\> Get-AzDoAPIToolsDefinitionsTaskGroupsByID -ID $ID -APIType 'TaskGroup' -Projectname 'YourAzDoProject'

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.

Example 5

PS C:\> Get-AzDoAPIToolsDefinitionsTaskGroupsByID -ID $ID -APIType 'TaskGroup' -Projectname 'YourAzDoProject' -TGVersion 2

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.

Example 6

PS C:\> Get-AzDoAPIToolsDefinitionsTaskGroupsByID -ID $ID -APIType 'TaskGroup' -Projectname 'YourAzDoProject' -AllTGVersions

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.

Example 7

PS C:\> Get-AzDoAPIToolsDefinitionsTaskGroupsByID -ID $ID -APIType 'TaskGroup' -Projectname 'YourAzDoProject' -AllTGVersions -includeTGdrafts -includeTGpreview

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.

Example 8

PS C:\> Get-AzDoAPIToolsDefinitionsTaskGroupsByID -ID $ID -APIType 'TaskGroup' -Projectname 'YourAzDoProject' -includeTGpreview

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.

Example 9

PS C:\> Get-AzDoAPIToolsDefinitionsTaskGroupsByID -ID $ID -APIType 'TaskGroup' -Projectname 'YourAzDoProject' -includeTGdrafts

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.

PARAMETERS

-AllTGVersions

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ApiType

Specifies what API to call. Knows BuildDefinition, ReleaseDefinition and TaskGroup as accepted values.

Type: String
Parameter Sets: (All)
Aliases:
Accepted values: BuildDefinition, ReleaseDefinition, TaskGroup

Required: True
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ID

ID of the Build / Release definition or Task Group to lookup. for Build / Release definitions expects an integer and for Task Groups a GUID.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Projectname

The 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: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TGVersion

Used in combination with -APIType TaskGroup. Specifies a specific version to return for the given Task Group.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-includeTGdrafts

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.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-includeTGpreview

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.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-profilename

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.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None

OUTPUTS

System.Object

NOTES

RELATED LINKS