Targets - Delete

Service:

Task Agent

API Version:

5.0-preview.1

Delete a deployment target in a deployment group. This deletes the agent from associated deployment pool too.

DELETE https://dev.azure.com/{organization}/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}/targets/{targetId}?api-version=5.0-preview.1

URI Parameters

Name	In	Required	Type	Description
deploymentGroupId	path	True	integer int32	ID of the deployment group in which deployment target is deleted.
organization	path	True	string	The name of the Azure DevOps organization.
project	path	True	string	Project ID or project name
targetId	path	True	integer int32	ID of the deployment target to delete.
api-version	query	True	string	Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.

Responses

Name	Type	Description
200 OK		successful operation

Security

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

Name	Description
vso.machinegroup_manage	Provides ability to manage deployment group and agent pools

Examples

Delete a deployment target

Sample Request

HTTP

DELETE https://dev.azure.com/fabrikam/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}/targets/{targetId}?api-version=5.0-preview.1

Sample Response

Status code:

204