service_licenses
Creates, updates, deletes, gets or lists a service_licenses resource.
Overview​
| Name | service_licenses |
| Type | Resource |
| Id | ovh.email_exchange.service_licenses |
Fields​
The following fields are returned by SELECT queries:
- list
Exchange account license per day
| Name | Datatype | Description |
|---|---|---|
account_license | array | (wire: accountLicense) |
date | string (date) | |
outlook_quantity | integer | (wire: outlookQuantity) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | exchange_service, organization_name | from_date, license, to_date | 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. |
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"}}) |
exchange_service | string | The internal name of your exchange service (wire: exchangeService) |
organization_name | string | The internal name of your exchange organization (wire: organizationName) |
from_date | string (date) | Get active licenses since date (wire: fromDate) |
license | string | License type |
to_date | string (date) | Get active licenses until date (wire: toDate) |
SELECT examples​
- list
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 }}'
;