email_exchange_service_accounts

Creates, updates, deletes, gets or lists an email_exchange_service_accounts resource.

Overview

Name	email_exchange_service_accounts
Type	Resource
Id	ovh.order.email_exchange_service_accounts

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
order_id	integer	Identifier of the order (wire: orderId)
contracts	array	List of contracts related to the order
details	array	Details of the order
prices	object	Prices of the order including with and without taxes
url	string	URL to download the order

list

An order

Name	Datatype	Description
order_id	integer	Identifier of the order (wire: orderId)
contracts	array	List of contracts related to the order
details	array	Details of the order
prices	object	Prices of the order including with and without taxes
url	string	URL to download the order

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	duration, exchange_service, licence, number, organization_name	storage_quota	Get prices and contracts information
list	select	exchange_service, licence, number, organization_name	storage_quota, x_pagination_mode	Get allowed durations for 'account' option
create	insert	duration, exchange_service, organization_name, licence, number		Create order

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"}})
duration	string	Duration
exchange_service	string	The internal name of your exchange service (wire: exchangeService)
licence	string	Licence type for the account
number	integer	Number of Accounts to order
organization_name	string	The internal name of your exchange organization (wire: organizationName)
storage_quota	integer	The storage quota for the account(s) in GB (default = 50) (wire: storageQuota)
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

Get prices and contracts information

SELECT
order_id,
contracts,
details,
prices,
url
FROM ovh.order.email_exchange_service_accounts
WHERE duration = '{{ duration }}' -- required
AND exchange_service = '{{ exchange_service }}' -- required
AND licence = '{{ licence }}' -- required
AND number = '{{ number }}' -- required
AND organization_name = '{{ organization_name }}' -- required
AND storage_quota = '{{ storage_quota }}'
;

list

Get allowed durations for 'account' option

SELECT
order_id,
contracts,
details,
prices,
url
FROM ovh.order.email_exchange_service_accounts
WHERE exchange_service = '{{ exchange_service }}' -- required
AND licence = '{{ licence }}' -- required
AND number = '{{ number }}' -- required
AND organization_name = '{{ organization_name }}' -- required
AND storage_quota = '{{ storage_quota }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create order

INSERT INTO ovh.order.email_exchange_service_accounts (
licence,
number,
storage_quota,
duration,
exchange_service,
organization_name
)
SELECT 
'{{ licence }}' /* required */,
{{ number }} /* required */,
{{ storage_quota }},
'{{ duration }}',
'{{ exchange_service }}',
'{{ organization_name }}'
RETURNING
order_id,
contracts,
details,
prices,
url
;

Manifest

# Description fields are for documentation purposes
- name: email_exchange_service_accounts
props:
  - name: duration
    value: "{{ duration }}"
    description: Required parameter for the email_exchange_service_accounts resource.
  - name: exchange_service
    value: "{{ exchange_service }}"
    description: Required parameter for the email_exchange_service_accounts resource.
  - name: organization_name
    value: "{{ organization_name }}"
    description: Required parameter for the email_exchange_service_accounts resource.
  - name: licence
    value: "{{ licence }}"
    description: |
      OVH licence account
    valid_values: ['basic', 'enterprise', 'standard']
  - name: number
    value: {{ number }}
    description: |
      Number of Accounts to order
  - name: storage_quota
    value: {{ storage_quota }}
    description: |
      Storage quota options in GB
    valid_values: ['50', '300']