orderable_licenses
Creates, updates, deletes, gets or lists an orderable_licenses resource.
Overview​
| Name | orderable_licenses |
| Type | Resource |
| Id | ovh.saas_csp2.orderable_licenses |
Fields​
The following fields are returned by SELECT queries:
- get
- list
successful operation
| Name | Datatype | Description |
|---|---|---|
id | integer | License unique identifier |
name | string | License name |
licence_type | string | License's type, indicates if the licence is standalone or an addon (ADDON, NON-SPECIFIC) (wire: licenceType) |
limit | integer | Maximum purchasable license |
new_seats_allowed | boolean | Whether or not it is possible to add new seats on subscriptions of this licence type (wire: newSeatsAllowed) |
new_subscriptions_allowed | boolean | Whether or not this licence type is allowed for new subscriptions (wire: newSubscriptionsAllowed) |
Office licence
| Name | Datatype | Description |
|---|---|---|
id | integer | License unique identifier |
name | string | License name |
licence_type | string | License's type, indicates if the licence is standalone or an addon (ADDON, NON-SPECIFIC) (wire: licenceType) |
limit | integer | Maximum purchasable license |
new_seats_allowed | boolean | Whether or not it is possible to add new seats on subscriptions of this licence type (wire: newSeatsAllowed) |
new_subscriptions_allowed | boolean | Whether or not this licence type is allowed for new subscriptions (wire: newSubscriptionsAllowed) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | id, service_name | Returns the name and type of the license, standalone or add-on, the maximum quantity that can be purchased, and whether it allows new subscriptions and new seats. (Alpha version) | |
list | select | service_name | x_pagination_mode | Returns the IDs of the licenses that can be ordered for the tenant. (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"}}) |
id | integer | Id |
service_name | string | Service name (wire: serviceName) |
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
- list
Returns the name and type of the license, standalone or add-on, the maximum quantity that can be purchased, and whether it allows new subscriptions and new seats. (Alpha version)
SELECT
id,
name,
licence_type,
limit,
new_seats_allowed,
new_subscriptions_allowed
FROM ovh.saas_csp2.orderable_licenses
WHERE id = '{{ id }}' -- required
AND service_name = '{{ service_name }}' -- required
;
Returns the IDs of the licenses that can be ordered for the tenant. (Alpha version)
SELECT
id,
name,
licence_type,
limit,
new_seats_allowed,
new_subscriptions_allowed
FROM ovh.saas_csp2.orderable_licenses
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;