team_links
Creates, updates, deletes, gets or lists a team_links resource.
Overview
| Name | team_links |
| Type | Resource |
| Id | datadog.organization.team_links |
Fields
The following fields are returned by SELECT queries:
- get_team_link
- get_team_links
| Name | Datatype | Description |
|---|---|---|
id | string | The team link's identifier (example: b8626d7e-cedd-11eb-abf5-da7ad0900001) |
attributes | object | Team link attributes |
type | string | Team link type (team_links) (default: team_links, example: team_links) |
| Name | Datatype | Description |
|---|---|---|
id | string | The team link's identifier (example: b8626d7e-cedd-11eb-abf5-da7ad0900001) |
attributes | object | Team link attributes |
type | string | Team link type (team_links) (default: team_links, example: team_links) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_team_link | select | team_id, link_id | Get a single link for a team. | |
get_team_links | select | team_id | Get all links for a given team. | |
create_team_link | insert | team_id, data | Add a new link to a team. | |
update_team_link | update | team_id, link_id, data | Update a team link. | |
delete_team_link | delete | team_id, link_id | Remove a link from a team. |
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 |
|---|---|---|
link_id | string | None |
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. |
team_id | string | None |
SELECT examples
- get_team_link
- get_team_links
Get a single link for a team.
SELECT
id,
attributes,
type
FROM datadog.organization.team_links
WHERE team_id = '{{ team_id }}' -- required
AND link_id = '{{ link_id }}' -- required
;
Get all links for a given team.
SELECT
id,
attributes,
type
FROM datadog.organization.team_links
WHERE team_id = '{{ team_id }}' -- required
;
INSERT examples
- create_team_link
- Manifest
Add a new link to a team.
INSERT INTO datadog.organization.team_links (
data,
team_id
)
SELECT
'{{ data }}' /* required */,
'{{ team_id }}'
RETURNING
data
;
# Description fields are for documentation purposes
- name: team_links
props:
- name: team_id
value: "{{ team_id }}"
description: Required parameter for the team_links resource.
- name: data
description: |
Team link create
value:
attributes:
label: "{{ label }}"
position: {{ position }}
team_id: "{{ team_id }}"
url: "{{ url }}"
type: "{{ type }}"
UPDATE examples
- update_team_link
Update a team link.
UPDATE datadog.organization.team_links
SET
data = '{{ data }}'
WHERE
team_id = '{{ team_id }}' --required
AND link_id = '{{ link_id }}' --required
AND data = '{{ data }}' --required
RETURNING
data;
DELETE examples
- delete_team_link
Remove a link from a team.
DELETE FROM datadog.organization.team_links
WHERE team_id = '{{ team_id }}' --required
AND link_id = '{{ link_id }}' --required
;