service_shared_account_tasks

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

Overview

Name	service_shared_account_tasks
Type	Resource
Id	ovh.email_exchange.service_shared_account_tasks

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	Task id
finish_date	string (date-time)	Completion date (wire: finishDate)
function	string	Function name (activateSharepoint, addAccount, addAccountArchive, addAccountImpersonation, addActiveSyncMailNotification, addAlias, addDistributionGroup, addDistributionGroupManager, addDistributionGroupMember, addDistributionGroupSendAs, addDistributionGroupSendOnBehalfTo, addDomain, addDomainDisclaimer, addExchangeCustomIsolation, addExchangeDomainDKIM, addExchangeRemoteMailbox, addExchangeServiceAuthorizedIp, addExportPstRequest, addExternalContact, addFullAccess, addOutlookLicense, addPublicFolder, addPublicFolderPermission, addResourceAccount, addResourceDelegate, addSendAs, addSendConnector, addSendOnBehalfTo, addSharedAccount, addSharedAccountFullAccess, addSharedAccountSendAs, addSharedAccountSendOnBehalfTo, changeHostname, changePassword, clearDataOnDevice, cloneTemplateExchangePrivate, configureExchangeCustomer, configureExchangeOwaMfa, copyMailbox, createExternalAntiSpamReceiveConnector, deleteAccount, deleteAccountArchive, deleteAccountImpersonation, deleteActiveSyncMailNotification, deleteAlias, deleteDistributionGroup, deleteDistributionGroupManager, deleteDistributionGroupMember, deleteDistributionGroupSendAs, deleteDistributionGroupSendOnBehalfTo, deleteDomain, deleteDomainDisclaimer, deleteExchangeCustomIsolation, deleteExchangeDomainDKIM, deleteExchangeRemoteMailbox, deleteExchangeService, deleteExchangeServiceAuthorizedIp, deleteExportPstRequest, deleteExternalAntiSpamReceiveConnector, deleteExternalContact, deleteFullAccess, deleteOutlookLicense, deletePublicFolder, deletePublicFolderPermission, deleteResourceAccount, deleteResourceDelegate, deleteSendAs, deleteSendConnector, deleteSendOnBehalfTo, deleteSharedAccount, deleteSharedAccountFullAccess, deleteSharedAccountSendAs, deleteSharedAccountSendOnBehalfTo, destroyPrivateVm, diagnoseAccount, disableExchangeDKIM, enableExchangeDKIM, expandDrive, generateOutlookUrl, generatePstUrl, installExchange, installSSL, maintenance, migrationAccount, migrationDisclaimer, migrationExternalContact, migrationHistory, migrationMailingList, migrationResourceAccount, migrationService, reOpenHostedAccount, reOpenOutlookLicense, reOpenPrivateAccount, reOpenPrivateVm, setAccount, setAccountArchive, setAlias, setDistributionGroup, setDns, setDomain, setDomainDisclaimer, setExchangeAccountProtocol, setExchangeRemoteMailbox, setExchangeServiceDevice, setExternalAntiSpamReceiveConnector, setExternalContact, setPublicFolder, setPublicFolderPermission, setResourceAccount, setSendConnector, setService, setSharedAccount, suspendAccount, suspendExchangeService, suspendHostedAccount, suspendOutlookLicense, suspendPrivateAccount, suspendPrivateVm, unsuspendAccount, unsuspendExchangeService, unsuspendHostedAccount, updateExchangeServiceDevice, upgrade2016)
status	string	Task status (canceled, doing, done, error, standby, todo)
todo_date	string (date-time)	Creation date (wire: todoDate)

list

Exchange task details

