Skip to content

Get-AdoTeamIteration.md

Latest commit

 

History

History
262 lines (205 loc) · 5.72 KB

Get-AdoTeamIteration.md

File metadata and controls

262 lines (205 loc) · 5.72 KB

Get-AdoTeamIteration

SYNOPSIS

Retrieves Azure DevOps team iteration details.

SYNTAX

ListIterations

Get-AdoTeamIteration [[-CollectionUri] <string>] [[-ProjectName] <string>] [-TeamName] <string> [[-TimeFrame] <string>] [[-Version] <string>] [-WhatIf] [-Confirm] [<CommonParameters>]

ById

Get-AdoTeamIteration [[-CollectionUri] <string>] [[-ProjectName] <string>] [-TeamName] <string> [[-Id] <string>] [[-Version] <string>] [-WhatIf] [-Confirm] [<CommonParameters>]

ALIASES

This cmdlet has the following aliases,

  • N/A

DESCRIPTION

This cmdlet retrieves details of one or more Azure DevOps team iterations within a specified project and team. You can retrieve all iterations, filter by timeframe, or retrieve specific iterations by ID.

EXAMPLES

EXAMPLE 1

PowerShell

$params = @{
    CollectionUri = 'https://dev.azure.com/my-org'
    ProjectName = 'my-project'
    TeamName = 'my-team'
}
Get-AdoTeamIteration @params

Retrieves all iterations for the specified team.

EXAMPLE 2

PowerShell

$params = @{
    CollectionUri = 'https://dev.azure.com/my-org'
    ProjectName = 'my-project'
    TeamName = 'my-team'
    TimeFrame = 'current'
}
Get-AdoTeamIteration @params

Retrieves current iterations for the specified team.

EXAMPLE 3

PowerShell

$params = @{
    CollectionUri = 'https://dev.azure.com/my-org'
    ProjectName = 'my-project'
    TeamName = 'my-team'
    Id = '00000000-0000-0000-0000-000000000000'
}
Get-AdoTeamIteration @params

Retrieves the specified iteration by ID.

PARAMETERS

-CollectionUri

The collection URI of the Azure DevOps collection/organization, e.g., https://dev.azure.com/my-org. Defaults to the value of $env:DefaultAdoCollectionUri if not provided.

Type: System.String
DefaultValue: $env:DefaultAdoCollectionUri
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: true
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-ProjectName

The ID or name of the project. Defaults to the value of $env:DefaultAdoProject if not provided.

Type: System.String
DefaultValue: $env:DefaultAdoProject
SupportsWildcards: false
Aliases:
- ProjectId
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: true
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-TeamName

The ID or name of the team.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases:
- TeamId
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: true
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Id

The ID of the iteration(s) to retrieve. If not provided, retrieves all iterations.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases:
- IterationId
ParameterSets:
- Name: ById
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: true
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-TimeFrame

The timeframe to filter iterations. Valid values are 'past', 'current', and 'future'. Note: Only 'current' is fully supported by the Azure DevOps API currently.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: ListIterations
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: true
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues:
- past
- current
- future
HelpMessage: Only 'current' is supported currently.

-Version

The API version to use for the request.

Type: System.String
DefaultValue: '7.1'
SupportsWildcards: false
Aliases:
- api
- ApiVersion
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: true
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues:
- '7.1'
- '7.2-preview.1'
HelpMessage: ''

CommonParameters

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

INPUTS

  • N/A

OUTPUTS

PSCustomObject

NOTES

  • Requires authentication to Azure DevOps. Use Set-AdoDefault to configure default organization and project values.

  • The cmdlet automatically retrieves authentication through Invoke-AdoRestMethod which calls New-AdoAuthHeader.

  • If a specific iteration ID is not found, a warning will be issued and the cmdlet will continue without error.

  • This cmdlet supports -WhatIf and -Confirm parameters for testing queries before execution.

  • The TimeFrame parameter currently only fully supports 'current' timeframe filtering.

RELATED LINKS