BuildHttpClientCompatBase.GetBuildsAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
GetBuildsAsync(IEnumerable<Int32>, IEnumerable<Int32>, String, Nullable<DateTime>, Nullable<DateTime>, String, Nullable<BuildReason>, Nullable<BuildStatus>, Nullable<BuildResult>, IEnumerable<String>, IEnumerable<String>, Nullable<Int32>, String, Nullable<Int32>, Nullable<QueryDeletedOption>, Nullable<BuildQueryOrder>, String, IEnumerable<Int32>, Object, CancellationToken)
[Preview API] Gets builds
public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.Build.WebApi.Build>> GetBuildsAsync (System.Collections.Generic.IEnumerable<int> definitions = null, System.Collections.Generic.IEnumerable<int> queues = null, string buildNumber = null, Nullable<DateTime> minFinishTime = null, Nullable<DateTime> maxFinishTime = null, string requestedFor = null, Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildReason> reasonFilter = null, Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildStatus> statusFilter = null, Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildResult> resultFilter = null, System.Collections.Generic.IEnumerable<string> tagFilters = null, System.Collections.Generic.IEnumerable<string> properties = null, Nullable<int> top = null, string continuationToken = null, Nullable<int> maxBuildsPerDefinition = null, Nullable<Microsoft.TeamFoundation.Build.WebApi.QueryDeletedOption> deletedFilter = null, Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildQueryOrder> queryOrder = null, string branchName = null, System.Collections.Generic.IEnumerable<int> buildIds = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetBuildsAsync : seq<int> * seq<int> * string * Nullable<DateTime> * Nullable<DateTime> * string * Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildReason> * Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildStatus> * Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildResult> * seq<string> * seq<string> * Nullable<int> * string * Nullable<int> * Nullable<Microsoft.TeamFoundation.Build.WebApi.QueryDeletedOption> * Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildQueryOrder> * string * seq<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.Build.WebApi.Build>>
override this.GetBuildsAsync : seq<int> * seq<int> * string * Nullable<DateTime> * Nullable<DateTime> * string * Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildReason> * Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildStatus> * Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildResult> * seq<string> * seq<string> * Nullable<int> * string * Nullable<int> * Nullable<Microsoft.TeamFoundation.Build.WebApi.QueryDeletedOption> * Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildQueryOrder> * string * seq<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.Build.WebApi.Build>>Parameters
- definitions
- IEnumerable<Int32>
A comma-delimited list of definition ids
- queues
- IEnumerable<Int32>
A comma-delimited list of queue ids
- buildNumber
- String
- requestedFor
- String
- reasonFilter
- Nullable<BuildReason>
- statusFilter
- Nullable<BuildStatus>
- resultFilter
- Nullable<BuildResult>
- tagFilters
- IEnumerable<String>
A comma-delimited list of tags
- properties
- IEnumerable<String>
A comma-delimited list of properties to include in the results
- continuationToken
- String
- deletedFilter
- Nullable<QueryDeletedOption>
- queryOrder
- Nullable<BuildQueryOrder>
- branchName
- String
- buildIds
- IEnumerable<Int32>
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetBuildsAsync(Guid, IEnumerable<Int32>, IEnumerable<Int32>, String, Nullable<DateTime>, Nullable<DateTime>, String, Nullable<BuildReason>, Nullable<BuildStatus>, Nullable<BuildResult>, IEnumerable<String>, IEnumerable<String>, Nullable<Int32>, String, Nullable<Int32>, Nullable<QueryDeletedOption>, Nullable<BuildQueryOrder>, String, IEnumerable<Int32>, Object, CancellationToken)
[Preview API] Gets builds
public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.Build.WebApi.Build>> GetBuildsAsync (Guid project, System.Collections.Generic.IEnumerable<int> definitions = null, System.Collections.Generic.IEnumerable<int> queues = null, string buildNumber = null, Nullable<DateTime> minFinishTime = null, Nullable<DateTime> maxFinishTime = null, string requestedFor = null, Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildReason> reasonFilter = null, Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildStatus> statusFilter = null, Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildResult> resultFilter = null, System.Collections.Generic.IEnumerable<string> tagFilters = null, System.Collections.Generic.IEnumerable<string> properties = null, Nullable<int> top = null, string continuationToken = null, Nullable<int> maxBuildsPerDefinition = null, Nullable<Microsoft.TeamFoundation.Build.WebApi.QueryDeletedOption> deletedFilter = null, Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildQueryOrder> queryOrder = null, string branchName = null, System.Collections.Generic.IEnumerable<int> buildIds = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetBuildsAsync : Guid * seq<int> * seq<int> * string * Nullable<DateTime> * Nullable<DateTime> * string * Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildReason> * Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildStatus> * Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildResult> * seq<string> * seq<string> * Nullable<int> * string * Nullable<int> * Nullable<Microsoft.TeamFoundation.Build.WebApi.QueryDeletedOption> * Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildQueryOrder> * string * seq<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.Build.WebApi.Build>>
override this.GetBuildsAsync : Guid * seq<int> * seq<int> * string * Nullable<DateTime> * Nullable<DateTime> * string * Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildReason> * Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildStatus> * Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildResult> * seq<string> * seq<string> * Nullable<int> * string * Nullable<int> * Nullable<Microsoft.TeamFoundation.Build.WebApi.QueryDeletedOption> * Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildQueryOrder> * string * seq<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.Build.WebApi.Build>>Parameters
- project
- Guid
Project ID
- definitions
- IEnumerable<Int32>
A comma-delimited list of definition ids
- queues
- IEnumerable<Int32>
A comma-delimited list of queue ids
- buildNumber
- String
- requestedFor
- String
- reasonFilter
- Nullable<BuildReason>
- statusFilter
- Nullable<BuildStatus>
- resultFilter
- Nullable<BuildResult>
- tagFilters
- IEnumerable<String>
A comma-delimited list of tags
- properties
- IEnumerable<String>
A comma-delimited list of properties to include in the results
- continuationToken
- String
- deletedFilter
- Nullable<QueryDeletedOption>
- queryOrder
- Nullable<BuildQueryOrder>
- branchName
- String
- buildIds
- IEnumerable<Int32>
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetBuildsAsync(String, IEnumerable<Int32>, IEnumerable<Int32>, String, Nullable<DateTime>, Nullable<DateTime>, String, Nullable<BuildReason>, Nullable<BuildStatus>, Nullable<BuildResult>, IEnumerable<String>, IEnumerable<String>, Nullable<Int32>, String, Nullable<Int32>, Nullable<QueryDeletedOption>, Nullable<BuildQueryOrder>, String, IEnumerable<Int32>, Object, CancellationToken)
Caution
This API is now deprecated.
[Preview API] Gets builds
public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.Build.WebApi.Build>> GetBuildsAsync (string project, System.Collections.Generic.IEnumerable<int> definitions = null, System.Collections.Generic.IEnumerable<int> queues = null, string buildNumber = null, Nullable<DateTime> minFinishTime = null, Nullable<DateTime> maxFinishTime = null, string requestedFor = null, Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildReason> reasonFilter = null, Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildStatus> statusFilter = null, Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildResult> resultFilter = null, System.Collections.Generic.IEnumerable<string> tagFilters = null, System.Collections.Generic.IEnumerable<string> properties = null, Nullable<int> top = null, string continuationToken = null, Nullable<int> maxBuildsPerDefinition = null, Nullable<Microsoft.TeamFoundation.Build.WebApi.QueryDeletedOption> deletedFilter = null, Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildQueryOrder> queryOrder = null, string branchName = null, System.Collections.Generic.IEnumerable<int> buildIds = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);[System.Obsolete]
public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.Build.WebApi.Build>> GetBuildsAsync (string project, System.Collections.Generic.IEnumerable<int> definitions = null, System.Collections.Generic.IEnumerable<int> queues = null, string buildNumber = null, Nullable<DateTime> minFinishTime = null, Nullable<DateTime> maxFinishTime = null, string requestedFor = null, Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildReason> reasonFilter = null, Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildStatus> statusFilter = null, Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildResult> resultFilter = null, System.Collections.Generic.IEnumerable<string> tagFilters = null, System.Collections.Generic.IEnumerable<string> properties = null, Nullable<int> top = null, string continuationToken = null, Nullable<int> maxBuildsPerDefinition = null, Nullable<Microsoft.TeamFoundation.Build.WebApi.QueryDeletedOption> deletedFilter = null, Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildQueryOrder> queryOrder = null, string branchName = null, System.Collections.Generic.IEnumerable<int> buildIds = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetBuildsAsync : string * seq<int> * seq<int> * string * Nullable<DateTime> * Nullable<DateTime> * string * Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildReason> * Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildStatus> * Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildResult> * seq<string> * seq<string> * Nullable<int> * string * Nullable<int> * Nullable<Microsoft.TeamFoundation.Build.WebApi.QueryDeletedOption> * Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildQueryOrder> * string * seq<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.Build.WebApi.Build>>
override this.GetBuildsAsync : string * seq<int> * seq<int> * string * Nullable<DateTime> * Nullable<DateTime> * string * Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildReason> * Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildStatus> * Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildResult> * seq<string> * seq<string> * Nullable<int> * string * Nullable<int> * Nullable<Microsoft.TeamFoundation.Build.WebApi.QueryDeletedOption> * Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildQueryOrder> * string * seq<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.Build.WebApi.Build>>Parameters
- project
- String
Project ID or project name
- definitions
- IEnumerable<Int32>
A comma-delimited list of definition ids
- queues
- IEnumerable<Int32>
A comma-delimited list of queue ids
- buildNumber
- String
- requestedFor
- String
- reasonFilter
- Nullable<BuildReason>
- statusFilter
- Nullable<BuildStatus>
- resultFilter
- Nullable<BuildResult>
- tagFilters
- IEnumerable<String>
A comma-delimited list of tags
- properties
- IEnumerable<String>
A comma-delimited list of properties to include in the results
- continuationToken
- String
- deletedFilter
- Nullable<QueryDeletedOption>
- queryOrder
- Nullable<BuildQueryOrder>
- branchName
- String
- buildIds
- IEnumerable<Int32>
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
- Attributes
Applies to
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for