parent_tenants

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

Overview

Name	parent_tenants
Type	Resource
Id	ovh.license_office_prepaid.parent_tenants

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
display_name	string	Tenant's display name (wire: displayName)
first_name	string	Contact's first name (wire: firstName)
last_name	string	Contact's last name (wire: lastName)
service_name	string	Tenant's service name (wire: serviceName)
address	string	Contact's address line
city	string	Contact's city
creation_date	string (date-time)	Creation date (wire: creationDate)
mca_agreed	boolean	MCA acceptance status (wire: mcaAgreed)
phone	string (phone-number)	Primary phone number
service_type	string	Tenant's service type (payAsYouGo, prepaid) (wire: serviceType)
status	string	Tenant's status (creating, inMaintenance, ok, reopening, suspended, suspending)
zip_code	string	Contact's zip code (wire: zipCode)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_name		Returns the tenant of the prepaid user: display name, contact details, service type, status, and whether the Microsoft Customer Agreement (MCA) is accepted. (Alpha version)
update	update	service_name		Updates the display name of the tenant of the prepaid user. (Alpha version)
accept_agreement	exec	serviceName		Accepts the Microsoft Customer Agreement (MCA) for the parent tenant. (Alpha version)
create_attestation	exec	serviceName		Creates a Microsoft Customer Agreement attestation for the parent tenant from the signatory company, names, email address, phone number, country and language. Returns the attestation ID and a link to the attestation that can be embedded in an iframe. (Alpha version)

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	Service name
service_name	string	Service name (wire: serviceName)

SELECT examples

get

Returns the tenant of the prepaid user: display name, contact details, service type, status, and whether the Microsoft Customer Agreement (MCA) is accepted. (Alpha version)

SELECT
display_name,
first_name,
last_name,
service_name,
address,
city,
creation_date,
mca_agreed,
phone,
service_type,
status,
zip_code
FROM ovh.license_office_prepaid.parent_tenants
WHERE service_name = '{{ service_name }}' -- required
;

UPDATE examples

update

Updates the display name of the tenant of the prepaid user. (Alpha version)

UPDATE ovh.license_office_prepaid.parent_tenants
SET 
display_name = '{{ display_name }}'
WHERE 
service_name = '{{ service_name }}' --required;

Lifecycle Methods

EXEC variables use wire (API) names.

accept_agreement

Accepts the Microsoft Customer Agreement (MCA) for the parent tenant. (Alpha version)

EXEC ovh.license_office_prepaid.parent_tenants.accept_agreement 
@serviceName='{{ serviceName }}' --required
;

create_attestation

Creates a Microsoft Customer Agreement attestation for the parent tenant from the signatory company, names, email address, phone number, country and language. Returns the attestation ID and a link to the attestation that can be embedded in an iframe. (Alpha version)

EXEC ovh.license_office_prepaid.parent_tenants.create_attestation 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"companyName": "{{ companyName }}", 
"country": "{{ country }}", 
"emailAddress": "{{ emailAddress }}", 
"language": "{{ language }}", 
"phoneNumber": "{{ phoneNumber }}", 
"signatoryFirstName": "{{ signatoryFirstName }}", 
"signatoryLastName": "{{ signatoryLastName }}"
}'
;