TaskAgentHttpClientBase.GetDeploymentTargetsAsync Method

Definition

Namespace:: Microsoft.TeamFoundation.DistributedTask.WebApi

Assembly:: Microsoft.TeamFoundation.DistributedTask.WebApi.dll

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

GetDeploymentTargetsAsync(Guid, Int32, IEnumerable<String>, String, Nullable<Boolean>, Nullable<DeploymentTargetExpands>, Nullable<TaskAgentStatusFilter>, Nullable<TaskAgentJobResultFilter>, String, Nullable<Int32>, Object, CancellationToken)	[Preview API] Get a list of deployment targets in a deployment group.
GetDeploymentTargetsAsync(String, Int32, IEnumerable<String>, String, Nullable<Boolean>, Nullable<DeploymentTargetExpands>, Nullable<TaskAgentStatusFilter>, Nullable<TaskAgentJobResultFilter>, String, Nullable<Int32>, Object, CancellationToken)	[Preview API] Get a list of deployment targets in a deployment group.
GetDeploymentTargetsAsync(Guid, Int32, IEnumerable<String>, String, Nullable<Boolean>, Nullable<DeploymentTargetExpands>, Nullable<TaskAgentStatusFilter>, Nullable<TaskAgentJobResultFilter>, String, Nullable<Int32>, Nullable<Boolean>, Object, CancellationToken)	[Preview API] Get a list of deployment targets in a deployment group.
GetDeploymentTargetsAsync(String, Int32, IEnumerable<String>, String, Nullable<Boolean>, Nullable<DeploymentTargetExpands>, Nullable<TaskAgentStatusFilter>, Nullable<TaskAgentJobResultFilter>, String, Nullable<Int32>, Nullable<Boolean>, Object, CancellationToken)	[Preview API] Get a list of deployment targets in a deployment group.

GetDeploymentTargetsAsync(Guid, Int32, IEnumerable<String>, String, Nullable<Boolean>, Nullable<DeploymentTargetExpands>, Nullable<TaskAgentStatusFilter>, Nullable<TaskAgentJobResultFilter>, String, Nullable<Int32>, Object, CancellationToken)

[Preview API] Get a list of deployment targets in a deployment group.

