scorecard_outcomes

Creates, updates, deletes, gets or lists a scorecard_outcomes resource.

Overview

Name	scorecard_outcomes
Type	Resource
Id	datadog.apm.scorecard_outcomes

Fields

The following fields are returned by SELECT queries:

list_scorecard_outcomes

Name	Datatype	Description
id	string	The unique ID for a rule outcome.
attributes	object	The JSON:API attributes for an outcome.
relationships	object	The JSON:API relationship to a scorecard rule.
type	string	The JSON:API type for an outcome. (default: outcome, example: outcome)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_scorecard_outcomes	select	region	page[size], page[offset], include, fields[outcome], fields[rule], filter[outcome][service_name], filter[outcome][state], filter[rule][enabled], filter[rule][id], filter[rule][name]	Fetches all rule outcomes.
create_scorecard_outcomes_batch	insert	region		Sets multiple service-rule outcomes in a single batched request.
update_scorecard_outcomes_async	exec	region		Updates multiple scorecard rule outcomes in a single batched request.

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
region	string	(default: datadoghq.com)
fields[outcome]	string	Return only specified values in the outcome attributes.
fields[rule]	string	Return only specified values in the included rule details.
filter[outcome][service_name]	string	Filter the outcomes on a specific service name.
filter[outcome][state]	string	Filter the outcomes by a specific state.
filter[rule][enabled]	boolean	Filter outcomes on whether a rule is enabled/disabled.
filter[rule][id]	string	Filter outcomes based on rule ID.
filter[rule][name]	string	Filter outcomes based on rule name.
include	string	Include related rule details in the response.
page[offset]	integer (int64)	Specific offset to use as the beginning of the returned page.
page[size]	integer (int64)	Size for a given page. The maximum allowed value is 100.

SELECT examples

list_scorecard_outcomes

Fetches all rule outcomes.

SELECT
id,
attributes,
relationships,
type
FROM datadog.apm.scorecard_outcomes
WHERE region = '{{ region }}' -- required
AND page[size] = '{{ page[size] }}'
AND page[offset] = '{{ page[offset] }}'
AND include = '{{ include }}'
AND fields[outcome] = '{{ fields[outcome] }}'
AND fields[rule] = '{{ fields[rule] }}'
AND filter[outcome][service_name] = '{{ filter[outcome][service_name] }}'
AND filter[outcome][state] = '{{ filter[outcome][state] }}'
AND filter[rule][enabled] = '{{ filter[rule][enabled] }}'
AND filter[rule][id] = '{{ filter[rule][id] }}'
AND filter[rule][name] = '{{ filter[rule][name] }}'
;

INSERT examples

create_scorecard_outcomes_batch

Sets multiple service-rule outcomes in a single batched request.

INSERT INTO datadog.apm.scorecard_outcomes (
data__data,
region
)
SELECT 
'{{ data }}',
'{{ region }}'
RETURNING
data,
meta
;

Manifest

# Description fields are for documentation purposes
- name: scorecard_outcomes
  props:
    - name: region
      value: string
      description: Required parameter for the scorecard_outcomes resource.
    - name: data
      value: object
      description: |
        Scorecard outcomes batch request data.

Lifecycle Methods

update_scorecard_outcomes_async

Updates multiple scorecard rule outcomes in a single batched request.

EXEC datadog.apm.scorecard_outcomes.update_scorecard_outcomes_async 
@region='{{ region }}' --required 
@@json=
'{
"data": "{{ data }}"
}'
;