Skip to main content

reference_managed_kubernetes_regions

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

Overview​

Namereference_managed_kubernetes_regions
TypeResource
Idovh.public_cloud.reference_managed_kubernetes_regions

Fields​

The following fields are returned by SELECT queries:

A region where managed Kubernetes clusters can be created, with its availability zones and the plans offered there

NameDatatypeDescription
namestringRegion identifier, for example EU-WEST-PAR
availability_zonesarrayAvailability zones in the region. Empty for a single-zone (mono-AZ) region. (wire: availabilityZones)
available_plansarrayPlans that can be selected when creating a cluster in this region (wire: availablePlans)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectproject_idx_pagination_cursor, x_pagination_sizeReturns the regions where a cluster can be created, with their availability zones and the plans offered there. (Beta 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.

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"}})
project_idstringThe Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
x_pagination_cursorstringPagination cursor (wire: X-Pagination-Cursor)
x_pagination_sizeintegerPagination size (wire: X-Pagination-Size)

SELECT examples​

Returns the regions where a cluster can be created, with their availability zones and the plans offered there. (Beta version)

SELECT
name,
availability_zones,
available_plans
FROM ovh.public_cloud.reference_managed_kubernetes_regions
WHERE project_id = '{{ project_id }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
AND x_pagination_cursor = '{{ x_pagination_cursor }}'
AND x_pagination_size = '{{ x_pagination_size }}'
;