dedicated_horizon_users

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

Overview

Name	dedicated_horizon_users
Type	Resource
Id	ovh.horizon_view.dedicated_horizon_users

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
username	string	Username of your HaaS User

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_name		Get this object properties
change_password	exec	serviceName		Change Horizon View user password
change_properties	exec	serviceName		Change horizon view user properties

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	Domain of the service
service_name	string	Domain of the service (wire: serviceName)

SELECT examples

get

Get this object properties

SELECT
username
FROM ovh.horizon_view.dedicated_horizon_users
WHERE service_name = '{{ service_name }}' -- required
;

Lifecycle Methods

EXEC variables use wire (API) names.

change_password

Change Horizon View user password

EXEC ovh.horizon_view.dedicated_horizon_users.change_password 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"password": "{{ password }}"
}'
;

change_properties

Change horizon view user properties

EXEC ovh.horizon_view.dedicated_horizon_users.change_properties 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"email": "{{ email }}"
}'
;