roles

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

Overview

Name	roles
Type	Resource
Id	ovh.dbaas_logs.roles

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
name	string	Role name
role_id	string (uuid)	Role ID (wire: roleId)
created_at	string (date-time)	Role creation (wire: createdAt)
description	string	Role description
nb_member	integer	Number of members (wire: nbMember)
nb_permission	integer	Number of permissions (wire: nbPermission)
updated_at	string (date-time)	Role last update (wire: updatedAt)

list

Role

Name	Datatype	Description
name	string	Role name
role_id	string (uuid)	Role ID (wire: roleId)
created_at	string (date-time)	Role creation (wire: createdAt)
description	string	Role description
nb_member	integer	Number of members (wire: nbMember)
nb_permission	integer	Number of permissions (wire: nbPermission)
updated_at	string (date-time)	Role last update (wire: updatedAt)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	role_id, service_name		Returns the role. (Deprecated, will be removed)
list	select	service_name	name_pattern, x_pagination_mode	Returns the roles of the Logs Data Platform service. (Deprecated, will be removed)
create	insert	service_name, description, name		Creates a role on the Logs Data Platform service. (Deprecated, will be removed)
update	update	role_id, service_name, description, name		Updates the role. (Deprecated, will be removed)
delete	delete	role_id, service_name		Deletes the role. (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"}})
role_id	string (uuid)	Role ID (wire: roleId)
service_name	string	Service name (wire: serviceName)
name_pattern	string	Filter by name (like) (wire: namePattern)
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

Returns the role. (Deprecated, will be removed)

SELECT
name,
role_id,
created_at,
description,
nb_member,
nb_permission,
updated_at
FROM ovh.dbaas_logs.roles
WHERE role_id = '{{ role_id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

Returns the roles of the Logs Data Platform service. (Deprecated, will be removed)

SELECT
name,
role_id,
created_at,
description,
nb_member,
nb_permission,
updated_at
FROM ovh.dbaas_logs.roles
WHERE service_name = '{{ service_name }}' -- required
AND name_pattern = '{{ name_pattern }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Creates a role on the Logs Data Platform service. (Deprecated, will be removed)

INSERT INTO ovh.dbaas_logs.roles (
description,
name,
service_name
)
SELECT 
'{{ description }}' /* required */,
'{{ name }}' /* required */,
'{{ service_name }}'
RETURNING
alias_id,
dashboard_id,
encryption_key_id,
index_id,
input_id,
operation_id,
osd_id,
role_id,
stream_id,
subscription_id,
tenant_id,
token_id,
service_name,
created_at,
state,
updated_at
;

Manifest

# Description fields are for documentation purposes
- name: roles
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the roles resource.
  - name: description
    value: "{{ description }}"
    description: |
      Description
  - name: name
    value: "{{ name }}"
    description: |
      Name

UPDATE examples

update

Updates the role. (Deprecated, will be removed)

UPDATE ovh.dbaas_logs.roles
SET 
description = '{{ description }}',
name = '{{ name }}'
WHERE 
role_id = '{{ role_id }}' --required
AND service_name = '{{ service_name }}' --required
AND description = '{{ description }}' --required
AND name = '{{ name }}' --required
RETURNING
alias_id,
dashboard_id,
encryption_key_id,
index_id,
input_id,
operation_id,
osd_id,
role_id,
stream_id,
subscription_id,
tenant_id,
token_id,
service_name,
created_at,
state,
updated_at;

DELETE examples

delete

Deletes the role. (Deprecated, will be removed)

DELETE FROM ovh.dbaas_logs.roles
WHERE role_id = '{{ role_id }}' --required
AND service_name = '{{ service_name }}' --required
;