sharepoints

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

Overview

Name	sharepoints
Type	Resource
Id	ovh.ms_services.sharepoints

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
domain	string	Internal service name
iam	object	IAM resource metadata

get_by_service_name

successful operation

Name	Datatype	Description
task_pending_id	integer	Task pending id (wire: taskPendingId)
display_name	string	Service family name displayed (wire: displayName)
current_usage	integer	Shared space usage in byte (wire: currentUsage)
domain	string	Internal service name
farm_url	string	Sharepoint farm url (wire: farmUrl)
offer	string	Sharepoint offer (hosted, provider)
quota	integer	Shared space maximum size in byte
state	string	Sharepoint service state (creating, deleting, inMaintenance, ok, reopening, suspended, suspending)
url	string	Sharepoint url

list

Sharepoint service

Name	Datatype	Description
domain	string	Internal service name
iam	object	IAM resource metadata

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	domain		Get SharePoint service information (Deprecated, will be removed)
get_by_service_name	select	service_name		Get the SharePoint service (Deprecated, will be removed)
list	select		iam_tags, x_pagination_mode	List available services (Deprecated, will be removed)
update	update	service_name		Alter this object properties (Deprecated, will be removed)
restore_admin_rights	exec	serviceName		Restore administrator rights (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"}})
domain	string	Sharepoint customer's service
serviceName	string	The internal name of your Active Directory organization
service_name	string	The internal name of your Active Directory organization (wire: serviceName)
iam_tags	object	Filter resources on IAM tags (wire: iamTags)
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 SharePoint service information (Deprecated, will be removed)

SELECT
domain,
iam
FROM ovh.ms_services.sharepoints
WHERE domain = '{{ domain }}' -- required
;

get_by_service_name

Get the SharePoint service (Deprecated, will be removed)

SELECT
task_pending_id,
display_name,
current_usage,
domain,
farm_url,
offer,
quota,
state,
url
FROM ovh.ms_services.sharepoints
WHERE service_name = '{{ service_name }}' -- required
;

list

List available services (Deprecated, will be removed)

SELECT
domain,
iam
FROM ovh.ms_services.sharepoints
WHERE iam_tags = '{{ iam_tags }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

UPDATE examples

update

Alter this object properties (Deprecated, will be removed)

UPDATE ovh.ms_services.sharepoints
SET 
display_name = '{{ display_name }}',
url = '{{ url }}'
WHERE 
service_name = '{{ service_name }}' --required;

Lifecycle Methods

EXEC variables use wire (API) names.

restore_admin_rights

Restore administrator rights (Deprecated, will be removed)

EXEC ovh.ms_services.sharepoints.restore_admin_rights 
@serviceName='{{ serviceName }}' --required
;