syncs
Creates, updates, deletes, gets or lists a syncs resource.
Overview​
| Name | syncs |
| Type | Resource |
| Id | ovh.ms_services.syncs |
Fields​
The following fields are returned by SELECT queries:
- get
successful operation
| Name | Datatype | Description |
|---|---|---|
task_pending_id | integer | Task pending id (wire: taskPendingId) |
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 synchronization service (Deprecated, will be removed) | |
delete | delete | service_name | Delete sync service (Deprecated, will be removed) | |
change_password | exec | serviceName, password | Change account password (Deprecated, will be removed) |
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"}}) |
serviceName | string | The internal name of your Active Directory organization |
service_name | string | The internal name of your Active Directory organization (wire: serviceName) |
SELECT examples​
- get
Get the synchronization service (Deprecated, will be removed)
SELECT
task_pending_id,
state
FROM ovh.ms_services.syncs
WHERE service_name = '{{ service_name }}' -- required
;
DELETE examples​
- delete
Delete sync service (Deprecated, will be removed)
DELETE FROM ovh.ms_services.syncs
WHERE service_name = '{{ service_name }}' --required
;
Lifecycle Methods​
EXEC variables use wire (API) names.
- change_password
Change account password (Deprecated, will be removed)
EXEC ovh.ms_services.syncs.change_password
@serviceName='{{ serviceName }}' --required
@@json=
'{
"password": "{{ password }}"
}'
;