service_account_outlook_urls

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

Overview

Name	service_account_outlook_urls
Type	Resource
Id	ovh.email_exchange.service_account_outlook_urls

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
expiration	string (date-time)	Url expiration date
serial	string	Serial number
url	string	Outlook url

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	exchange_service, organization_name, primary_email_address		Get the Outlook download URL. Returns the temporary Outlook download URL, its expiration date and the license serial number.
create	insert	exchange_service, organization_name, primary_email_address, language, version		Generate an Outlook download URL. Generates a temporary Outlook download URL for the given version and language, and returns the task. The email account needs an Outlook license.

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"}})
exchange_service	string	The internal name of your exchange service (wire: exchangeService)
organization_name	string	The internal name of your exchange organization (wire: organizationName)
primary_email_address	string	Default email for this mailbox (wire: primaryEmailAddress)

SELECT examples

get

Get the Outlook download URL. Returns the temporary Outlook download URL, its expiration date and the license serial number.

SELECT
expiration,
serial,
url
FROM ovh.email_exchange.service_account_outlook_urls
WHERE exchange_service = '{{ exchange_service }}' -- required
AND organization_name = '{{ organization_name }}' -- required
AND primary_email_address = '{{ primary_email_address }}' -- required
;

INSERT examples

create

Generate an Outlook download URL. Generates a temporary Outlook download URL for the given version and language, and returns the task. The email account needs an Outlook license.

INSERT INTO ovh.email_exchange.service_account_outlook_urls (
language,
version,
exchange_service,
organization_name,
primary_email_address
)
SELECT 
'{{ language }}' /* required */,
'{{ version }}' /* required */,
'{{ exchange_service }}',
'{{ organization_name }}',
'{{ primary_email_address }}'
RETURNING
id,
finish_date,
function,
status,
todo_date
;

Manifest

# Description fields are for documentation purposes
- name: service_account_outlook_urls
props:
  - name: exchange_service
    value: "{{ exchange_service }}"
    description: Required parameter for the service_account_outlook_urls resource.
  - name: organization_name
    value: "{{ organization_name }}"
    description: Required parameter for the service_account_outlook_urls resource.
  - name: primary_email_address
    value: "{{ primary_email_address }}"
    description: Required parameter for the service_account_outlook_urls resource.
  - name: language
    value: "{{ language }}"
    description: |
      Language of outlook
    valid_values: ['ar', 'bg', 'cz', 'da', 'de', 'el', 'en', 'es', 'et', 'fi', 'fr', 'he', 'hr', 'hu', 'id', 'in', 'it', 'ja', 'ko', 'kz', 'lt', 'lv', 'ms', 'nb', 'nl', 'pl', 'pt', 'pt-BR', 'ro', 'rs', 'ru', 'sk', 'sl', 'sv', 'th', 'tr', 'uk', 'vi', 'zh-CN']
  - name: version
    value: "{{ version }}"
    description: |
      Version of outlook
    valid_values: ['mac_x86_2016', 'mac_x86_2019', 'mac_x86_2021', 'windows_x64_2016', 'windows_x64_2019', 'windows_x64_2021', 'windows_x86_2016', 'windows_x86_2019', 'windows_x86_2021']