service_custom_isolations

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

Overview

Name	service_custom_isolations
Type	Resource
Id	ovh.email_exchange.service_custom_isolations

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
name	string	Name of the custom isolation
creation_date	string (date-time)	Creation date (wire: creationDate)
isolation_field	string	Field used for isolation (company, country) (wire: isolationField)
isolation_value	string	Isolation field value (wire: isolationValue)
status	string	Custom isolation status (creating, deleting, internalMigration, ok, reopening, suspended, suspending)

list

custom exchange isolation

Name	Datatype	Description
name	string	Name of the custom isolation
creation_date	string (date-time)	Creation date (wire: creationDate)
isolation_field	string	Field used for isolation (company, country) (wire: isolationField)
isolation_value	string	Isolation field value (wire: isolationValue)
status	string	Custom isolation status (creating, deleting, internalMigration, ok, reopening, suspended, suspending)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	exchange_service, name, organization_name		Get a custom isolation. Returns the name of the custom isolation, the field and value it isolates on, its status and creation date.
list	select	exchange_service, organization_name	isolation_field, isolation_value, name, x_pagination_mode	List custom isolations. Returns the names of the custom isolations. Filter them by name, isolationField or isolationValue.
create	insert	exchange_service, organization_name, isolation_field, isolation_value, name		Create a custom isolation. Creates a custom isolation from a name, an isolationField (company or country) and an isolationValue, and returns the task.
delete	delete	exchange_service, name, organization_name		Delete a custom isolation. Removes the custom isolation from the Exchange service, so that its field no longer isolates users, and returns the task.

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)
name	string	Name of the custom isolation
organization_name	string	The internal name of your exchange organization (wire: organizationName)
isolation_field	string	Filter the value of isolationField property (=) (wire: isolationField)
isolation_value	string	Filter the value of isolationValue property (like) (wire: isolationValue)
name	string	Filter the value of name property (like)
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Get a custom isolation. Returns the name of the custom isolation, the field and value it isolates on, its status and creation date.

SELECT
name,
creation_date,
isolation_field,
isolation_value,
status
FROM ovh.email_exchange.service_custom_isolations
WHERE exchange_service = '{{ exchange_service }}' -- required
AND name = '{{ name }}' -- required
AND organization_name = '{{ organization_name }}' -- required
;

list

List custom isolations. Returns the names of the custom isolations. Filter them by name, isolationField or isolationValue.

SELECT
name,
creation_date,
isolation_field,
isolation_value,
status
FROM ovh.email_exchange.service_custom_isolations
WHERE exchange_service = '{{ exchange_service }}' -- required
AND organization_name = '{{ organization_name }}' -- required
AND isolation_field = '{{ isolation_field }}'
AND isolation_value = '{{ isolation_value }}'
AND name = '{{ name }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create a custom isolation. Creates a custom isolation from a name, an isolationField (company or country) and an isolationValue, and returns the task.

INSERT INTO ovh.email_exchange.service_custom_isolations (
isolation_field,
isolation_value,
name,
exchange_service,
organization_name
)
SELECT 
'{{ isolation_field }}' /* required */,
'{{ isolation_value }}' /* required */,
'{{ name }}' /* required */,
'{{ exchange_service }}',
'{{ organization_name }}'
RETURNING
id,
finish_date,
function,
status,
todo_date
;

Manifest

# Description fields are for documentation purposes
- name: service_custom_isolations
props:
  - name: exchange_service
    value: "{{ exchange_service }}"
    description: Required parameter for the service_custom_isolations resource.
  - name: organization_name
    value: "{{ organization_name }}"
    description: Required parameter for the service_custom_isolations resource.
  - name: isolation_field
    value: "{{ isolation_field }}"
    description: |
      custom exchange isolation field
    valid_values: ['company', 'country']
  - name: isolation_value
    value: "{{ isolation_value }}"
    description: |
      value used for isolation
  - name: name
    value: "{{ name }}"
    description: |
      display name of isolation

DELETE examples

delete

Delete a custom isolation. Removes the custom isolation from the Exchange service, so that its field no longer isolates users, and returns the task.

DELETE FROM ovh.email_exchange.service_custom_isolations
WHERE exchange_service = '{{ exchange_service }}' --required
AND name = '{{ name }}' --required
AND organization_name = '{{ organization_name }}' --required
;