public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.DistributedTask.WebApi.DeploymentMachine>> GetDeploymentTargetsAsync(Guid project, int deploymentGroupId, System.Collections.Generic.IEnumerable<string> tags = null, string name = null, Nullable<bool> partialNameMatch = null, Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.DeploymentTargetExpands> expand = null, Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.TaskAgentStatusFilter> agentStatus = null, Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.TaskAgentJobResultFilter> agentJobResult = null, string continuationToken = null, Nullable<int> top = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member GetDeploymentTargetsAsync : Guid * int * seq<string> * string * Nullable<bool> * Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.DeploymentTargetExpands> * Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.TaskAgentStatusFilter> * Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.TaskAgentJobResultFilter> * string * Nullable<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.DistributedTask.WebApi.DeploymentMachine>>
override this.GetDeploymentTargetsAsync : Guid * int * seq<string> * string * Nullable<bool> * Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.DeploymentTargetExpands> * Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.TaskAgentStatusFilter> * Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.TaskAgentJobResultFilter> * string * Nullable<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.DistributedTask.WebApi.DeploymentMachine>>

Parameters

project: Guid

Project ID

deploymentGroupId: Int32

ID of the deployment group.

tags: IEnumerable<String>

Get only the deployment targets that contain all these comma separted list of tags.

name: String

Name pattern of the deployment targets to return.

partialNameMatch: Nullable<Boolean>

When set to true, treats name as pattern. Else treats it as absolute match. Default is false.

expand: Nullable<DeploymentTargetExpands>

Include these additional details in the returned objects.

agentStatus: Nullable<TaskAgentStatusFilter>

Get only deployment targets that have this status.

agentJobResult: Nullable<TaskAgentJobResultFilter>

Get only deployment targets that have this last job result.

continuationToken: String

Get deployment targets with names greater than this continuationToken lexicographically.

top: Nullable<Int32>

Maximum number of deployment targets to return. Default is 1000.

userState: Object

cancellationToken: CancellationToken

The cancellation token to cancel operation.

Returns

Task<List<DeploymentMachine>>

Applies to

GetDeploymentTargetsAsync(String, Int32, IEnumerable<String>, String, Nullable<Boolean>, Nullable<DeploymentTargetExpands>, Nullable<TaskAgentStatusFilter>, Nullable<TaskAgentJobResultFilter>, String, Nullable<Int32>, Object, CancellationToken)

[Preview API] Get a list of deployment targets in a deployment group.

public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.DistributedTask.WebApi.DeploymentMachine>> GetDeploymentTargetsAsync(string project, int deploymentGroupId, System.Collections.Generic.IEnumerable<string> tags = null, string name = null, Nullable<bool> partialNameMatch = null, Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.DeploymentTargetExpands> expand = null, Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.TaskAgentStatusFilter> agentStatus = null, Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.TaskAgentJobResultFilter> agentJobResult = null, string continuationToken = null, Nullable<int> top = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member GetDeploymentTargetsAsync : string * int * seq<string> * string * Nullable<bool> * Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.DeploymentTargetExpands> * Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.TaskAgentStatusFilter> * Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.TaskAgentJobResultFilter> * string * Nullable<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.DistributedTask.WebApi.DeploymentMachine>>
override this.GetDeploymentTargetsAsync : string * int * seq<string> * string * Nullable<bool> * Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.DeploymentTargetExpands> * Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.TaskAgentStatusFilter> * Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.TaskAgentJobResultFilter> * string * Nullable<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.DistributedTask.WebApi.DeploymentMachine>>

Parameters

project: String

Project ID or project name

deploymentGroupId: Int32

ID of the deployment group.

tags: IEnumerable<String>

Get only the deployment targets that contain all these comma separted list of tags.

name: String

Name pattern of the deployment targets to return.

partialNameMatch: Nullable<Boolean>

When set to true, treats name as pattern. Else treats it as absolute match. Default is false.

expand: Nullable<DeploymentTargetExpands>

Include these additional details in the returned objects.

agentStatus: Nullable<TaskAgentStatusFilter>

Get only deployment targets that have this status.

agentJobResult: Nullable<TaskAgentJobResultFilter>

Get only deployment targets that have this last job result.

continuationToken: String

Get deployment targets with names greater than this continuationToken lexicographically.

top: Nullable<Int32>

Maximum number of deployment targets to return. Default is 1000.

userState: Object

cancellationToken: CancellationToken

The cancellation token to cancel operation.

Returns

Task<List<DeploymentMachine>>

Applies to

GetDeploymentTargetsAsync(Guid, Int32, IEnumerable<String>, String, Nullable<Boolean>, Nullable<DeploymentTargetExpands>, Nullable<TaskAgentStatusFilter>, Nullable<TaskAgentJobResultFilter>, String, Nullable<Int32>, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Get a list of deployment targets in a deployment group.

public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.DistributedTask.WebApi.DeploymentMachine>> GetDeploymentTargetsAsync(Guid project, int deploymentGroupId, System.Collections.Generic.IEnumerable<string> tags = null, string name = null, Nullable<bool> partialNameMatch = null, Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.DeploymentTargetExpands> expand = null, Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.TaskAgentStatusFilter> agentStatus = null, Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.TaskAgentJobResultFilter> agentJobResult = null, string continuationToken = null, Nullable<int> top = null, Nullable<bool> enabled = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member GetDeploymentTargetsAsync : Guid * int * seq<string> * string * Nullable<bool> * Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.DeploymentTargetExpands> * Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.TaskAgentStatusFilter> * Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.TaskAgentJobResultFilter> * string * Nullable<int> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.DistributedTask.WebApi.DeploymentMachine>>
override this.GetDeploymentTargetsAsync : Guid * int * seq<string> * string * Nullable<bool> * Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.DeploymentTargetExpands> * Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.TaskAgentStatusFilter> * Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.TaskAgentJobResultFilter> * string * Nullable<int> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.DistributedTask.WebApi.DeploymentMachine>>

Parameters

project: Guid

Project ID

deploymentGroupId: Int32

ID of the deployment group.

tags: IEnumerable<String>

Get only the deployment targets that contain all these comma separted list of tags.

name: String

Name pattern of the deployment targets to return.

partialNameMatch: Nullable<Boolean>

When set to true, treats name as pattern. Else treats it as absolute match. Default is false.

expand: Nullable<DeploymentTargetExpands>

Include these additional details in the returned objects.

agentStatus: Nullable<TaskAgentStatusFilter>

Get only deployment targets that have this status.

agentJobResult: Nullable<TaskAgentJobResultFilter>

Get only deployment targets that have this last job result.

continuationToken: String

Get deployment targets with names greater than this continuationToken lexicographically.

top: Nullable<Int32>

Maximum number of deployment targets to return. Default is 1000.

enabled: Nullable<Boolean>

Get only deployment targets that are enabled or disabled. Default is 'null' which returns all the targets.

userState: Object

cancellationToken: CancellationToken

The cancellation token to cancel operation.

Returns

Task<List<DeploymentMachine>>

Applies to

GetDeploymentTargetsAsync(String, Int32, IEnumerable<String>, String, Nullable<Boolean>, Nullable<DeploymentTargetExpands>, Nullable<TaskAgentStatusFilter>, Nullable<TaskAgentJobResultFilter>, String, Nullable<Int32>, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Get a list of deployment targets in a deployment group.

public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.DistributedTask.WebApi.DeploymentMachine>> GetDeploymentTargetsAsync(string project, int deploymentGroupId, System.Collections.Generic.IEnumerable<string> tags = null, string name = null, Nullable<bool> partialNameMatch = null, Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.DeploymentTargetExpands> expand = null, Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.TaskAgentStatusFilter> agentStatus = null, Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.TaskAgentJobResultFilter> agentJobResult = null, string continuationToken = null, Nullable<int> top = null, Nullable<bool> enabled = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member GetDeploymentTargetsAsync : string * int * seq<string> * string * Nullable<bool> * Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.DeploymentTargetExpands> * Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.TaskAgentStatusFilter> * Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.TaskAgentJobResultFilter> * string * Nullable<int> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.DistributedTask.WebApi.DeploymentMachine>>
override this.GetDeploymentTargetsAsync : string * int * seq<string> * string * Nullable<bool> * Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.DeploymentTargetExpands> * Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.TaskAgentStatusFilter> * Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.TaskAgentJobResultFilter> * string * Nullable<int> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.DistributedTask.WebApi.DeploymentMachine>>

Parameters

project: String

Project ID or project name

deploymentGroupId: Int32

ID of the deployment group.

tags: IEnumerable<String>

Get only the deployment targets that contain all these comma separted list of tags.

name: String

Name pattern of the deployment targets to return.

partialNameMatch: Nullable<Boolean>

When set to true, treats name as pattern. Else treats it as absolute match. Default is false.

expand: Nullable<DeploymentTargetExpands>

Include these additional details in the returned objects.

agentStatus: Nullable<TaskAgentStatusFilter>

Get only deployment targets that have this status.

agentJobResult: Nullable<TaskAgentJobResultFilter>

Get only deployment targets that have this last job result.

continuationToken: String

Get deployment targets with names greater than this continuationToken lexicographically.

top: Nullable<Int32>

Maximum number of deployment targets to return. Default is 1000.

enabled: Nullable<Boolean>

Get only deployment targets that are enabled or disabled. Default is 'null' which returns all the targets.

userState: Object

cancellationToken: CancellationToken

The cancellation token to cancel operation.

Returns

Task<List<DeploymentMachine>>

Applies to

Feedback

Was this page helpful?