upn_suffixes

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

Overview

Name	upn_suffixes
Type	Resource
Id	ovh.ms_services.upn_suffixes

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
task_pending_id	integer	Pending task for this upnSuffix (wire: taskPendingId)
cname_to_check	string	Cname record used for UPN suffix verification (wire: cnameToCheck)
ownership_validated	boolean	Ownership for upn suffix confirmed (wire: ownershipValidated)
state	string	UPN suffix state (creating, deleting, ok)
suffix	string	UPN suffix

list

Active Directory UPN Suffix

Name	Datatype	Description
task_pending_id	integer	Pending task for this upnSuffix (wire: taskPendingId)
cname_to_check	string	Cname record used for UPN suffix verification (wire: cnameToCheck)
ownership_validated	boolean	Ownership for upn suffix confirmed (wire: ownershipValidated)
state	string	UPN suffix state (creating, deleting, ok)
suffix	string	UPN suffix

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_name, suffix		Get a UPN suffix. Returns the state of the UPN suffix, the CNAME record used to verify it and whether its ownership is validated.
list	select	service_name	x_pagination_mode	List UPN suffixes. Returns the UPN suffixes of the Active Directory service. Get one to read its state and the CNAME to check.
create	insert	service_name, suffix		Create a UPN suffix. Adds a UPN suffix to the Active Directory service and returns the task. Its ownership is verified with the CNAME record given in cnameToCheck.
delete	delete	service_name, suffix		Delete a UPN suffix. Removes the UPN suffix from the Active Directory service, so that user names can no longer use it, and returns the task.

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"}})
service_name	string	The internal name of your Active Directory organization (wire: serviceName)
suffix	string	UPN suffix
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 a UPN suffix. Returns the state of the UPN suffix, the CNAME record used to verify it and whether its ownership is validated.

SELECT
task_pending_id,
cname_to_check,
ownership_validated,
state,
suffix
FROM ovh.ms_services.upn_suffixes
WHERE service_name = '{{ service_name }}' -- required
AND suffix = '{{ suffix }}' -- required
;

list

List UPN suffixes. Returns the UPN suffixes of the Active Directory service. Get one to read its state and the CNAME to check.

SELECT
task_pending_id,
cname_to_check,
ownership_validated,
state,
suffix
FROM ovh.ms_services.upn_suffixes
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create a UPN suffix. Adds a UPN suffix to the Active Directory service and returns the task. Its ownership is verified with the CNAME record given in cnameToCheck.

INSERT INTO ovh.ms_services.upn_suffixes (
suffix,
service_name
)
SELECT 
'{{ suffix }}' /* required */,
'{{ service_name }}'
RETURNING
id,
finish_date,
function,
status,
todo_date
;

Manifest

# Description fields are for documentation purposes
- name: upn_suffixes
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the upn_suffixes resource.
  - name: suffix
    value: "{{ suffix }}"
    description: |
      UPN suffix to create

DELETE examples

delete

Delete a UPN suffix. Removes the UPN suffix from the Active Directory service, so that user names can no longer use it, and returns the task.

DELETE FROM ovh.ms_services.upn_suffixes
WHERE service_name = '{{ service_name }}' --required
AND suffix = '{{ suffix }}' --required
;