vendors

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

Overview

Name	vendors
Type	Resource
Id	ovh.dedicated_cloud.vendors

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
vendor_name	string	name (wire: vendorName)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_name		Get the vendor
object_type	exec	serviceName		List vendor object types
ovh_id	exec	serviceName, objectType, vendorId		Get the API IDs of an object. Returns the OVHcloud API IDs that match a vendor object ID: cluster, datacenter, datastore, host or virtual machine.

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"}})
serviceName	string	Domain of the service
service_name	string	Domain of the service (wire: serviceName)

SELECT examples

get

Get the vendor

SELECT
vendor_name
FROM ovh.dedicated_cloud.vendors
WHERE service_name = '{{ service_name }}' -- required
;

Lifecycle Methods

EXEC variables use wire (API) names.

object_type

List vendor object types

EXEC ovh.dedicated_cloud.vendors.object_type 
@serviceName='{{ serviceName }}' --required
;

ovh_id

Get the API IDs of an object. Returns the OVHcloud API IDs that match a vendor object ID: cluster, datacenter, datastore, host or virtual machine.

EXEC ovh.dedicated_cloud.vendors.ovh_id 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"objectType": "{{ objectType }}", 
"vendorId": "{{ vendorId }}"
}'
;