service_account_exports

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

Overview

Name	service_account_exports
Type	Resource
Id	ovh.email_exchange.service_account_exports

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
task_pending_id	integer	Task pending id (wire: taskPendingId)
creation_date	string (date-time)	Creation date (wire: creationDate)
percent_complete	integer	Percentage of export PST request completion (wire: percentComplete)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	exchange_service, organization_name, primary_email_address		Get the PST export. Returns the creation date and the completion percentage of the PST export of the email account.
create	insert	exchange_service, organization_name, primary_email_address		Request a PST export. Starts the export of the email account to a PST file, and returns the task. Follow its progress in percentComplete.
delete	delete	exchange_service, organization_name, primary_email_address		Delete the PST export. Deletes the PST file exported from the email account and its download URL, and returns the task.

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)
primary_email_address	string	Default email for this mailbox (wire: primaryEmailAddress)

SELECT examples

get

Get the PST export. Returns the creation date and the completion percentage of the PST export of the email account.

SELECT
task_pending_id,
creation_date,
percent_complete
FROM ovh.email_exchange.service_account_exports
WHERE exchange_service = '{{ exchange_service }}' -- required
AND organization_name = '{{ organization_name }}' -- required
AND primary_email_address = '{{ primary_email_address }}' -- required
;

INSERT examples

create

Request a PST export. Starts the export of the email account to a PST file, and returns the task. Follow its progress in percentComplete.

INSERT INTO ovh.email_exchange.service_account_exports (
exchange_service,
organization_name,
primary_email_address
)
SELECT 
'{{ exchange_service }}',
'{{ organization_name }}',
'{{ primary_email_address }}'
RETURNING
id,
finish_date,
function,
status,
todo_date
;

Manifest

# Description fields are for documentation purposes
- name: service_account_exports
props:
  - name: exchange_service
    value: "{{ exchange_service }}"
    description: Required parameter for the service_account_exports resource.
  - name: organization_name
    value: "{{ organization_name }}"
    description: Required parameter for the service_account_exports resource.
  - name: primary_email_address
    value: "{{ primary_email_address }}"
    description: Required parameter for the service_account_exports resource.

DELETE examples

delete

Delete the PST export. Deletes the PST file exported from the email account and its download URL, and returns the task.

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