account_syncs

Creates, updates, deletes, gets or lists an account_syncs resource.

Overview

Name	account_syncs
Type	Resource
Id	ovh.ms_services.account_syncs

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
task_pending_id	integer	Pending task for this sync account (wire: taskPendingId)
configured	boolean	Indicates if the account is configured
license	string	Sync account license (standard, standardFree)
state	string	Sync account state (creating, deleting, disabled, modifying, 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, user_principal_name		Get the account synchronization (Deprecated, will be removed)
create	insert	service_name, user_principal_name, license		Create new sync account (Deprecated, will be removed)
delete	delete	service_name, user_principal_name		Delete sync account (Deprecated, will be removed)
configure	exec	serviceName, userPrincipalName		Configure sync account to be operational (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)
userPrincipalName	string	User Principal Name
user_principal_name	string	User Principal Name (wire: userPrincipalName)

SELECT examples

get

Get the account synchronization (Deprecated, will be removed)

SELECT
task_pending_id,
configured,
license,
state
FROM ovh.ms_services.account_syncs
WHERE service_name = '{{ service_name }}' -- required
AND user_principal_name = '{{ user_principal_name }}' -- required
;

INSERT examples

create

Create new sync account (Deprecated, will be removed)

INSERT INTO ovh.ms_services.account_syncs (
license,
service_name,
user_principal_name
)
SELECT 
'{{ license }}' /* required */,
'{{ service_name }}',
'{{ user_principal_name }}'
RETURNING
id,
finish_date,
function,
status,
todo_date
;

Manifest

# Description fields are for documentation purposes
- name: account_syncs
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the account_syncs resource.
  - name: user_principal_name
    value: "{{ user_principal_name }}"
    description: Required parameter for the account_syncs resource.
  - name: license
    value: "{{ license }}"
    description: |
      Sync account license
    valid_values: ['standard', 'standardFree']

DELETE examples

delete

Delete sync account (Deprecated, will be removed)

DELETE FROM ovh.ms_services.account_syncs
WHERE service_name = '{{ service_name }}' --required
AND user_principal_name = '{{ user_principal_name }}' --required
;

Lifecycle Methods

EXEC variables use wire (API) names.

configure

Configure sync account to be operational (Deprecated, will be removed)

EXEC ovh.ms_services.account_syncs.configure 
@serviceName='{{ serviceName }}' --required, 
@userPrincipalName='{{ userPrincipalName }}' --required
;