cart_service_option_microsoft_exchanges

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

Overview

Name	cart_service_option_microsoft_exchanges
Type	Resource
Id	ovh.order.cart_service_option_microsoft_exchanges

Fields

The following fields are returned by SELECT queries:

list_by_service_name

Representation of a generic product option

Name	Datatype	Description
product_name	string	Name of the product (wire: productName)
exclusive	boolean	Define if options of this family are exclusive with each other
family	string	Option family
mandatory	boolean	Define if an option of this family is mandatory
plan_code	string	Product offer identifier (wire: planCode)
prices	array	Prices of the product offer
product_type	string	Product type (cloud_service, delivery, deposit, domain, implementation_services, saas_license, shipping, storage) (wire: productType)

list

Name	Datatype	Description
value	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_service_name	select	service_name		Get informations about additional Microsoft offer for your service (Beta version)
list	select			List available services (Beta version)
create	insert	service_name, cart_id, duration, plan_code, pricing_mode, quantity		Post an additional Microsoft option in your cart (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"}})
service_name	string	The internal ID of Microsoft Exchange service (wire: serviceName)

SELECT examples

list_by_service_name

Get informations about additional Microsoft offer for your service (Beta version)

SELECT
product_name,
exclusive,
family,
mandatory,
plan_code,
prices,
product_type
FROM ovh.order.cart_service_option_microsoft_exchanges
WHERE service_name = '{{ service_name }}' -- required
;

list

List available services (Beta version)

SELECT
value
FROM ovh.order.cart_service_option_microsoft_exchanges
;

INSERT examples

create

Post an additional Microsoft option in your cart (Beta version)

INSERT INTO ovh.order.cart_service_option_microsoft_exchanges (
cart_id,
duration,
plan_code,
pricing_mode,
quantity,
service_name
)
SELECT 
'{{ cart_id }}' /* required */,
'{{ duration }}' /* required */,
'{{ plan_code }}' /* required */,
'{{ pricing_mode }}' /* required */,
{{ quantity }} /* required */,
'{{ service_name }}'
RETURNING
cart_id,
item_id,
offer_id,
parent_item_id,
product_id,
configurations,
duration,
options,
prices,
settings
;

Manifest

# Description fields are for documentation purposes
- name: cart_service_option_microsoft_exchanges
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the cart_service_option_microsoft_exchanges resource.
  - name: cart_id
    value: "{{ cart_id }}"
    description: |
      Cart identifier
  - name: duration
    value: "{{ duration }}"
    description: |
      Duration selected for the purchase of the product
  - name: plan_code
    value: "{{ plan_code }}"
    description: |
      Identifier of the additional Microsoft offer
  - name: pricing_mode
    value: "{{ pricing_mode }}"
    description: |
      Pricing mode selected for the purchase of the product
  - name: quantity
    value: {{ quantity }}
    description: |
      Quantity of product desired