service_definitions

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

Overview

Name	service_definitions
Type	Resource
Id	datadog.service_management.service_definitions

Fields

The following fields are returned by SELECT queries:

get_service_definition

Name	Datatype	Description
id	string	Service definition id.
attributes	object	Service definition attributes.
type	string	Service definition type.

list_service_definitions

Name	Datatype	Description
id	string	Service definition id.
attributes	object	Service definition attributes.
type	string	Service definition type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_service_definition	select	service_name, region	schema_version	Get a single service definition from the Datadog Service Catalog.
list_service_definitions	select	region	page[size], page[number], schema_version	Get a list of all service definitions from the Datadog Service Catalog.
create_or_update_service_definitions	insert	region, data__schema-version, data__dd-service		Create or update service definition in the Datadog Service Catalog.
delete_service_definition	delete	service_name, region		Delete a single service definition in the Datadog Service Catalog.

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)
service_name	string	The name of the service.
page[number]	integer (int64)	Specific page number to return.
page[size]	integer (int64)	Size for a given page. The maximum allowed value is 100.
schema_version	string	The schema version desired in the response.

SELECT examples

get_service_definition

Get a single service definition from the Datadog Service Catalog.

SELECT
id,
attributes,
type
FROM datadog.service_management.service_definitions
WHERE service_name = '{{ service_name }}' -- required
AND region = '{{ region }}' -- required
AND schema_version = '{{ schema_version }}'
;

list_service_definitions

Get a list of all service definitions from the Datadog Service Catalog.

SELECT
id,
attributes,
type
FROM datadog.service_management.service_definitions
WHERE region = '{{ region }}' -- required
AND page[size] = '{{ page[size] }}'
AND page[number] = '{{ page[number] }}'
AND schema_version = '{{ schema_version }}'
;

INSERT examples

create_or_update_service_definitions

Create or update service definition in the Datadog Service Catalog.

INSERT INTO datadog.service_management.service_definitions (
data__application,
data__ci-pipeline-fingerprints,
data__contacts,
data__dd-service,
data__description,
data__extensions,
data__integrations,
data__languages,
data__lifecycle,
data__links,
data__schema-version,
data__tags,
data__team,
data__tier,
data__type,
region
)
SELECT 
'{{ application }}',
'{{ ci-pipeline-fingerprints }}',
'{{ contacts }}',
'{{ dd-service }}' /* required */,
'{{ description }}',
'{{ extensions }}',
'{{ integrations }}',
'{{ languages }}',
'{{ lifecycle }}',
'{{ links }}',
'{{ schema-version }}' /* required */,
'{{ tags }}',
'{{ team }}',
'{{ tier }}',
'{{ type }}',
'{{ region }}'
RETURNING
data
;

Manifest

# Description fields are for documentation purposes
- name: service_definitions
  props:
    - name: region
      value: string
      description: Required parameter for the service_definitions resource.
    - name: application
      value: string
      description: |
        Identifier for a group of related services serving a product feature, which the service is a part of.
    - name: ci-pipeline-fingerprints
      value: array
      description: |
        A set of CI fingerprints.
    - name: contacts
      value: array
      description: |
        A list of contacts related to the services.
    - name: dd-service
      value: string
      description: |
        Unique identifier of the service. Must be unique across all services and is used to match with a service in Datadog.
    - name: description
      value: string
      description: |
        A short description of the service.
    - name: extensions
      value: object
      description: |
        Extensions to v2.2 schema.
    - name: integrations
      value: object
      description: |
        Third party integrations that Datadog supports.
    - name: languages
      value: array
      description: |
        The service's programming language. Datadog recognizes the following languages: `dotnet`, `go`, `java`, `js`, `php`, `python`, `ruby`, and `c++`.
    - name: lifecycle
      value: string
      description: |
        The current life cycle phase of the service.
    - name: links
      value: array
      description: |
        A list of links related to the services.
    - name: schema-version
      value: string
      description: |
        Schema version being used.
      valid_values: ['v2.2']
      default: v2.2
    - name: tags
      value: array
      description: |
        A set of custom tags.
    - name: team
      value: string
      description: |
        Team that owns the service. It is used to locate a team defined in Datadog Teams if it exists.
    - name: tier
      value: string
      description: |
        Importance of the service.
    - name: type
      value: string
      description: |
        The type of service.

DELETE examples

delete_service_definition

Delete a single service definition in the Datadog Service Catalog.

DELETE FROM datadog.service_management.service_definitions
WHERE service_name = '{{ service_name }}' --required
AND region = '{{ region }}' --required
;