TaskAgentHttpClientBase.GetDeploymentGroupsAsync 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
| GetDeploymentGroupsAsync(Guid, String, Nullable<DeploymentGroupActionFilter>, Nullable<DeploymentGroupExpands>, String, Nullable<Int32>, IEnumerable<Int32>, Object, CancellationToken) |
[Preview API] Get a list of deployment groups by name or IDs. |
| GetDeploymentGroupsAsync(String, String, Nullable<DeploymentGroupActionFilter>, Nullable<DeploymentGroupExpands>, String, Nullable<Int32>, IEnumerable<Int32>, Object, CancellationToken) |
[Preview API] Get a list of deployment groups by name or IDs. |
GetDeploymentGroupsAsync(Guid, String, Nullable<DeploymentGroupActionFilter>, Nullable<DeploymentGroupExpands>, String, Nullable<Int32>, IEnumerable<Int32>, Object, CancellationToken)
[Preview API] Get a list of deployment groups by name or IDs.
public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.DistributedTask.WebApi.DeploymentGroup>> GetDeploymentGroupsAsync(Guid project, string name = null, Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.DeploymentGroupActionFilter> actionFilter = null, Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.DeploymentGroupExpands> expand = null, string continuationToken = null, Nullable<int> top = null, System.Collections.Generic.IEnumerable<int> ids = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);
abstract member GetDeploymentGroupsAsync : Guid * string * Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.DeploymentGroupActionFilter> * Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.DeploymentGroupExpands> * string * Nullable<int> * seq<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.DistributedTask.WebApi.DeploymentGroup>>
override this.GetDeploymentGroupsAsync : Guid * string * Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.DeploymentGroupActionFilter> * Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.DeploymentGroupExpands> * string * Nullable<int> * seq<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.DistributedTask.WebApi.DeploymentGroup>>
Parameters
- project
- Guid
Project ID
- name
- String
Name of the deployment group.
- actionFilter
- Nullable<DeploymentGroupActionFilter>
Get only deployment groups on which this action can be performed.
- expand
- Nullable<DeploymentGroupExpands>
Include these additional details in the returned objects.
- continuationToken
- String
Get deployment groups with names greater than this continuationToken lexicographically.
- ids
- IEnumerable<Int32>
Comma separated list of IDs of the deployment groups.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetDeploymentGroupsAsync(String, String, Nullable<DeploymentGroupActionFilter>, Nullable<DeploymentGroupExpands>, String, Nullable<Int32>, IEnumerable<Int32>, Object, CancellationToken)
[Preview API] Get a list of deployment groups by name or IDs.
public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.DistributedTask.WebApi.DeploymentGroup>> GetDeploymentGroupsAsync(string project, string name = null, Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.DeploymentGroupActionFilter> actionFilter = null, Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.DeploymentGroupExpands> expand = null, string continuationToken = null, Nullable<int> top = null, System.Collections.Generic.IEnumerable<int> ids = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);
abstract member GetDeploymentGroupsAsync : string * string * Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.DeploymentGroupActionFilter> * Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.DeploymentGroupExpands> * string * Nullable<int> * seq<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.DistributedTask.WebApi.DeploymentGroup>>
override this.GetDeploymentGroupsAsync : string * string * Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.DeploymentGroupActionFilter> * Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.DeploymentGroupExpands> * string * Nullable<int> * seq<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.DistributedTask.WebApi.DeploymentGroup>>
Parameters
- project
- String
Project ID or project name
- name
- String
Name of the deployment group.
- actionFilter
- Nullable<DeploymentGroupActionFilter>
Get only deployment groups on which this action can be performed.
- expand
- Nullable<DeploymentGroupExpands>
Include these additional details in the returned objects.
- continuationToken
- String
Get deployment groups with names greater than this continuationToken lexicographically.
- ids
- IEnumerable<Int32>
Comma separated list of IDs of the deployment groups.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.