dedicated_horizon_customer_users

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

Overview

Name	dedicated_horizon_customer_users
Type	Resource
Id	ovh.horizon_view.dedicated_horizon_customer_users

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	Customer id
email	string	Email of your HaaS User
username	string	Customer username of your HaaS User

list

Horizon As A Service Customer User

Name	Datatype	Description
id	integer	Customer id
email	string	Email of your HaaS User
username	string	Customer 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, username		Get this object properties
list	select	service_name	x_pagination_mode	Account to access to your pool
create	insert	service_name, username		Create a new customer user
delete	delete	service_name, username		Delete this Customer User
change_password	exec	serviceName, username		Change Horizon View Customer user password

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)
username	string	Customer username of your HaaS User
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 this object properties

SELECT
id,
email,
username
FROM ovh.horizon_view.dedicated_horizon_customer_users
WHERE service_name = '{{ service_name }}' -- required
AND username = '{{ username }}' -- required
;

list

Account to access to your pool

SELECT
id,
email,
username
FROM ovh.horizon_view.dedicated_horizon_customer_users
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create a new customer user

INSERT INTO ovh.horizon_view.dedicated_horizon_customer_users (
email,
password,
username,
service_name
)
SELECT 
'{{ email }}',
'{{ password }}',
'{{ username }}' /* required */,
'{{ service_name }}'
RETURNING
name,
task_id,
description,
last_modification_date,
progress,
state
;

Manifest

# Description fields are for documentation purposes
- name: dedicated_horizon_customer_users
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the dedicated_horizon_customer_users resource.
  - name: email
    value: "{{ email }}"
    description: |
      Email for your new user in Active diRectory.
  - name: password
    value: "{{ password }}"
    description: |
      New password for this Horizon View user. It must fits your HaaS password policy. If this field is empty, a random password will be generated and sent to your  email.
  - name: username
    value: "{{ username }}"
    description: |
      Username for your new user in Active Directory.

DELETE examples

delete

Delete this Customer User

DELETE FROM ovh.horizon_view.dedicated_horizon_customer_users
WHERE service_name = '{{ service_name }}' --required
AND username = '{{ username }}' --required
;

Lifecycle Methods

EXEC variables use wire (API) names.

change_password

Change Horizon View Customer user password

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