account_migrates
Creates, updates, deletes, gets or lists an account_migrates resource.
Overview​
| Name | account_migrates |
| Type | Resource |
| Id | ovh.email_domain.account_migrates |
Fields​
The following fields are returned by SELECT queries:
- get
- list
successful operation
| Name | Datatype | Description |
|---|---|---|
destination_service_name | string | Service name allowed as migration destination (wire: destinationServiceName) |
contact_admin | string | Admin contact of service (wire: contactAdmin) |
contact_billing | string | Billing contact of service (wire: contactBilling) |
contact_tech | string | Tech contact of service (wire: contactTech) |
creation | string (date) | Creation date of service |
expiration | string (date) | Expiration date of service |
type | string | Offer type of service (EMAIL PRO, HOSTED EXCHANGE, PRIVATE EXCHANGE, PROVIDER EXCHANGE) |
Migration service
| Name | Datatype | Description |
|---|---|---|
destination_service_name | string | Service name allowed as migration destination (wire: destinationServiceName) |
contact_admin | string | Admin contact of service (wire: contactAdmin) |
contact_billing | string | Billing contact of service (wire: contactBilling) |
contact_tech | string | Tech contact of service (wire: contactTech) |
creation | string (date) | Creation date of service |
expiration | string (date) | Expiration date of service |
type | string | Offer type of service (EMAIL PRO, HOSTED EXCHANGE, PRIVATE EXCHANGE, PROVIDER EXCHANGE) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | account_name, destination_service_name, domain | Get a migration destination. Returns the offer type, creation and expiration dates, and admin, tech and billing contacts of the destination service. (Beta version) | |
list | select | account_name, domain | type, x_pagination_mode | List migration destinations. Returns the names of the services the email account can be migrated to. Filter them by type: Email Pro, hosted, private or provider Exchange. (Beta 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 |
|---|---|---|
account_name | string | Name of account (wire: accountName) |
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"}}) |
destination_service_name | string | Service name allowed as migration destination (wire: destinationServiceName) |
domain | string | Name of your domain name |
type | string | Type of migration service |
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
- list
Get a migration destination. Returns the offer type, creation and expiration dates, and admin, tech and billing contacts of the destination service. (Beta version)
SELECT
destination_service_name,
contact_admin,
contact_billing,
contact_tech,
creation,
expiration,
type
FROM ovh.email_domain.account_migrates
WHERE account_name = '{{ account_name }}' -- required
AND destination_service_name = '{{ destination_service_name }}' -- required
AND domain = '{{ domain }}' -- required
;
List migration destinations. Returns the names of the services the email account can be migrated to. Filter them by type: Email Pro, hosted, private or provider Exchange. (Beta version)
SELECT
destination_service_name,
contact_admin,
contact_billing,
contact_tech,
creation,
expiration,
type
FROM ovh.email_domain.account_migrates
WHERE account_name = '{{ account_name }}' -- required
AND domain = '{{ domain }}' -- required
AND type = '{{ type }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;