exchanges
Creates, updates, deletes, gets or lists an exchanges resource.
Overview​
| Name | exchanges |
| Type | Resource |
| Id | ovh.ms_services.exchanges |
Fields​
The following fields are returned by SELECT queries:
- get
successful operation
| Name | Datatype | Description |
|---|---|---|
task_pending_id | integer | Task pending id (wire: taskPendingId) |
display_name | string | Service family name displayed (wire: displayName) |
domain | string | Exchange service name |
hostname | string | Exchange service URL |
max_receive_size | integer | Maximum allowable size for received messages in MB (wire: maxReceiveSize) |
max_send_size | integer | Maximum allowable size of sent messages in MB (wire: maxSendSize) |
offer | string | Exchange service offer (dedicated, dedicatedCluster, hosted, provider) |
spam_and_virus_configuration | object | Spam and Antivirus configuration (wire: spamAndVirusConfiguration) |
ssl_expiration_date | string (date) | Expiration date of SSL certificate (wire: sslExpirationDate) |
state | string | Exchange service state (creating, deleting, inMaintenance, ok, reopening, suspended, suspending) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | service_name | Get the linked Exchange service. Returns the Exchange service linked to the Active Directory service: offer, hostname, state, SSL certificate expiration date, message size limits and spam and antivirus configuration. | |
update | update | service_name | Update the linked Exchange service. Updates the display name, the maximum sizes of sent and received messages in MB, and the spam and antivirus configuration of the Exchange 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 | The internal name of your Active Directory organization (wire: serviceName) |
SELECT examples​
- get
Get the linked Exchange service. Returns the Exchange service linked to the Active Directory service: offer, hostname, state, SSL certificate expiration date, message size limits and spam and antivirus configuration.
SELECT
task_pending_id,
display_name,
domain,
hostname,
max_receive_size,
max_send_size,
offer,
spam_and_virus_configuration,
ssl_expiration_date,
state
FROM ovh.ms_services.exchanges
WHERE service_name = '{{ service_name }}' -- required
;
UPDATE examples​
- update
Update the linked Exchange service. Updates the display name, the maximum sizes of sent and received messages in MB, and the spam and antivirus configuration of the Exchange service.
UPDATE ovh.ms_services.exchanges
SET
display_name = '{{ display_name }}',
max_receive_size = {{ max_receive_size }},
max_send_size = {{ max_send_size }},
spam_and_virus_configuration = '{{ spam_and_virus_configuration }}'
WHERE
service_name = '{{ service_name }}' --required;