Language

TaskAgentHttpClientBase.GetVariableGroupsAsync Method

Definition

Overloads

GetVariableGroupsAsync(Guid, String, Nullable<VariableGroupActionFilter>, Nullable<Int32>, Nullable<Int32>, Nullable<VariableGroupQueryOrder>, Object, CancellationToken)

[Preview API] Get variable groups.

public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.DistributedTask.WebApi.VariableGroup>> GetVariableGroupsAsync(Guid project, string groupName = null, Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.VariableGroupActionFilter> actionFilter = null, Nullable<int> top = null, Nullable<int> continuationToken = null, Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.VariableGroupQueryOrder> queryOrder = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);
abstract member GetVariableGroupsAsync : Guid * string * Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.VariableGroupActionFilter> * Nullable<int> * Nullable<int> * Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.VariableGroupQueryOrder> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.DistributedTask.WebApi.VariableGroup>>
override this.GetVariableGroupsAsync : Guid * string * Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.VariableGroupActionFilter> * Nullable<int> * Nullable<int> * Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.VariableGroupQueryOrder> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.DistributedTask.WebApi.VariableGroup>>

Parameters

project
Guid

Project ID

groupName
String

Name of variable group.

actionFilter
Nullable<VariableGroupActionFilter>

Action filter for the variable group. It specifies the action which can be performed on the variable groups.

top
Nullable<Int32>

Number of variable groups to get.

continuationToken
Nullable<Int32>

Gets the variable groups after the continuation token provided.

queryOrder
Nullable<VariableGroupQueryOrder>

Gets the results in the defined order. Default is 'IdDescending'.

userState
Object
cancellationToken
CancellationToken

The cancellation token to cancel operation.

Returns

Applies to

GetVariableGroupsAsync(String, String, Nullable<VariableGroupActionFilter>, Nullable<Int32>, Nullable<Int32>, Nullable<VariableGroupQueryOrder>, Object, CancellationToken)

[Preview API] Get variable groups.

public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.DistributedTask.WebApi.VariableGroup>> GetVariableGroupsAsync(string project, string groupName = null, Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.VariableGroupActionFilter> actionFilter = null, Nullable<int> top = null, Nullable<int> continuationToken = null, Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.VariableGroupQueryOrder> queryOrder = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);
abstract member GetVariableGroupsAsync : string * string * Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.VariableGroupActionFilter> * Nullable<int> * Nullable<int> * Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.VariableGroupQueryOrder> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.DistributedTask.WebApi.VariableGroup>>
override this.GetVariableGroupsAsync : string * string * Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.VariableGroupActionFilter> * Nullable<int> * Nullable<int> * Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.VariableGroupQueryOrder> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.DistributedTask.WebApi.VariableGroup>>

Parameters

project
String

Project ID or project name

groupName
String

Name of variable group.

actionFilter
Nullable<VariableGroupActionFilter>

Action filter for the variable group. It specifies the action which can be performed on the variable groups.

top
Nullable<Int32>

Number of variable groups to get.

continuationToken
Nullable<Int32>

Gets the variable groups after the continuation token provided.

queryOrder
Nullable<VariableGroupQueryOrder>

Gets the results in the defined order. Default is 'IdDescending'.

userState
Object
cancellationToken
CancellationToken

The cancellation token to cancel operation.

Returns

Applies to