TaskAgentHttpClientBase.GetEnvironmentByIdAsync 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
| GetEnvironmentByIdAsync(String, Int32, Nullable<EnvironmentExpands>, Object, CancellationToken) |
[Preview API] Get an environment by its ID. |
| GetEnvironmentByIdAsync(Guid, Int32, Nullable<EnvironmentExpands>, Object, CancellationToken) |
[Preview API] Get an environment by its ID. |
GetEnvironmentByIdAsync(String, Int32, Nullable<EnvironmentExpands>, Object, CancellationToken)
[Preview API] Get an environment by its ID.
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.DistributedTask.WebApi.DistributedTaskEnvironment> GetEnvironmentByIdAsync(string project, int environmentId, Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.EnvironmentExpands> expands = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);
abstract member GetEnvironmentByIdAsync : string * int * Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.EnvironmentExpands> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.DistributedTask.WebApi.DistributedTaskEnvironment>
override this.GetEnvironmentByIdAsync : string * int * Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.EnvironmentExpands> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.DistributedTask.WebApi.DistributedTaskEnvironment>
Parameters
- project
- String
Project ID or project name
- environmentId
- Int32
ID of the environment.
- expands
- Nullable<EnvironmentExpands>
Include these additional details in the returned objects.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetEnvironmentByIdAsync(Guid, Int32, Nullable<EnvironmentExpands>, Object, CancellationToken)
[Preview API] Get an environment by its ID.
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.DistributedTask.WebApi.DistributedTaskEnvironment> GetEnvironmentByIdAsync(Guid project, int environmentId, Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.EnvironmentExpands> expands = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);
abstract member GetEnvironmentByIdAsync : Guid * int * Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.EnvironmentExpands> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.DistributedTask.WebApi.DistributedTaskEnvironment>
override this.GetEnvironmentByIdAsync : Guid * int * Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.EnvironmentExpands> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.DistributedTask.WebApi.DistributedTaskEnvironment>
Parameters
- project
- Guid
Project ID
- environmentId
- Int32
ID of the environment.
- expands
- Nullable<EnvironmentExpands>
Include these additional details in the returned objects.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.