Skip to main content

service_licenses

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

Overview​

Nameservice_licenses
TypeResource
Idovh.email_exchange.service_licenses

Fields​

The following fields are returned by SELECT queries:

Exchange account license per day

NameDatatypeDescription
account_licensearray (wire: accountLicense)
datestring (date)
outlook_quantityinteger (wire: outlookQuantity)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectexchange_service, organization_namefrom_date, license, to_dateList active licenses. Returns, for each day, the number of active accounts per license and the number of Outlook licenses. Filter by fromDate, toDate or license.

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.

NameDatatypeDescription
api_hoststringThe 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"}})
exchange_servicestringThe internal name of your exchange service (wire: exchangeService)
organization_namestringThe internal name of your exchange organization (wire: organizationName)
from_datestring (date)Get active licenses since date (wire: fromDate)
licensestringLicense type
to_datestring (date)Get active licenses until date (wire: toDate)

SELECT examples​

List active licenses. Returns, for each day, the number of active accounts per license and the number of Outlook licenses. Filter by fromDate, toDate or license.

SELECT
account_license,
date,
outlook_quantity
FROM ovh.email_exchange.service_licenses
WHERE exchange_service = '{{ exchange_service }}' -- required
AND organization_name = '{{ organization_name }}' -- required
AND from_date = '{{ from_date }}'
AND license = '{{ license }}'
AND to_date = '{{ to_date }}'
;