deployment_gate_evaluations
Creates, updates, deletes, gets or lists a deployment_gate_evaluations resource.
Overview
| Name | deployment_gate_evaluations |
| Type | Resource |
| Id | datadog.software_delivery.deployment_gate_evaluations |
Fields
The following fields are returned by SELECT queries:
- get_deployment_gates_evaluation_result
| Name | Datatype | Description |
|---|---|---|
id | string | The unique identifier of the evaluation. (example: e9d2f04f-4f4b-494b-86e5-52f03e10c8e9) |
attributes | object | Attributes for a deployment gate evaluation result response. |
type | string | JSON:API type for a deployment gate evaluation result response. (deployment_gates_evaluation_result_response) (default: deployment_gates_evaluation_result_response, example: deployment_gates_evaluation_result_response) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_deployment_gates_evaluation_result | select | id | Retrieves the result of a deployment gate evaluation by its evaluation ID.<br />If the evaluation is still in progress, data.attributes.gate_status will be in_progress;<br />continue polling until it returns pass or fail.<br />Polling every 10-20 seconds is recommended.<br />The endpoint may return a 404 if called too soon after triggering; retry after a few seconds. | |
trigger_deployment_gates_evaluation | exec | data | Triggers an asynchronous deployment gate evaluation for the given service and environment.<br />Returns an evaluation ID that can be used to poll for the result via the<br />GET /api/v2/deployments/gates/evaluation/{id} endpoint.<br /><br />When the configuration attribute is provided, rules are evaluated inline from that configuration<br />and no pre-configured gate is required. When configuration is omitted, rules are resolved from the<br />gate pre-configured for the given service and environment through the Datadog UI, API, or Terraform. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
id | string (uuid) | The evaluation ID returned by the trigger endpoint. |
site | string | The Datadog site (region) for your organization, for example datadoghq.com, us3.datadoghq.com, us5.datadoghq.com, ap1.datadoghq.com, ap2.datadoghq.com, datadoghq.eu, ddog-gov.com. Resolved from the DD_SITE environment variable when set. Optional: defaults to datadoghq.com, or the value of the DD_SITE environment variable when set; a WHERE value overrides both. |
SELECT examples
- get_deployment_gates_evaluation_result
Retrieves the result of a deployment gate evaluation by its evaluation ID.<br />If the evaluation is still in progress, data.attributes.gate_status will be in_progress;<br />continue polling until it returns pass or fail.<br />Polling every 10-20 seconds is recommended.<br />The endpoint may return a 404 if called too soon after triggering; retry after a few seconds.
SELECT
id,
attributes,
type
FROM datadog.software_delivery.deployment_gate_evaluations
WHERE id = '{{ id }}' -- required
;
Lifecycle Methods
EXEC variables use wire (API) names.
- trigger_deployment_gates_evaluation
Triggers an asynchronous deployment gate evaluation for the given service and environment.<br />Returns an evaluation ID that can be used to poll for the result via the<br />GET /api/v2/deployments/gates/evaluation/{id} endpoint.<br /><br />When the configuration attribute is provided, rules are evaluated inline from that configuration<br />and no pre-configured gate is required. When configuration is omitted, rules are resolved from the<br />gate pre-configured for the given service and environment through the Datadog UI, API, or Terraform.
EXEC datadog.software_delivery.deployment_gate_evaluations.trigger_deployment_gates_evaluation
@@json=
'{
"data": "{{ data }}"
}'
;