BuildHttpClientBase.GetDefinitionsAsync 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
GetDefinitionsAsync(String, String, String, Nullable<DefinitionQueryOrder>, Nullable<Int32>, String, Nullable<DateTime>, IEnumerable<Int32>, String, Nullable<DateTime>, Nullable<DateTime>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Guid>, Object, CancellationToken)
Gets a list of definitions.
protected virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.Build.WebApi.BuildDefinitionReference>> GetDefinitionsAsync(string name = null, string repositoryId = null, string repositoryType = null, Nullable<Microsoft.TeamFoundation.Build.WebApi.DefinitionQueryOrder> queryOrder = null, Nullable<int> top = null, string continuationToken = null, Nullable<DateTime> minMetricsTime = null, System.Collections.Generic.IEnumerable<int> definitionIds = null, string path = null, Nullable<DateTime> builtAfter = null, Nullable<DateTime> notBuiltAfter = null, Nullable<bool> includeAllProperties = null, Nullable<bool> includeLatestBuilds = null, Nullable<Guid> taskIdFilter = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);override this.GetDefinitionsAsync : string * string * string * Nullable<Microsoft.TeamFoundation.Build.WebApi.DefinitionQueryOrder> * Nullable<int> * string * Nullable<DateTime> * seq<int> * string * Nullable<DateTime> * Nullable<DateTime> * Nullable<bool> * Nullable<bool> * Nullable<Guid> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.Build.WebApi.BuildDefinitionReference>>Parameters
- name
- String
If specified, filters to definitions whose names match this pattern.
- repositoryId
- String
A repository ID. If specified, filters to definitions that use this repository.
- repositoryType
- String
If specified, filters to definitions that have a repository of this type.
- queryOrder
- Nullable<DefinitionQueryOrder>
Indicates the order in which definitions should be returned.
- continuationToken
- String
A continuation token, returned by a previous call to this method, that can be used to return the next set of definitions.
If specified, indicates the date from which metrics should be included.
- definitionIds
- IEnumerable<Int32>
A comma-delimited list that specifies the IDs of definitions to retrieve.
- path
- String
If specified, filters to definitions under this folder.
If specified, filters to definitions that have builds after this date.
If specified, filters to definitions that do not have builds after this date.
Indicates whether the full definitions should be returned. By default, shallow representations of the definitions are returned.
Indicates whether to return the latest and latest completed builds for this definition.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetDefinitionsAsync(Guid, String, String, String, Nullable<DefinitionQueryOrder>, Nullable<Int32>, String, Nullable<DateTime>, IEnumerable<Int32>, String, Nullable<DateTime>, Nullable<DateTime>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Guid>, Object, CancellationToken)
Gets a list of definitions.
protected virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.Build.WebApi.BuildDefinitionReference>> GetDefinitionsAsync(Guid project, string name = null, string repositoryId = null, string repositoryType = null, Nullable<Microsoft.TeamFoundation.Build.WebApi.DefinitionQueryOrder> queryOrder = null, Nullable<int> top = null, string continuationToken = null, Nullable<DateTime> minMetricsTime = null, System.Collections.Generic.IEnumerable<int> definitionIds = null, string path = null, Nullable<DateTime> builtAfter = null, Nullable<DateTime> notBuiltAfter = null, Nullable<bool> includeAllProperties = null, Nullable<bool> includeLatestBuilds = null, Nullable<Guid> taskIdFilter = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);override this.GetDefinitionsAsync : Guid * string * string * string * Nullable<Microsoft.TeamFoundation.Build.WebApi.DefinitionQueryOrder> * Nullable<int> * string * Nullable<DateTime> * seq<int> * string * Nullable<DateTime> * Nullable<DateTime> * Nullable<bool> * Nullable<bool> * Nullable<Guid> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.Build.WebApi.BuildDefinitionReference>>Parameters
- project
- Guid
Project ID
- name
- String
If specified, filters to definitions whose names match this pattern.
- repositoryId
- String
A repository ID. If specified, filters to definitions that use this repository.
- repositoryType
- String
If specified, filters to definitions that have a repository of this type.
- queryOrder
- Nullable<DefinitionQueryOrder>
Indicates the order in which definitions should be returned.
- continuationToken
- String
A continuation token, returned by a previous call to this method, that can be used to return the next set of definitions.
If specified, indicates the date from which metrics should be included.
- definitionIds
- IEnumerable<Int32>
A comma-delimited list that specifies the IDs of definitions to retrieve.
- path
- String
If specified, filters to definitions under this folder.
If specified, filters to definitions that have builds after this date.
If specified, filters to definitions that do not have builds after this date.
Indicates whether the full definitions should be returned. By default, shallow representations of the definitions are returned.
Indicates whether to return the latest and latest completed builds for this definition.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetDefinitionsAsync(String, String, String, String, Nullable<DefinitionQueryOrder>, Nullable<Int32>, String, Nullable<DateTime>, IEnumerable<Int32>, String, Nullable<DateTime>, Nullable<DateTime>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Guid>, Object, CancellationToken)
Gets a list of definitions.
protected virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.Build.WebApi.BuildDefinitionReference>> GetDefinitionsAsync(string project, string name = null, string repositoryId = null, string repositoryType = null, Nullable<Microsoft.TeamFoundation.Build.WebApi.DefinitionQueryOrder> queryOrder = null, Nullable<int> top = null, string continuationToken = null, Nullable<DateTime> minMetricsTime = null, System.Collections.Generic.IEnumerable<int> definitionIds = null, string path = null, Nullable<DateTime> builtAfter = null, Nullable<DateTime> notBuiltAfter = null, Nullable<bool> includeAllProperties = null, Nullable<bool> includeLatestBuilds = null, Nullable<Guid> taskIdFilter = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);override this.GetDefinitionsAsync : string * string * string * string * Nullable<Microsoft.TeamFoundation.Build.WebApi.DefinitionQueryOrder> * Nullable<int> * string * Nullable<DateTime> * seq<int> * string * Nullable<DateTime> * Nullable<DateTime> * Nullable<bool> * Nullable<bool> * Nullable<Guid> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.Build.WebApi.BuildDefinitionReference>>Parameters
- project
- String
Project ID or project name
- name
- String
If specified, filters to definitions whose names match this pattern.
- repositoryId
- String
A repository ID. If specified, filters to definitions that use this repository.
- repositoryType
- String
If specified, filters to definitions that have a repository of this type.
- queryOrder
- Nullable<DefinitionQueryOrder>
Indicates the order in which definitions should be returned.
- continuationToken
- String
A continuation token, returned by a previous call to this method, that can be used to return the next set of definitions.
If specified, indicates the date from which metrics should be included.
- definitionIds
- IEnumerable<Int32>
A comma-delimited list that specifies the IDs of definitions to retrieve.
- path
- String
If specified, filters to definitions under this folder.
If specified, filters to definitions that have builds after this date.
If specified, filters to definitions that do not have builds after this date.
Indicates whether the full definitions should be returned. By default, shallow representations of the definitions are returned.
Indicates whether to return the latest and latest completed builds for this definition.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetDefinitionsAsync(Guid, String, String, String, Nullable<DefinitionQueryOrder>, Nullable<Int32>, String, Nullable<DateTime>, IEnumerable<Int32>, String, Nullable<DateTime>, Nullable<DateTime>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Guid>, Nullable<Int32>, String, Object, CancellationToken)
[Preview API] Gets a list of definitions.
protected virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.Build.WebApi.BuildDefinitionReference>> GetDefinitionsAsync(Guid project, string name = null, string repositoryId = null, string repositoryType = null, Nullable<Microsoft.TeamFoundation.Build.WebApi.DefinitionQueryOrder> queryOrder = null, Nullable<int> top = null, string continuationToken = null, Nullable<DateTime> minMetricsTime = null, System.Collections.Generic.IEnumerable<int> definitionIds = null, string path = null, Nullable<DateTime> builtAfter = null, Nullable<DateTime> notBuiltAfter = null, Nullable<bool> includeAllProperties = null, Nullable<bool> includeLatestBuilds = null, Nullable<Guid> taskIdFilter = null, Nullable<int> processType = null, string yamlFilename = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);override this.GetDefinitionsAsync : Guid * string * string * string * Nullable<Microsoft.TeamFoundation.Build.WebApi.DefinitionQueryOrder> * Nullable<int> * string * Nullable<DateTime> * seq<int> * string * Nullable<DateTime> * Nullable<DateTime> * Nullable<bool> * Nullable<bool> * Nullable<Guid> * Nullable<int> * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.Build.WebApi.BuildDefinitionReference>>Parameters
- project
- Guid
Project ID
- name
- String
If specified, filters to definitions whose names match this pattern.
- repositoryId
- String
A repository ID. If specified, filters to definitions that use this repository.
- repositoryType
- String
If specified, filters to definitions that have a repository of this type.
- queryOrder
- Nullable<DefinitionQueryOrder>
Indicates the order in which definitions should be returned.
- continuationToken
- String
A continuation token, returned by a previous call to this method, that can be used to return the next set of definitions.
If specified, indicates the date from which metrics should be included.
- definitionIds
- IEnumerable<Int32>
A comma-delimited list that specifies the IDs of definitions to retrieve.
- path
- String
If specified, filters to definitions under this folder.
If specified, filters to definitions that have builds after this date.
If specified, filters to definitions that do not have builds after this date.
Indicates whether the full definitions should be returned. By default, shallow representations of the definitions are returned.
Indicates whether to return the latest and latest completed builds for this definition.
- yamlFilename
- String
If specified, filters to YAML definitions that match the given filename.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetDefinitionsAsync(String, String, String, String, Nullable<DefinitionQueryOrder>, Nullable<Int32>, String, Nullable<DateTime>, IEnumerable<Int32>, String, Nullable<DateTime>, Nullable<DateTime>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Guid>, Nullable<Int32>, String, Object, CancellationToken)
[Preview API] Gets a list of definitions.
protected virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.Build.WebApi.BuildDefinitionReference>> GetDefinitionsAsync(string project, string name = null, string repositoryId = null, string repositoryType = null, Nullable<Microsoft.TeamFoundation.Build.WebApi.DefinitionQueryOrder> queryOrder = null, Nullable<int> top = null, string continuationToken = null, Nullable<DateTime> minMetricsTime = null, System.Collections.Generic.IEnumerable<int> definitionIds = null, string path = null, Nullable<DateTime> builtAfter = null, Nullable<DateTime> notBuiltAfter = null, Nullable<bool> includeAllProperties = null, Nullable<bool> includeLatestBuilds = null, Nullable<Guid> taskIdFilter = null, Nullable<int> processType = null, string yamlFilename = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);override this.GetDefinitionsAsync : string * string * string * string * Nullable<Microsoft.TeamFoundation.Build.WebApi.DefinitionQueryOrder> * Nullable<int> * string * Nullable<DateTime> * seq<int> * string * Nullable<DateTime> * Nullable<DateTime> * Nullable<bool> * Nullable<bool> * Nullable<Guid> * Nullable<int> * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.Build.WebApi.BuildDefinitionReference>>Parameters
- project
- String
Project ID or project name
- name
- String
If specified, filters to definitions whose names match this pattern.
- repositoryId
- String
A repository ID. If specified, filters to definitions that use this repository.
- repositoryType
- String
If specified, filters to definitions that have a repository of this type.
- queryOrder
- Nullable<DefinitionQueryOrder>
Indicates the order in which definitions should be returned.
- continuationToken
- String
A continuation token, returned by a previous call to this method, that can be used to return the next set of definitions.
If specified, indicates the date from which metrics should be included.
- definitionIds
- IEnumerable<Int32>
A comma-delimited list that specifies the IDs of definitions to retrieve.
- path
- String
If specified, filters to definitions under this folder.
If specified, filters to definitions that have builds after this date.
If specified, filters to definitions that do not have builds after this date.
Indicates whether the full definitions should be returned. By default, shallow representations of the definitions are returned.
Indicates whether to return the latest and latest completed builds for this definition.
- yamlFilename
- String
If specified, filters to YAML definitions that match the given filename.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.