account_sharepoints

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

Overview

Name	account_sharepoints
Type	Resource
Id	ovh.ms_services.account_sharepoints

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	Sharepoint account id
active_directory_account_id	integer	Active Directory Account id (wire: activeDirectoryAccountId)
task_pending_id	integer	Pending task for this sharepoint account (wire: taskPendingId)
access_rights	string	The rights assigned to the sharepoint account (administrator, user) (wire: accessRights)
configured	boolean	Indicates if the account is configured
current_usage	integer	OneDrive usage in byte (wire: currentUsage)
delete_at_expiration	boolean	delete at expiration (wire: deleteAtExpiration)
license	string	Sharepoint account license (foundation, standard)
office_license	boolean	office license is available (wire: officeLicense)
quota	integer	OneDrive maximum size in byte
state	string	Sharepoint 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 SharePoint information (Deprecated, will be removed)
update	update	service_name, user_principal_name		Alter this object properties (Deprecated, will be removed)
clear_space	exec	serviceName, userPrincipalName		On-demand MySite clearance (Deprecated, will be removed)
configure	exec	serviceName, userPrincipalName		Configure sharepoint 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 SharePoint information (Deprecated, will be removed)

SELECT
id,
active_directory_account_id,
task_pending_id,
access_rights,
configured,
current_usage,
delete_at_expiration,
license,
office_license,
quota,
state
FROM ovh.ms_services.account_sharepoints
WHERE service_name = '{{ service_name }}' -- required
AND user_principal_name = '{{ user_principal_name }}' -- required
;

UPDATE examples

update

Alter this object properties (Deprecated, will be removed)

UPDATE ovh.ms_services.account_sharepoints
SET 
access_rights = '{{ access_rights }}',
delete_at_expiration = {{ delete_at_expiration }},
office_license = {{ office_license }}
WHERE 
service_name = '{{ service_name }}' --required
AND user_principal_name = '{{ user_principal_name }}' --required;

Lifecycle Methods

EXEC variables use wire (API) names.

clear_space

On-demand MySite clearance (Deprecated, will be removed)

EXEC ovh.ms_services.account_sharepoints.clear_space 
@serviceName='{{ serviceName }}' --required, 
@userPrincipalName='{{ userPrincipalName }}' --required
;

configure

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

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