service_log_subscriptions

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

Overview

Name	service_log_subscriptions
Type	Resource
Id	ovh.email_exchange.service_log_subscriptions

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
stream_id	string	Id of the destination log stream (wire: streamId)
subscription_id	string (uuid)	Subscription ID (wire: subscriptionId)
service_name	string	Name of the destination log service (wire: serviceName)
created_at	string (date-time)	Creation date of the subscription (wire: createdAt)
kind	string	Log kind name of this subscription
resource	object	Subscribed resource, where the logs come from
updated_at	string (date-time)	Last update date of the subscription (wire: updatedAt)

list

Log subscription

Name	Datatype	Description
stream_id	string	Id of the destination log stream (wire: streamId)
subscription_id	string (uuid)	Subscription ID (wire: subscriptionId)
service_name	string	Name of the destination log service (wire: serviceName)
created_at	string (date-time)	Creation date of the subscription (wire: createdAt)
kind	string	Log kind name of this subscription
resource	object	Subscribed resource, where the logs come from
updated_at	string (date-time)	Last update date of the subscription (wire: updatedAt)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	exchange_service, organization_name, subscription_id		Returns the log kind and the destination stream of a subscription. (Alpha version)
list	select	exchange_service, organization_name	kind, x_pagination_mode	Returns the identifiers of the Exchange log subscriptions. Set kind to restrict the list to one log kind. (Alpha version)
create	insert	exchange_service, organization_name, kind, stream_id		Forwards Exchange logs of one kind to a Logs Data Platform stream. The subscription is created asynchronously and the response returns the operation identifier. (Alpha version)
delete	delete	exchange_service, organization_name, subscription_id		Deletes the subscription and stops forwarding Exchange logs to the stream. (Alpha version)

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"}})
exchange_service	string	The internal name of your exchange service (wire: exchangeService)
organization_name	string	The internal name of your exchange organization (wire: organizationName)
subscription_id	string (uuid)	Subscription ID (wire: subscriptionId)
kind	string	Filter on a specific kind (e.g., audit)
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Returns the log kind and the destination stream of a subscription. (Alpha version)

SELECT
stream_id,
subscription_id,
service_name,
created_at,
kind,
resource,
updated_at
FROM ovh.email_exchange.service_log_subscriptions
WHERE exchange_service = '{{ exchange_service }}' -- required
AND organization_name = '{{ organization_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Returns the identifiers of the Exchange log subscriptions. Set kind to restrict the list to one log kind. (Alpha version)

SELECT
stream_id,
subscription_id,
service_name,
created_at,
kind,
resource,
updated_at
FROM ovh.email_exchange.service_log_subscriptions
WHERE exchange_service = '{{ exchange_service }}' -- required
AND organization_name = '{{ organization_name }}' -- required
AND kind = '{{ kind }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Forwards Exchange logs of one kind to a Logs Data Platform stream. The subscription is created asynchronously and the response returns the operation identifier. (Alpha version)

INSERT INTO ovh.email_exchange.service_log_subscriptions (
kind,
stream_id,
exchange_service,
organization_name
)
SELECT 
'{{ kind }}' /* required */,
'{{ stream_id }}' /* required */,
'{{ exchange_service }}',
'{{ organization_name }}'
RETURNING
operation_id,
service_name
;

Manifest

# Description fields are for documentation purposes
- name: service_log_subscriptions
props:
  - name: exchange_service
    value: "{{ exchange_service }}"
    description: Required parameter for the service_log_subscriptions resource.
  - name: organization_name
    value: "{{ organization_name }}"
    description: Required parameter for the service_log_subscriptions resource.
  - name: kind
    value: "{{ kind }}"
    description: |
      Log kind name to subscribe to
  - name: stream_id
    value: "{{ stream_id }}"
    description: |
      Customer log stream ID

DELETE examples

delete

Deletes the subscription and stops forwarding Exchange logs to the stream. (Alpha version)

DELETE FROM ovh.email_exchange.service_log_subscriptions
WHERE exchange_service = '{{ exchange_service }}' --required
AND organization_name = '{{ organization_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;