Function: getDeploymentGatingStatusByKey()

function getDeploymentGatingStatusByKey(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  deploymentSequenceNumber?: number;
  details?: object[];
  environmentId?: string;
  gatingStatus?: "invalid" | string & object | "allowed" | "prevented" | "awaiting";
  pipelineId?: string;
  updatedTimestamp?: Date;
}>;

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

Retrieve the Deployment gating status for the given pipelineId + environmentId + deploymentSequenceNumber combination. Only apps that define the jiraDeploymentInfoProvider module can access this resource. This resource requires the 'READ' scope.

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<{ [key: string]: unknown; deploymentSequenceNumber?: number; details?: object[]; environmentId?: string; gatingStatus?: "invalid" | string & object | "allowed" | "prevented" | "awaiting"; pipelineId?: string; updatedTimestamp?: Date; }>