monitorings

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

Overview

Name	monitorings
Type	Resource
Id	ovh.ovh_cloud_connect.monitorings

Fields

The following fields are returned by SELECT queries:

list

OVHcloud Connect Monitoring

Name	Datatype	Description
name	string	Name of the monitoring alert
activated	boolean	Whether alert is activated
description	string	Description of the monitoring alert
type	string	Type of the monitoring alert

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	service_name		Returns each alert type available on the service and whether it is active.
create	insert	service_name		Activates exactly the alert types listed; any type left out is turned off.
delete	delete	service_name		Turns off every alert of the service.

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
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
service_name	string (uuid)	Service name (wire: serviceName)

SELECT examples

list

Returns each alert type available on the service and whether it is active.

SELECT
name,
activated,
description,
type
FROM ovh.ovh_cloud_connect.monitorings
WHERE service_name = '{{ service_name }}' -- required
;

INSERT examples

create

Activates exactly the alert types listed; any type left out is turned off.

INSERT INTO ovh.ovh_cloud_connect.monitorings (
subscriptions,
service_name
)
SELECT 
'{{ subscriptions }}',
'{{ service_name }}'
;

Manifest

# Description fields are for documentation purposes
- name: monitorings
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the monitorings resource.
  - name: subscriptions
    value:
      - "{{ subscriptions }}"
    description: |
      List of subscriptions alerts.

DELETE examples

delete

Turns off every alert of the service.

DELETE FROM ovh.ovh_cloud_connect.monitorings
WHERE service_name = '{{ service_name }}' --required
;