Function: deleteDeploymentByKey()

function deleteDeploymentByKey(
   client, 
   parameters, 
   options?
): Promise<void>;

Defined in: src/agile/api/deployments.ts:107

Delete the currently stored deployment data for the given pipelineId, environmentId and deploymentSequenceNumber combination.

Deletion is performed asynchronously. The getDeploymentByKey operation can be used to confirm that data has been deleted successfully (if needed).

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ deploymentSequenceNumber: number; environmentId: string; pipelineId: string; }	-
parameters.deploymentSequenceNumber	number	The deployment's deploymentSequenceNumber.
parameters.environmentId?	string	The ID of the deployment's environment.
parameters.pipelineId?	string	The ID of the deployment's pipeline.
options?	RequestOptions	-

Returns

Promise<void>