on_call_escalation_policies
Creates, updates, deletes, gets or lists an on_call_escalation_policies
resource.
Overview
Name | on_call_escalation_policies |
Type | Resource |
Id | datadog.service_management.on_call_escalation_policies |
Fields
The following fields are returned by SELECT
queries:
- get_on_call_escalation_policy
Name | Datatype | Description |
---|---|---|
id | string | Specifies the unique identifier of the escalation policy. (example: ab000000-0000-0000-0000-000000000000) |
attributes | object | Defines the main attributes of an escalation policy, such as its name and behavior on policy end. |
relationships | object | Represents the relationships for an escalation policy, including references to steps and teams. |
type | string | Indicates that the resource is of type policies . (default: policies, example: policies) |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get_on_call_escalation_policy | select | policy_id , region | include | Get an On-Call escalation policy |
create_on_call_escalation_policy | insert | region , data__data | include | Create a new On-Call escalation policy |
update_on_call_escalation_policy | replace | policy_id , region , data__data | include | Update an On-Call escalation policy |
delete_on_call_escalation_policy | delete | policy_id , region | Delete an On-Call escalation policy |
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 |
---|---|---|
policy_id | string | The ID of the escalation policy |
region | string | (default: datadoghq.com) |
include | string | Comma-separated list of included relationships to be returned. Allowed values: teams , steps , steps.targets . |
SELECT
examples
- get_on_call_escalation_policy
Get an On-Call escalation policy
SELECT
id,
attributes,
relationships,
type
FROM datadog.service_management.on_call_escalation_policies
WHERE policy_id = '{{ policy_id }}' -- required
AND region = '{{ region }}' -- required
AND include = '{{ include }}'
;
INSERT
examples
- create_on_call_escalation_policy
- Manifest
Create a new On-Call escalation policy
INSERT INTO datadog.service_management.on_call_escalation_policies (
data__data,
region,
include
)
SELECT
'{{ data }}' /* required */,
'{{ region }}',
'{{ include }}'
RETURNING
data,
included
;
# Description fields are for documentation purposes
- name: on_call_escalation_policies
props:
- name: region
value: string
description: Required parameter for the on_call_escalation_policies resource.
- name: data
value: object
description: |
Represents the data for creating an escalation policy, including its attributes, relationships, and resource type.
- name: include
value: string
description: Comma-separated list of included relationships to be returned. Allowed values: `teams`, `steps`, `steps.targets`.
REPLACE
examples
- update_on_call_escalation_policy
Update an On-Call escalation policy
REPLACE datadog.service_management.on_call_escalation_policies
SET
data__data = '{{ data }}'
WHERE
policy_id = '{{ policy_id }}' --required
AND region = '{{ region }}' --required
AND data__data = '{{ data }}' --required
AND include = '{{ include}}'
RETURNING
data,
included;
DELETE
examples
- delete_on_call_escalation_policy
Delete an On-Call escalation policy
DELETE FROM datadog.service_management.on_call_escalation_policies
WHERE policy_id = '{{ policy_id }}' --required
AND region = '{{ region }}' --required
;