Name	Datatype	Description
id	integer	Task id
finish_date	string (date-time)	Completion date (wire: finishDate)
function	string	Function name (activateSharepoint, addAccount, addAccountArchive, addAccountImpersonation, addActiveSyncMailNotification, addAlias, addDistributionGroup, addDistributionGroupManager, addDistributionGroupMember, addDistributionGroupSendAs, addDistributionGroupSendOnBehalfTo, addDomain, addDomainDisclaimer, addExchangeCustomIsolation, addExchangeDomainDKIM, addExchangeRemoteMailbox, addExchangeServiceAuthorizedIp, addExportPstRequest, addExternalContact, addFullAccess, addOutlookLicense, addPublicFolder, addPublicFolderPermission, addResourceAccount, addResourceDelegate, addSendAs, addSendConnector, addSendOnBehalfTo, addSharedAccount, addSharedAccountFullAccess, addSharedAccountSendAs, addSharedAccountSendOnBehalfTo, changeHostname, changePassword, clearDataOnDevice, cloneTemplateExchangePrivate, configureExchangeCustomer, configureExchangeOwaMfa, copyMailbox, createExternalAntiSpamReceiveConnector, deleteAccount, deleteAccountArchive, deleteAccountImpersonation, deleteActiveSyncMailNotification, deleteAlias, deleteDistributionGroup, deleteDistributionGroupManager, deleteDistributionGroupMember, deleteDistributionGroupSendAs, deleteDistributionGroupSendOnBehalfTo, deleteDomain, deleteDomainDisclaimer, deleteExchangeCustomIsolation, deleteExchangeDomainDKIM, deleteExchangeRemoteMailbox, deleteExchangeService, deleteExchangeServiceAuthorizedIp, deleteExportPstRequest, deleteExternalAntiSpamReceiveConnector, deleteExternalContact, deleteFullAccess, deleteOutlookLicense, deletePublicFolder, deletePublicFolderPermission, deleteResourceAccount, deleteResourceDelegate, deleteSendAs, deleteSendConnector, deleteSendOnBehalfTo, deleteSharedAccount, deleteSharedAccountFullAccess, deleteSharedAccountSendAs, deleteSharedAccountSendOnBehalfTo, destroyPrivateVm, diagnoseAccount, disableExchangeDKIM, enableExchangeDKIM, expandDrive, generateOutlookUrl, generatePstUrl, installExchange, installSSL, maintenance, migrationAccount, migrationDisclaimer, migrationExternalContact, migrationHistory, migrationMailingList, migrationResourceAccount, migrationService, reOpenHostedAccount, reOpenOutlookLicense, reOpenPrivateAccount, reOpenPrivateVm, setAccount, setAccountArchive, setAlias, setDistributionGroup, setDns, setDomain, setDomainDisclaimer, setExchangeAccountProtocol, setExchangeRemoteMailbox, setExchangeServiceDevice, setExternalAntiSpamReceiveConnector, setExternalContact, setPublicFolder, setPublicFolderPermission, setResourceAccount, setSendConnector, setService, setSharedAccount, suspendAccount, suspendExchangeService, suspendHostedAccount, suspendOutlookLicense, suspendPrivateAccount, suspendPrivateVm, unsuspendAccount, unsuspendExchangeService, unsuspendHostedAccount, updateExchangeServiceDevice, upgrade2016)
status	string	Task status (canceled, doing, done, error, standby, todo)
todo_date	string (date-time)	Creation date (wire: todoDate)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	exchange_service, id, organization_name, shared_email_address		Get a task. Returns the function, the status, the creation date (todoDate) and the completion date (finishDate) of the task.
list	select	exchange_service, organization_name, shared_email_address	x_pagination_mode	List shared account tasks. Returns the IDs of the tasks of the shared account. Get one to follow its function, status and dates.

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)
id	integer	Task id
organization_name	string	The internal name of your exchange organization (wire: organizationName)
shared_email_address	string	Default email for this shared mailbox (wire: sharedEmailAddress)
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 a task. Returns the function, the status, the creation date (todoDate) and the completion date (finishDate) of the task.

SELECT
id,
finish_date,
function,
status,
todo_date
FROM ovh.email_exchange.service_shared_account_tasks
WHERE exchange_service = '{{ exchange_service }}' -- required
AND id = '{{ id }}' -- required
AND organization_name = '{{ organization_name }}' -- required
AND shared_email_address = '{{ shared_email_address }}' -- required
;

list

List shared account tasks. Returns the IDs of the tasks of the shared account. Get one to follow its function, status and dates.

SELECT
id,
finish_date,
function,
status,
todo_date
FROM ovh.email_exchange.service_shared_account_tasks
WHERE exchange_service = '{{ exchange_service }}' -- required
AND organization_name = '{{ organization_name }}' -- required
AND shared_email_address = '{{ shared_email_address }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;