reference_private_endpoint_service_availabilities

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

Overview

Name	reference_private_endpoint_service_availabilities
Type	Resource
Id	ovh.public_cloud.reference_private_endpoint_service_availabilities

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
name	string	Service name
description	string	Service description
tiers	array	Enabled tiers of the service

list

Service availability (read-only reference data). Describes where an OVHcloud-operated service can be reached through a private endpoint. The endpoint returns one entry per service, each carrying the tiers it offers with their region, port and transport. This is read-only reference data. It does not reflect existing resources and triggers no OpenStack call.

Name	Datatype	Description
name	string	Service name
description	string	Service description
tiers	array	Enabled tiers of the service

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	name, project_id		Returns where one service can be reached through a private endpoint: region, port and transport of each tier. (Beta version)
list	select	project_id	x_pagination_cursor, x_pagination_size, region	Returns the services that can be reached through a private endpoint, with their tiers. Filter by region to restrict services and their tiers to it. (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.

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"}})
name	string	Name
project_id	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
region	string	Optional region filter. When set, only services offering a tier in this region are returned and each service's tiers are restricted to that region. When omitted, services are listed with their tiers across all regions. An unknown region is rejected.
x_pagination_cursor	string	Pagination cursor (wire: X-Pagination-Cursor)
x_pagination_size	integer	Pagination size (wire: X-Pagination-Size)

SELECT examples

get

Returns where one service can be reached through a private endpoint: region, port and transport of each tier. (Beta version)

SELECT
name,
description,
tiers
FROM ovh.public_cloud.reference_private_endpoint_service_availabilities
WHERE name = '{{ name }}' -- required
AND project_id = '{{ project_id }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

list

Returns the services that can be reached through a private endpoint, with their tiers. Filter by region to restrict services and their tiers to it. (Beta version)

SELECT
name,
description,
tiers
FROM ovh.public_cloud.reference_private_endpoint_service_availabilities
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 }}'
AND region = '{{ region }}'
;