tasks

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

Overview

Name	tasks
Type	Resource
Id	ovh.ms_services.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 (activateADSync, activateSharepoint, addADAccount, addADOU, addADSyncAccount, addADUPNSuffix, alterMfaOnAllUsers, changeADPassword, changeADSyncPassword, deactivateADSync, delADOU, deleteADAccount, deleteADSyncAccount, deleteADUPNSuffix, disableADAccountMfa, disableADAccountMfaTemporary, enableADAccountMfa, enableADSyncAccount, generateADSyncClientUrl, resetADAccountMfa, setADAccount, setPasswordPolicy)
status	string	Task status (cancelled, doing, done, error, todo)
todo_date	string (date-time)	Creation date (wire: todoDate)

list

Active Directory task details

Name	Datatype	Description
id	integer	Task id
finish_date	string (date-time)	Completion date (wire: finishDate)
function	string	Function name (activateADSync, activateSharepoint, addADAccount, addADOU, addADSyncAccount, addADUPNSuffix, alterMfaOnAllUsers, changeADPassword, changeADSyncPassword, deactivateADSync, delADOU, deleteADAccount, deleteADSyncAccount, deleteADUPNSuffix, disableADAccountMfa, disableADAccountMfaTemporary, enableADAccountMfa, enableADSyncAccount, generateADSyncClientUrl, resetADAccountMfa, setADAccount, setPasswordPolicy)
status	string	Task status (cancelled, doing, done, error, 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	id, service_name		Get an Active Directory task. Returns the function, status, creation date and completion date of the task.
list	select	service_name	function, status, x_pagination_mode	List Active Directory tasks. Returns the IDs of the tasks of the Active Directory service. Filter them by function or status.

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"}})
id	integer	Task id
service_name	string	The internal name of your Active Directory organization (wire: serviceName)
function	string	Filter the value of function property (=)
status	string	Filter the value of status property (=)
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 an Active Directory task. Returns the function, status, creation date and completion date of the task.

SELECT
id,
finish_date,
function,
status,
todo_date
FROM ovh.ms_services.tasks
WHERE id = '{{ id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List Active Directory tasks. Returns the IDs of the tasks of the Active Directory service. Filter them by function or status.

SELECT
id,
finish_date,
function,
status,
todo_date
FROM ovh.ms_services.tasks
WHERE service_name = '{{ service_name }}' -- required
AND function = '{{ function }}'
AND status = '{{ status }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;